Premiers pas avec Firebase Crashlytics


Ce guide de démarrage rapide explique comment configurer Firebase Crashlytics dans votre application avec le SDK Firebase Crashlytics afin de pouvoir obtenir des rapports d'erreur complets dans la console Firebase.

La configuration de Crashlytics nécessite des tâches à la fois dans la console Firebase et dans votre IDE (comme ajouter un fichier de configuration Firebase et le SDK Crashlytics). Pour terminer la configuration, vous devez forcer un plantage de test afin d'envoyer votre premier rapport de plantage à Firebase.

Avant de commencer

  1. Si ce n'est pas déjà fait, ajoutez Firebase à votre projet Unity. Si vous n'avez pas de projet Unity, vous pouvez télécharger un exemple d'application.

  2. Recommandé : Pour obtenir automatiquement des journaux de repères afin de comprendre les actions des utilisateurs ayant conduit à un plantage, un problème non fatal ou un événement ANR, vous devez activer Google Analytics dans votre projet Firebase.

    • Si Google Analytics n'est pas activé dans votre projet Firebase existant, vous pouvez l'activer dans l'onglet Integrations (Intégrations) de  > Project settings (Paramètres du projet) dans la console Firebase.

    • Si vous créez un projet Firebase, activez Google Analytics au cours du workflow de création du projet.

Étape 1 : Ajouter le SDK Crashlytics à votre application

Notez que lorsque vous avez enregistré votre projet Unity avec votre projet Firebase, vous avez peut-être déjà téléchargé le SDK Unity Firebase et ajouté les packages décrits dans les étapes suivantes.

  1. Téléchargez le SDK Unity Firebase, puis décompressez-le dans un emplacement pratique. Le SDK Unity Firebase n'est pas spécifique à une plate-forme.

  2. Dans votre projet Unity ouvert, accédez à Assets (Éléments) > Import Package (Importer un package) > Custom Package (Package personnalisé).

  3. Dans le SDK décompressé, sélectionnez le SDK Crashlytics (FirebaseCrashlytics.unitypackage) pour l'importer.

    Pour profiter des journaux de fil d'Ariane, ajoutez également le SDK Firebase pour Google Analytics à votre application (FirebaseAnalytics.unitypackage). Assurez-vous que Google Analytics est activé dans votre projet Firebase.

  4. Dans la fenêtre Import Unity Package (Importer un package Unity) qui s'ouvre, cliquez sur Import (Importer).

Étape 2 : Initialiser Crashlytics

  1. Créez un script C#, puis ajoutez-le à un GameObject dans la scène.

    1. Ouvrez votre première scène, puis créez un GameObject vide nommé CrashlyticsInitializer.

    2. Cliquez sur Add Component (Ajouter un composant) dans l'Inspector (Inspecteur) pour le nouvel objet.

    3. Sélectionnez votre script CrashlyticsInit pour l'ajouter à l'objet CrashlyticsInitializer.

  2. Initialisez Crashlytics dans la méthode Start du script:

    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()
    // ...
}

Étape 3 : (Android uniquement) Configurer l'importation de symboles

Cette étape n'est requise que pour les applications Android qui utilisent IL2CPP.

  • Pour les applications Android qui utilisent le backend de script Mono d'Unity, ces étapes ne sont pas nécessaires.

  • Pour les applications de plate-forme Apple, ces étapes ne sont pas nécessaires, car le plug-in de l'éditeur Unity Firebase configure automatiquement votre projet Xcode pour importer des symboles.

Le SDK Unity 8.6.1 ou version ultérieure de Crashlytics inclut automatiquement les rapports d'erreur du NDK, ce qui permet à Crashlytics de signaler automatiquement les plantages d'Unity IL2CPP sur Android. Toutefois, pour afficher les traces de pile symbolisées des plantages de bibliothèques natives dans le tableau de bord Crashlytics, vous devez importer des informations sur les symboles au moment de la compilation à l'aide de la CLI Firebase.

Pour configurer l'importation de symboles, suivez les instructions pour installer la CLI Firebase.

Si vous avez déjà installé la CLI, veillez à passer à la dernière version.

Étape 4: Créez votre projet et importez des symboles

iOS+ (plate-forme Apple)

  1. Dans la boîte de dialogue Build Settings (Paramètres de compilation), exportez votre projet vers un espace de travail Xcode.

  2. Créez votre application.

    Pour les plates-formes Apple, le plug-in Firebase Unity Editor configure automatiquement votre projet Xcode pour générer et importer un fichier de symboles compatible avec Crashlytics sur les serveurs Firebase pour chaque compilation.

Android

  1. Dans la boîte de dialogue Build Settings (Paramètres de compilation), effectuez l'une des opérations suivantes:

    • Exporter vers un projet Android Studio pour compiler votre projet ; ou

    • Créez votre APK directement depuis l'éditeur Unity.
      Avant la compilation, assurez-vous que la case Create symbols.zip (Créer symbols.zip) est cochée dans la boîte de dialogue Build Settings (Paramètres de compilation).

  2. Une fois la compilation terminée, générez un fichier de symboles compatible avec Crashlytics et importez-le sur les serveurs Firebase en exécutant la commande CLI Firebase suivante :

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

    • FIREBASE_APP_ID : votre ID d'application Android Firebase (et non votre nom de package)
      Exemple d'ID d'application Android Firebase : 1:567383003300:android:17104a2ced0c9b9b

    • PATH/TO/SYMBOLS: chemin d'accès au fichier de symboles généré par la CLI

      • Exporté vers un projet Android Studio : PATH/TO/SYMBOLS correspond au répertoire unityLibrary/symbols, qui est créé dans la racine du projet exporté après avoir compilé l'application via Gradle ou Android Studio.

      • Vous avez créé l'APK directement depuis Unity. PATH/TO/SYMBOLS est le chemin d'accès du fichier de symboles compressé généré dans le répertoire racine du projet une fois la compilation terminée (par exemple : myproject/myapp-1.0-v100.symbols.zip).

    Afficher les options avancées pour utiliser la commande CLI Firebase pour générer et importer des fichiers de symboles

    Option Description
    --generator=csym

    Utilise l'ancien générateur de fichiers de symboles cSYM au lieu du générateur Breakpad par défaut

    Utilisation déconseillée Nous vous recommandons d'utiliser le générateur de fichiers de symboles Breakpad par défaut.

    --generator=breakpad

    Utilise le générateur de fichiers de symboles Breakpad

    Notez que la génération de fichiers de symboles par défaut est Breakpad. N'utilisez cet indicateur que si vous avez ajouté symbolGenerator { csym() } dans votre configuration de compilation et que vous souhaitez le remplacer pour utiliser Breakpad à la place.

    --dry-run

    Génère les fichiers de symboles, mais ne les importe pas

    Cet indicateur est utile si vous souhaitez inspecter le contenu des fichiers envoyés.

    --debug Fournit des informations de débogage supplémentaires

Étape 5 : Forcer un plantage de test pour terminer la configuration

Pour terminer la configuration de Crashlytics et afficher les données initiales dans le tableau de bord Crashlytics de la console Firebase, vous devez forcer un plantage de test.

  1. Recherchez un GameObject existant, puis ajoutez-y le script suivant. Ce script provoque un plantage de test quelques secondes après l'exécution de votre application.

    using System;
using UnityEngine;

public class CrashlyticsTester : MonoBehaviour {

    int updatesBeforeException;

    // Use this for initialization
    void Start () {
      updatesBeforeException = 0;
    }

    // Update is called once per frame
    void Update()
    {
        // Call the exception-throwing method here so that it's run
        // every frame update
        throwExceptionEvery60Updates();
    }

    // A method that tests your Crashlytics implementation by throwing an
    // exception every 60 frame updates. You should see reports in the
    // Firebase console a few minutes after running your app with this method.
    void throwExceptionEvery60Updates()
    {
        if (updatesBeforeException > 0)
        {
            updatesBeforeException--;
        }
        else
        {
            // Set the counter to 60 updates
            updatesBeforeException = 60;

            // Throw an exception to test your Crashlytics implementation
            throw new System.Exception("test exception please ignore");
        }
    }
}

  2. Créez votre application et importez les informations sur les symboles une fois le build terminé.

    • iOS+: le plug-in Firebase Unity Editor configure automatiquement votre projet Xcode pour importer votre fichier de symboles.

    • Android : pour vos applications Android qui utilisent IL2CPP, exécutez la commande crashlytics:symbols:upload de la CLI Firebase pour importer votre fichier de symboles.

  3. Exécutez votre application. Une fois votre application en cours d'exécution, surveillez le journal de l'appareil et attendez que l'exception se déclenche à partir de CrashlyticsTester.

    • iOS et versions ultérieures : affichez les journaux dans le volet inférieur de Xcode.

    • Android : affichez les journaux en exécutant la commande suivante dans le terminal : adb logcat.

  4. Accédez au tableau de bord Crashlytics de la console Firebase pour voir votre plantage de test.

    Si vous avez actualisé la console et que le plantage du test ne s'affiche toujours pas au bout de cinq minutes, activez la journalisation de débogage pour voir si votre application envoie des rapports de plantage.


C'est tout ! Crashlytics surveille désormais les plantages de votre application. Accédez au tableau de bord Crashlytics pour afficher et examiner tous vos rapports et statistiques.

Étapes suivantes

  • (Recommandé) Pour les applications Android qui utilisent IL2CPP, obtenez de l'aide pour déboguer les plantages causés par des erreurs de mémoire native en collectant des rapports GWP-ASan. Ces erreurs liées à la mémoire peuvent être associées à une corruption de la mémoire dans votre application, qui est la principale cause des failles de sécurité des applications. Pour profiter de cette fonctionnalité de débogage, assurez-vous que votre application utilise la dernière version du SDK Crashlytics pour Unity (version 10.7.0 ou ultérieure) et que GWP-ASan est explicitement activé (vous devez modifier votre fichier manifeste d'application Android).
  • Intégrez Google Play pour pouvoir filtrer les rapports d'erreur de votre application Android par trace Google Play directement dans le tableau de bord Crashlytics. Vous pouvez ainsi mieux cibler votre tableau de bord sur des builds spécifiques.