Get started with Crashlytics for Unity

This guide describes how to get started with Firebase Crashlytics in your Unity project.

After you've set up the Firebase Crashlytics SDK in your app, you can get comprehensive crash reports in the Firebase console.

Setting up Crashlytics requires tasks both in the Firebase console and your IDE (like adding a Firebase configuration file and the Crashlytics SDK). To finish setup, you'll need to force a test crash to send your first crash report to Firebase.

Before you begin

1. If you haven't already, add Firebase to your Unity project. If you don't have a Unity project, you can download a sample app .

2. Recommended: To automatically get breadcrumb logs to understand user actions leading up to a crash, non-fatal, or ANR event, you need to enable Google Analytics in your Firebase project.

   • If your existing Firebase project doesn't have Google Analytics enabled, you can enable Google Analytics from the Integrations tab of your settings > Project settings in the Firebase console.

   • If you're creating a new Firebase project, enable Google Analytics during the project creation workflow.

Step 1: Add the Crashlytics SDK to your app

Note that when you registered your Unity project with your Firebase project, you might have already downloaded the Firebase Unity SDK and added the packages described in the following steps.

1. Download the Firebase Unity SDK , then unzip the SDK somewhere convenient. The Firebase Unity SDK is not platform-specific.

2. In your open Unity project, navigate to Assets> Import Package> Custom Package.

3. From the unzipped SDK, select to import the Crashlytics SDK ( FirebaseCrashlytics.unitypackage ).

   To take advantage of breadcrumb logs also add the Firebase SDK for Google Analytics to your app ( FirebaseAnalytics.unitypackage ). Make sure that Google Analytics is enabled in your Firebase project.

4. In the Import Unity Package window, click Import.

Step 2: Initialize Crashlytics

1. Create a new C# script, then add it to a GameObject in the scene.

   1. Open your first scene, then create an empty GameObject named CrashlyticsInitializer .

   2. Click Add Componentin the Inspectorfor the new object.

   3. Select your Crashlytics Init script to add it to the CrashlyticsInitializer object.

2. Initialize Crashlytics in the script's Start method:

    using 
     
    System.Collections 
    ; 
    using 
     
    System.Collections.Generic 
    ; 
    using 
     
    UnityEngine 
    ; 
     // Import Firebase and Crashlytics 
    using 
     
    Firebase 
    ; 
    using 
     
    Firebase.Crashlytics 
    ; 
    public 
     
    class 
     
    CrashlyticsInit 
     
    : 
     
    MonoBehaviour 
     
    { 
     
    // Use this for initialization 
     
    void 
     
    Start 
     
    () 
     
    { 
     
     // Initialize Firebase 
     
    Firebase 
    . 
    FirebaseApp 
    . 
    CheckAndFixDependenciesAsync 
    (). 
    ContinueWith 
    ( 
    task 
     
    => 
     
    { 
     
    var 
     
    dependencyStatus 
     
    = 
     
    task 
    . 
    Result 
    ; 
     
    if 
     
    ( 
    dependencyStatus 
     
    == 
     
    Firebase 
    . 
    DependencyStatus 
    . 
    Available 
    ) 
     
    { 
     
    // Create and hold a reference to your FirebaseApp, 
     
    // where app is a Firebase.FirebaseApp property of your application class. 
     
    // Crashlytics 
   will use the DefaultInstance, as well; 
     
    // this ensures that Crashlytics 
   is initialized. 
     
    Firebase 
    . 
    FirebaseApp 
     
    app 
     
    = 
     
    Firebase 
    . 
    FirebaseApp 
    . 
    DefaultInstance 
    ; 
     
    // When this property is set to true, Crashlytics will report all 
     
    // uncaught exceptions as fatal events. This is the recommended behavior. 
     
    Crashlytics 
    . 
    ReportUncaughtExceptionsAsFatal 
     
    = 
     
    true 
    ; 
     
    // Set a flag here for indicating that your project is ready to use Firebase. 
     
    } 
     
    else 
     
    { 
     
    UnityEngine 
    . 
    Debug 
    . 
    LogError 
    ( 
    System 
    . 
    String 
    . 
    Format 
    ( 
     
    "Could not resolve all Firebase dependencies: {0}" 
    , 
    dependencyStatus 
    )); 
     
    // Firebase 
    Unity 
   SDK is not safe to use here. 
     
    } 
     
    }); 
     
    } 
     
    // Update is called once per frame 
     
    void 
     
    Update 
    () 
     
    // ... 
    } 
   

Step 3: (Android only) Get set up for symbol uploading

This step is only required for Android apps that use IL2CPP.

• For Android apps that use Unity’s Mono scripting backend, these steps aren't needed.

• For Apple platform apps, these steps aren't needed because the Firebase Unity Editor plugin automatically configures your Xcode project to upload symbols.

Crashlytics ’s Unity SDK 8.6.1+ automatically includes NDK crash reporting, which allows Crashlytics to automatically report Unity IL2CPP crashes on Android. However, to see symbolicated stack traces for native library crashes in the Crashlytics dashboard, you must upload symbol information at build time using the Firebase CLI.

To get set up for symbol uploading, follow the instructions to install the Firebase CLI .

If you've already installed the CLI, make sure to update to its latest version .

Step 4: Build your project and upload symbols

iOS+(Apple platform)

1. From the Build Settings dialog, export your project to an Xcode workspace.

2. Build your app.

   For Apple platforms, the Firebase Unity Editor plugin automatically configures your Xcode project to generate and upload a Crashlytics -compatible symbol file to Firebase servers for each build.

Android

1. From the Build Settings dialog, do one of the following:

   • Export to an Android Studio project to build your project; or

   • Build your APK directly from the Unity Editor.
     Before building, make sure the checkbox for Create symbols.zipis checked in the Build Settings dialog.

2. Once your build has finished, generate a Crashlytics -compatible symbol file and upload it to Firebase servers by running the following Firebase CLI command:

   firebase crashlytics:symbols:upload --app= FIREBASE_APP_ID 
    PATH/TO/SYMBOLS 
   

   • FIREBASE_APP_ID : Your Firebase Android App ID (not your package name)
     Example Firebase Android App ID: 1:567383003300:android:17104a2ced0c9b9b

     Need to find your Firebase App ID?

     Here are two ways to find your Firebase App ID:

     • In your google-services.json file, your App ID is the mobilesdk_app_id value; or

     • In the Firebase console, go to your Project settings . Scroll down to the Your apps card, then click on the desired Firebase App to find its App ID.