Personnalisez vos rapports d'erreur Firebase Crashlytics

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

  • Obtenez automatiquement les journaux de fil d'Ariane si votre application utilise le SDK Firebase pour Google Analytics. Ces journaux vous donnent une visibilité sur les actions des utilisateurs menant à un événement collecté par Crashlytics dans votre application.

  • Désactivez les rapports automatiques d'incidents et activez les rapports d'adhésion 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 aident à obtenir l'état spécifique de votre application menant à un crash. 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 les 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).

Utilisez la méthode setCustomValue pour définir des paires clé/valeur. Par exemple:

Rapide

// Set int_key to 100.
Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set str_key to "hello".
Crashlytics.crashlytics().setCustomValue("hello", forKey: "str_key")

Objectif c

Lorsque vous définissez des entiers, des booléens ou des flottants, encadrez la valeur comme @( value ) .

// Set int_key to 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set str_key to "hello".
[[FIRCrashlytics crashlytics] setCustomValue:@"hello" forKey:@"str_key"];

Vous pouvez également modifier la valeur d'une clé existante en appelant la clé et en lui attribuant une valeur différente. Par exemple:

Rapide

Crashlytics.crashlytics().setCustomValue(100, forKey: "int_key")

// Set int_key to 50 from 100.
Crashlytics.crashlytics().setCustomValue(50, forKey: "int_key")

Objectif c

[[FIRCrashlytics crashlytics] setCustomValue:@(100) forKey:@"int_key"];

// Set int_key to 50 from 100.
[[FIRCrashlytics crashlytics] setCustomValue:@(50) forKey:@"int_key"];

Ajoutez des paires clé/valeur en masse en utilisant la méthode setCustomKeysAndValues ​​avec un NSDictionary comme seul paramètre :

Rapide

let keysAndValues = [
                 "string key" : "string value",
                 "string key 2" : "string value 2",
                 "boolean key" : true,
                 "boolean key 2" : false,
                 "float key" : 1.01,
                 "float key 2" : 2.02
                ] as [String : Any]

Crashlytics.crashlytics().setCustomKeysAndValues(keysAndValues)

Objectif c

NSDictionary *keysAndValues =
    @{@"string key" : @"string value",
      @"string key 2" : @"string value 2",
      @"boolean key" : @(YES),
      @"boolean key 2" : @(NO),
      @"float key" : @(1.01),
      @"float key 2" : @(2.02)};

[[FIRCrashlytics crashlytics] setCustomKeysAndValues: keysAndValues];

Ajouter des messages de journal personnalisés

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

Rapide

Utilisez log() ou log(format:, arguments:) pour vous aider à identifier les problèmes. Si vous souhaitez obtenir une sortie de journal utile avec des messages, l'objet que vous transmettez à log() doit être conforme à la propriété CustomStringConvertible . log() renvoie la propriété de description que vous définissez pour l'objet. Par exemple:

Crashlytics.crashlytics().log("Higgs-Boson detected! Bailing out…, \(attributesDict)")

.log(format:, arguments:) formate les valeurs renvoyées par l'appel getVaList() . Par exemple:

Crashlytics.crashlytics().log(format: "%@, %@", arguments: getVaList(["Higgs-Boson detected! Bailing out…", attributesDict]))

Pour plus de détails sur l'utilisation log() ou log(format:, arguments:) , reportez-vous à la documentation de référence Crashlytics .

Objectif c

Utilisez log ou logWithFormat pour vous aider à identifier les problèmes. Notez que si vous souhaitez obtenir une sortie de journal utile avec des messages, l'objet que vous transmettez à l'une ou l'autre méthode doit remplacer la propriété d'instance description . Par exemple:

[[FIRCrashlytics crashlytics] log:@"Simple string message"];

[[FIRCrashlytics crashlytics] logWithFormat:@"Higgs-Boson detected! Bailing out... %@", attributesDict];

[[FIRCrashlytics crashlytics] logWithFormat:@"Logging a variable argument list %@" arguments:va_list_arg];

Pour plus de détails sur l'utilisation log et logWithFormat , reportez-vous à la documentation de référence Crashlytics.

Définir les identifiants des utilisateurs

Pour diagnostiquer un problème, il est souvent utile de savoir lequel de vos utilisateurs a rencontré un crash donné. Crashlytics inclut un moyen 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'identification, d'un jeton ou d'une valeur hachée :

Rapide

Crashlytics.crashlytics().setUserID("123456789")

Objectif c

[[FIRCrashlytics crashlytics] setUserID:@"123456789"];

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

Obtenir les journaux de fil d'Ariane

Les journaux de fil d'Ariane vous permettent de mieux comprendre les interactions qu'un utilisateur a eues avec votre application ayant conduit à un crash, un événement non fatal ou ANR. Ces journaux peuvent être utiles lorsque vous essayez de reproduire et de déboguer un problème.

Les journaux de fil d'Ariane sont alimentés par Google Analytics. Par conséquent, pour obtenir des journaux de fil d'Ariane, 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 affichez les détails d'un problème.

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

Les journaux de fil d'Ariane contiennent également tous les événements personnalisés que vous enregistrez manuellement dans la session de l'utilisateur, y compris les données de paramètres de l'événement. Ces données peuvent aider à montrer une série d'actions de l'utilisateur menant à un crash, un événement non fatal ou ANR.

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

Activer les rapports d'adhésion

Par défaut, Crashlytics collecte automatiquement les rapports d'erreur pour tous les utilisateurs de votre application. Pour donner aux utilisateurs plus de contrôle sur les données qu'ils envoient, vous pouvez activer les rapports opt-in en désactivant les rapports automatiques et en envoyant les données à Crashlytics uniquement lorsque vous le souhaitez dans votre code :

  1. Désactivez la collecte automatique en ajoutant une nouvelle clé à votre fichier Info.plist :

    • Clé : FirebaseCrashlyticsCollectionEnabled
    • Valeur : false

  2. Activez la collecte pour certains utilisateurs en appelant le remplacement de la collecte de données Crashlytics au moment de l'exécution. La valeur de remplacement persiste lors des lancements de votre application afin que Crashlytics puisse collecter automatiquement des rapports.

    Pour désactiver le rapport automatique d'incidents, transmettez false comme valeur de remplacement. Lorsqu'elle est définie sur false , la nouvelle valeur ne s'applique pas jusqu'à la prochaine exécution de l'application.

    Rapide

    Crashlytics.crashlytics().setCrashlyticsCollectionEnabled(true)

    Objectif c

    [[FIRCrashlytics crashlytics] setCrashlyticsCollectionEnabled:YES];

Gérer les données Crash Insights

Crash Insights vous aide à résoudre les problèmes en comparant vos traces de pile anonymisées aux traces 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 crash.

Crash Insights utilise des données d'accident agrégées pour identifier les tendances courantes en matière de stabilité. 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 votre liste de problèmes Crashlytics dans la console Firebase .