Google 致力于为黑人社区推动种族平等。查看具体举措

Obtenez des rapports de plantage Android NDK

Si votre application Android contient des bibliothèques natives , vous pouvez activer les traces de pile complète et rapports d' erreur détaillés pour votre code natif de Firebase Crashlytics avec quelques petites mises à jour de la configuration de construction de votre application. Ce guide explique comment configurer les rapports de plantage avec le nouveau SDK Firebase Crashlytics.

Avant que tu commences

Pour commencer, mettre en place Crashlytics .

  1. En tant que partie de l' étape 2 (Ajouter le plugin Firebase Crashlytics à votre application) , assurez - vous que votre application utilise le Gradle Crashlytics plug - in v2.4.0 +, ce qui vous permet de télécharger des symboles en utilisant uniquement vos binaires non extraits pour générer des accidents symbolicated.

Etape 1: Mettre à jour votre configuration Gradle

Dans votre niveau d'application build.gradle , déclarer la dépendance d'exécution Crashlytics NDK:

Java

apply plugin: 'com.android.application'
apply plugin: 'com.google.firebase.crashlytics'

dependencies {
  // ...

  // Import the BoM for the Firebase platform
  implementation platform('com.google.firebase:firebase-bom:28.4.1')

  // Declare the dependency for the Firebase Crashlytics NDK library.
  // If you previously declared the Firebase Crashlytics dependency, replace it.
  // When using the BoM, you don't specify versions in Firebase library dependencies
  implementation 'com.google.firebase:firebase-crashlytics'
  implementation 'com.google.firebase:firebase-crashlytics-ndk'
  implementation 'com.google.firebase:firebase-analytics'
}

// …
android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Crashlytics servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

En utilisant le Firebase Android BoM , votre application utilise toujours des versions compatibles des bibliothèques Firebase Android.

(Alternative) déclarer des dépendances de bibliothèque firebase sans utiliser la nomenclature

Si vous choisissez de ne pas utiliser la nomenclature de Firebase, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.

Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons fortement d' utiliser la BoM pour gérer les versions bibliothèque, ce qui garantit que toutes les versions sont compatibles.

  dependencies {
      // Declare the dependency for the Firebase Crashlytics NDK library.
      // If you previously declared the Firebase Crashlytics dependency, replace it.
      // When NOT using the BoM, you must specify versions in Firebase library dependencies
      implementation 'com.google.firebase:firebase-crashlytics:18.2.1'
      implementation 'com.google.firebase:firebase-crashlytics-ndk:18.2.1'
      implementation 'com.google.firebase:firebase-analytics:19.0.1'
  }
  

Kotlin+KTX

apply plugin: 'com.android.application'
apply plugin: 'com.google.firebase.crashlytics'

dependencies {
  // ...

  // Import the BoM for the Firebase platform
  implementation platform('com.google.firebase:firebase-bom:28.4.1')

  // Declare the dependency for the Firebase Crashlytics NDK library.
  // If you previously declared the Firebase Crashlytics dependency, replace it.
  // When using the BoM, you don't specify versions in Firebase library dependencies
  implementation 'com.google.firebase:firebase-crashlytics-ktx'
  implementation 'com.google.firebase:firebase-crashlytics-ndk'
  implementation 'com.google.firebase:firebase-analytics-ktx'
}

// …
android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Crashlytics servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

En utilisant le Firebase Android BoM , votre application utilise toujours des versions compatibles des bibliothèques Firebase Android.

(Alternative) déclarer des dépendances de bibliothèque firebase sans utiliser la nomenclature

Si vous choisissez de ne pas utiliser la nomenclature de Firebase, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.

Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons fortement d' utiliser la BoM pour gérer les versions bibliothèque, ce qui garantit que toutes les versions sont compatibles.

  dependencies {
      // Declare the dependency for the Firebase Crashlytics NDK library.
      // If you previously declared the Firebase Crashlytics dependency, replace it.
      // When NOT using the BoM, you must specify versions in Firebase library dependencies
      implementation 'com.google.firebase:firebase-crashlytics-ktx:18.2.1'
      implementation 'com.google.firebase:firebase-crashlytics-ndk:18.2.1'
      implementation 'com.google.firebase:firebase-analytics-ktx:19.0.1'
  }
  

Requis pour la version Crashlytics NDK 17.3.0: Si votre application utilise targetSdkLevel 30 ou au- dessus, vous devez également désactiver la fonction pointeur Tagging dans votre application en ajoutant ce qui suit à votre AndroidManifest.xml :

<application android:allowNativeHeapPointerTagging="false">
...
</application>

Pour plus d' informations, consultez le soutien du développeur pour Tagged Pointeurs .

Étape 2: Activer L' ajout de symbole natif

Pour produire des traces de pile lisibles à partir des plantages de NDK, Crashlytics doit connaître les symboles de vos binaires natifs. Notre plug - in Gradle inclut la uploadCrashlyticsSymbolFile BUILD_VARIANT tâche d'automatiser ce processus (pour accéder à cette tâche, assurez - vous nativeSymbolUploadEnabled est définie sur true).

Pour les noms de méthodes apparaissent dans vos traces de pile, vous devez appeler explicitement la uploadCrashlyticsSymbolFile BUILD_VARIANT tâche après chaque version de votre bibliothèque NDK. Par exemple:

>./gradlew app:assembleBUILD_VARIANT\
           app:uploadCrashlyticsSymbolFileBUILD_VARIANT

Le Crashlytics NDK v17.3.0+ et le plugin Gradle v2.4.1+ dépendent de la présence de l'identifiant de build GNU dans les objets partagés natifs. Vous pouvez vérifier la présence de cet identifiant en exécutant readelf -n sur chaque binaire. Si l'ID de construction est absent, ajoutez -Wl,--build-id aux drapeaux de votre système de construction pour résoudre le problème.

Etape 3 (facultative): Ajouter des symboles pour les modules de bibliothèque et des dépendances externes

Notre tâche de téléchargement de symboles suppose que vous construisez vos bibliothèques natives dans le cadre de la construction Gradle de votre module d'application, à l'aide d'outils de construction NDK standard tels que CMake. Si vous utilisez un processus de construction NDK personnalisé dans Gradle, ou si vos bibliothèques natives sont construites dans un module de bibliothèque/fonctionnalité ou fournies par un tiers, vous devrez peut-être spécifier explicitement le chemin d'accès à vos bibliothèques non supprimées. La firebaseCrashlytics extension fournit la propriété unstrippedNativeLibsDir pour le faire.

Ajouter ce qui suit à votre niveau d'application build.gradle fichier:

// …
android {
    // ...
    buildTypes {
        release {
            firebaseCrashlytics {
                nativeSymbolUploadEnabled true
                unstrippedNativeLibsDir file("path/to/unstripped/dir")
            }
        }
    }
}

Le plugin Crashlytics recherchera dans le répertoire spécifié et tous ses sous - répertoires pour les bibliothèques natives avec .so l' extension. Crashlytics extraira ensuite les symboles de débogage de toutes ces bibliothèques et les téléchargera sur les serveurs Firebase.

La unstrippedNativeLibsDir propriété accepte tous les arguments autorisés pour les org.gradle.api.Project#files(Object...) , y compris java.lang.String , java.io.File et org.gradle.api.file.FileCollection . Vous pouvez spécifier plusieurs répertoires pour une version unique saveur en fournissant une liste ou FileCollection instance.

Étape 4 ( en option): Personnaliser les rapports de plantage NDK

Vous pouvez éventuellement inclure l' crashlytics.h - tête dans votre code C ++ pour ajouter des métadonnées à des rapports de plantage NDK, tels que les journaux, les clés personnalisés, et des ID utilisateur. crashlytics.h est disponible en - tête uniquement bibliothèque C ++ dans le Firebase SDK Android GitHub Repository . Lisez les commentaires dans le fichier d'en-tête pour obtenir des instructions sur l'utilisation des API NDK C++.

Étape 5 (optionnel): fichier de symboles Breakpad pour symbolication

Le plug-in Crashlytics Gradle fournit les fonctionnalités suivantes :

  • Traite vos binaires natifs non dépouillés pour générer des fichiers de symboles.
  • Télécharge les fichiers de symboles générés sur nos serveurs pour être utilisés plus tard lors de la symbolisation des plantages natifs.

Le plugin Crashlytics Gradle prend en charge deux types de formats de fichiers de symboles :
le fichier symbole Crashlytics (cSYM) et le Breakpad fichier symbole.

Un fichier de symboles généré par Breakpad contient plus d'informations qu'un fichier de symboles généré par Crashlytics, y compris les informations de trame d'appel (CFI) qui sont utilisées dans le processus de déroulement pour aider à calculer les trames de pile. L'utilisation de CFI se traduira par des traces de pile plus fidèles, en particulier pour les applications hautement optimisées telles que les jeux et les applications multimédias.

Vous pouvez activer l'utilisation du générateur de fichiers de symboles basé sur Breakpad de l'une des deux manières suivantes :

  • Option 1: Activer par l' firebaseCrashlytics extension dans votre build.gradle fichier

    Ajouter ce qui suit à votre niveau d'application build.gradle fichier:

    android {
      // ...
      buildTypes {
        // ...
        release {
          // ...
          firebaseCrashlytics {
            // existing; required for either symbol file generator
            nativeSymbolUploadEnabled true
            // Add this optional new block to specify breakpad() or csym()
            symbolGenerator {
               breakpad()
            }
          }
        }
      }
    }
    

    Pour revenir au générateur de fichiers de symboles Crashlytics par défaut, vous pouvez effectuer l'une des opérations suivantes :

    • Omettre le symbolGenerator entièrement bloc, comme le plug - in utilise le générateur de fichier symbole Crashlytics par défaut.

    • Gardez le bloc, mais le changement breakpad() à csym() .

  • Option 2: Activer via une ligne de propriété dans votre fichier propriétés Gradle

    Vous pouvez utiliser la com.google.firebase.crashlytics.symbolGenerator propriété de contrôle qui générateur de fichier de symboles à utiliser. Les valeurs valides pour la propriété sont breakpad ou csym . Si non spécifié, la valeur par défaut actuelle équivaut à csym , bien que cela puisse changer dans les versions futures.

    Vous pouvez mettre à jour manuellement votre fichier de propriétés Gradle ou mettre à jour le fichier via la ligne de commande. Par exemple, pour activer le générateur de fichier symbole Breakpad, indiquez la valeur de breakpad comme indiqué dans la commande suivante:

    ./gradlew -Pcom.google.firebase.crashlytics.symbolGenerator=breakpad \
    app:assembleRelease app:uploadCrashlyticsSymbolFileRelease
    

Étape 6: Voir vos rapports d'erreur

Vérifiez que Crashlytics signale correctement les plantages NDK en créant votre application, en téléchargeant des symboles et en forçant un plantage natif. Vous devrez redémarrer l'application après son blocage pour que Crashlytics envoie le rapport. Vous devriez voir l'accident dans votre console Firebase en quelques minutes.

Dépannage

Si vous voyez les différentes traces de pile dans la console Firebase et dans le logcat, consultez le Guide de dépannage .