Personnaliser vos rapports d'erreur Firebase Crashlytics

iOS+ Android Flutter Unity

Dans le tableau de bord Crashlytics, vous pouvez cliquer sur un problème pour obtenir un rapport détaillé sur l'événement. Vous pouvez personnaliser ces rapports pour mieux comprendre ce qui se passe dans votre application et les circonstances entourant les événements signalés à Crashlytics.

• Instrumentez votre application pour enregistrer des clés personnalisées, des messages de journal personnalisés et des identifiants utilisateur.

• Signalez les exceptions à Crashlytics.

• Obtenez automatiquement des journaux de fil d'Ariane si votre application utilise le SDK Firebase pour Google Analytics. Ces journaux vous permettent de voir les actions des utilisateurs qui ont précédé un événement collecté par Crashlytics dans votre application.

• Désactivez la création automatique de rapports d'erreur et activez les rapports nécessitant une confirmation pour vos utilisateurs. Notez que, par défaut, Crashlytics collecte automatiquement les rapports d'erreur pour tous les utilisateurs de votre application.

Ajouter des clés personnalisées

Les clés personnalisées vous permettent de connaître l'état spécifique de votre application pouvant entraîner un plantage. Vous pouvez associer des paires clé-valeur arbitraires à vos rapports d'erreur, puis utiliser les clés personnalisées pour rechercher et filtrer les rapports d'erreur dans la console Firebase.

• Dans le tableau de bord Crashlytics, vous pouvez rechercher des problèmes correspondant à une clé personnalisée.

• Lorsque vous examinez un problème spécifique dans la console, vous pouvez afficher les clés personnalisées associées à chaque événement (sous-onglet Clés) et même filtrer les événements par clés personnalisées (menu Filtrer en haut de la page).

Remarque :Crashlytics accepte un maximum de 64 paires clé/valeur. Une fois ce seuil atteint, aucune valeur supplémentaire n'est enregistrée. Chaque paire clé/valeur peut avoir une taille maximale de 1 ko.

Utilisez la méthode d'instance setCustomKey pour définir des paires clé/valeur. Notez que setCustomKey est surchargé pour que le paramètre value accepte n'importe quel argument primitif ou String. Voici quelques exemples :

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("my_string_key", "foo") // String value
    key("my_bool_key", true) // boolean value
    key("my_double_key", 1.0) // double value
    key("my_float_key", 1.0f) // float value
    key("my_int_key", 1) // int value
}

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("my_string_key", "foo" /* string value */);

crashlytics.setCustomKey("my_bool_key", true /* boolean value */);

crashlytics.setCustomKey("my_double_key", 1.0 /* double value */);

crashlytics.setCustomKey("my_float_key", 1.0f /* float value */);

crashlytics.setCustomKey("my_int_key", 1 /* int value */);

Vous pouvez également modifier la valeur d'une clé existante en l'appelant et en la définissant sur une valeur différente. Exemple :

Kotlin+KTX

val crashlytics = Firebase.crashlytics
crashlytics.setCustomKeys {
    key("current_level", 3)
    key("last_UI_action", "logged_in")
}

Java

FirebaseCrashlytics crashlytics = FirebaseCrashlytics.getInstance();

crashlytics.setCustomKey("current_level", 3);
crashlytics.setCustomKey("last_UI_action", "logged_in");

Ajoutez des paires clé/valeur de manière groupée en transmettant une instance de CustomKeysAndValues à la méthode d'instance setCustomKeys:

Kotlin+KTX

Pour Kotlin, la fonctionnalité existante est plus simple que d'utiliser l'outil de création CustomKeysAndValues.

crashlytics.setCustomKeys {
  key("str_key", "hello")
  key("bool_key", true)
  key("int_key", 1)
  key("long_key", 1L)
  key("float_key", 1.0f)
  key("double_key", 1.0)
}

Java

CustomKeysAndValues keysAndValues = new CustomKeysAndValues.Builder()
.putString("string key", "string value")
.putString("string key 2", "string  value 2")
.putBoolean("boolean key", True)
.putBoolean("boolean key 2", False)
.putFloat("float key", 1.01)
.putFloat("float key 2", 2.02)
.build();

FirebaseCrashlytics.getInstance().setCustomKeys(keysAndValues);

Ajouter des messages de journal personnalisés

Pour obtenir plus de contexte sur les événements qui ont conduit à un plantage, vous pouvez ajouter des journaux Crashlytics personnalisés à votre application. Crashlytics associe les journaux à vos données de plantage et les affiche sur la page Crashlytics de la console Firebase, sous l'onglet Journaux.

Remarque :Pour éviter de ralentir votre application, Crashlytics limite les journaux à 64 ko et supprime les anciennes entrées de journal lorsque les journaux d'une session dépassent cette limite.

Utilisez log pour identifier les problèmes. Exemple :

Kotlin+KTX

Firebase.crashlytics.log("message")

Java

FirebaseCrashlytics.getInstance().log("message");

Définir des identifiants utilisateur

Pour diagnostiquer un problème, il est souvent utile de savoir quel utilisateur a rencontré un plantage donné. Crashlytics permet d'identifier de manière anonyme les utilisateurs dans vos rapports d'erreur.

Pour ajouter des ID utilisateur à vos rapports, attribuez à chaque utilisateur un identifiant unique sous la forme d'un numéro d'ID, d'un jeton ou d'une valeur hachée:

Kotlin+KTX

Firebase.crashlytics.setUserId("user123456789")

Java

FirebaseCrashlytics.getInstance().setUserId("user123456789");

Si vous devez effacer un identifiant utilisateur après l'avoir défini, réinitialisez la valeur sur une chaîne vide. Effacer un ID utilisateur ne supprime pas les enregistrements Crashlytics existants. Si vous devez supprimer des enregistrements associés à un ID utilisateur, contactez l'assistance Firebase.

(Android NDK uniquement) Ajouter des métadonnées aux rapports d'erreur du NDK

Vous pouvez éventuellement inclure l'en-tête crashlytics.h dans votre code C++ pour ajouter des métadonnées aux rapports d'erreur du NDK, telles que des clés personnalisées, des journaux personnalisés et des identifiants utilisateur. Toutes ces options sont décrites sur cette page ci-dessus.

crashlytics.h est disponible en tant que bibliothèque C++ uniquement avec en-tête dans le dépôt GitHub du SDK Android Firebase.

Lisez les commentaires du fichier d'en-tête pour obtenir des instructions sur l'utilisation des API C++ du NDK.

Inclure des rapports GWP-ASan pour déboguer les problèmes de corruption de mémoire

Crashlytics peut vous aider à 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, ce qui est la principale cause des failles de sécurité des applications.

• Vous pouvez afficher ces données dans un nouvel onglet "Traces de pile de mémoire" lorsque vous cliquez sur les détails d'un problème dans le tableau de bord Crashlytics.

• Vous pouvez également utiliser le nouveau signal et le nouveau filtre "Rapport GWP-ASan" pour afficher rapidement tous les problèmes liés à ces données.

Vous pouvez obtenir des rapports de mémoire GWP-ASan si vous activez explicitement GWP-ASan dans votre application et utilisez le SDK Crashlytics pour le NDK 18.3.6 ou version ultérieure (Firebase BoM 31.3.0 ou version ultérieure). Vous pouvez tester votre configuration GWP-ASan à l'aide de l'exemple de code natif dans la documentation Android.

Signaler les exceptions non fatales

En plus de générer automatiquement des rapports sur les plantages de votre application, Crashlytics vous permet d'enregistrer des exceptions non fatales et de vous les envoyer la prochaine fois que votre application sera lancée.

Remarque :Crashlytics ne stocke que les huit dernières exceptions enregistrées. Si votre application génère plus de huit exceptions, les exceptions plus anciennes sont perdues.

Utilisez la méthode recordException pour enregistrer les exceptions non fatales dans les blocs catch de votre application. Exemple :

Kotlin+KTX

try {
    methodThatThrows()
} catch (e: Exception) {
    Firebase.crashlytics.recordException(e)
    // handle your exception here
}

Java

try {
    methodThatThrows();
} catch (Exception e) {
    FirebaseCrashlytics.getInstance().recordException(e);
    // handle your exception here
}

Avertissement :Si vous souhaitez inclure une valeur unique (par exemple, un ID utilisateur ou un code temporel) dans votre message d'exception, utilisez une clé personnalisée au lieu d'ajouter la valeur directement dans le message d'exception. L'ajout direct de valeurs peut entraîner plusieurs problèmes et Crashlytics peut limiter les erreurs de création de rapports dans votre application.

Toutes les exceptions enregistrées apparaissent comme des problèmes non critiques dans la console Firebase. Le résumé du problème contient toutes les informations d'état que vous obtenez normalement en cas de plantage, ainsi que des répartitions par version d'Android et appareil matériel.

Crashlytics traite les exceptions sur un thread d'arrière-plan dédié pour minimiser l'impact sur les performances de votre application. Pour réduire le trafic réseau de vos utilisateurs, Crashlytics regroupe les exceptions journalisées et les envoie la prochaine fois que l'application est lancée.

Obtenir les journaux des fils d'Ariane

Les journaux de breadcrumb vous permettent de mieux comprendre les interactions d'un utilisateur avec votre application avant un plantage, un problème non fatal ou un événement ANR. Ces journaux peuvent être utiles pour essayer de reproduire et de déboguer un problème.

Les journaux de fil d'Ariane sont alimentés par Google Analytics. Pour les obtenir, vous devez activer Google Analytics pour votre projet Firebase et ajouter le SDK Firebase pour Google Analytics à votre application. Une fois ces conditions remplies, les journaux de fil d'Ariane sont automatiquement inclus avec les données d'un événement dans l'onglet Journaux lorsque vous consultez les détails d'un problème.

Le SDK Analytics journalise automatiquement l'événement screen_view, ce qui permet aux journaux de breadcrumb d'afficher une liste des écrans consultés avant l'événement de plantage, d'erreur non fatale ou d'erreur ANR. Un journal de fil d'Ariane screen_view contient un paramètre firebase_screen_class.

Les journaux de fil d'Ariane sont également renseignés par tous les événements personnalisés que vous enregistrez manuellement dans la session de l'utilisateur, y compris les données de paramètre de l'événement. Ces données peuvent aider à afficher une série d'actions utilisateur ayant conduit à un plantage, un problème non fatal ou un événement ANR.

Notez que vous pouvez contrôler la collecte et l'utilisation des données Google Analytics, y compris les données qui renseignent les journaux de fil d'Ariane.

Activer les rapports nécessitant une confirmation

Par défaut, Crashlytics collecte automatiquement les rapports d'erreur pour tous les utilisateurs de votre application. Pour permettre aux utilisateurs de mieux contrôler les données qu'ils envoient, vous pouvez activer les rapports nécessitant une confirmation en désactivant les rapports automatiques et en n'envoyant des données à Crashlytics que lorsque vous le souhaitez dans votre code:

1. Dans le bloc application de votre fichier AndroidManifest.xml, ajoutez une balise meta-data pour désactiver la collecte automatique:

   <meta-data
       android:name="firebase_crashlytics_collection_enabled"
       android:value="false" />
   

2. Activez la collecte pour certains utilisateurs en appelant le forçage de la collecte de données Crashlytics au moment de l'exécution. La valeur de forçage persiste à chaque lancement de votre application afin que Crashlytics puisse collecter automatiquement des rapports. Pour désactiver la création automatique de rapports d'erreur, transmettez false comme valeur de remplacement. Lorsque cette valeur est définie sur false, la nouvelle valeur ne s'applique qu'à l'exécution suivante de l'application.

   Kotlin+KTX

   Firebase.crashlytics.setCrashlyticsCollectionEnabled(true)

   Java

   FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(true);

Remarque: Si vous désactivez la création automatique de rapports, tenez compte des points suivants :

• Lorsque la collecte de données est désactivée pour un utilisateur, Crashlytics stocke les informations sur les plantages localement sur l'appareil. Si la collecte de données est activée par la suite, toutes les informations sur les plantages stockées sur l'appareil sont envoyées à Crashlytics pour traitement.
• Lorsque vous activez les rapports nécessitant une acceptation, les informations sur les plantages ne peuvent être collectées que auprès des utilisateurs qui ont explicitement accepté la collecte de données. Par conséquent, la précision des métriques sans plantage (comme les utilisateurs et les sessions sans plantage) sera affectée, car Crashlytics ne dispose que des informations sur les plantages de ces utilisateurs ayant activé la fonctionnalité (plutôt que de tous vos utilisateurs). Cela signifie que vos métriques sans plantage peuvent être moins fiables et moins représentatives de la stabilité globale de votre application.

Gérer les données des insights sur les plantages

Les insights sur les plantages vous aident à résoudre les problèmes en comparant vos traces de pile anonymisées à celles d'autres applications Firebase, et en vous indiquant si votre problème fait partie d'une tendance plus large. Pour de nombreux problèmes, Crash Insights fournit même des ressources pour vous aider à déboguer le plantage.

Crash Insights utilise des données de plantage agrégées pour identifier les tendances de stabilité courantes. Si vous préférez ne pas partager les données de votre application, vous pouvez désactiver Crash Insights dans le menu Crash Insights en haut de la liste des problèmes Crashlytics dans la console Firebase.

Remarque :En désactivant le partage de données, vous supprimerez les insights sur vos problèmes. La prise en compte des modifications peut prendre jusqu'à 24 heures.