Cette page a été traduite par l'API Cloud Translation.

Premiers pas avec Firebase Crashlytics

Si votre application Android contient des bibliothèques natives, vous pouvez activer les traces de pile complètes et les rapports d'erreur détaillés pour votre code natif à partir de Firebase Crashlytics en apportant quelques petites modifications à la configuration de compilation de votre application.

Ce guide explique comment configurer les rapports d'erreur avec le SDK Firebase Crashlytics pour NDK.

Si vous souhaitez savoir comment commencer à utiliser Crashlytics dans vos projets Unity, consultez le guide de démarrage Unity.

Avant de commencer

Si ce n'est pas déjà fait, ajoutez Firebase à votre projet Android. Si vous ne possédez pas d'application Android, vous pouvez télécharger un exemple d'application.
Recommandé : pour obtenir automatiquement des journaux de navigation qui vous aident à comprendre les actions des utilisateurs ayant conduit à un plantage, une erreur non fatale 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 depuis l'onglet Intégrations de > Paramètres du projet dans la console Firebase.Google Analytics
- S'il s'agit d'un nouveau projet Firebase, activez Google Analytics pendant que vous le créez.
Assurez-vous que votre application dispose des versions minimales requises suivantes :
- Gradle 8.0
- Plug-in Android Gradle 8.1.0
- Plug-in Gradle des services Google 4.4.1

Étape 1 : Ajoutez le SDK Crashlytics pour NDK à votre application

Dans le fichier Gradle de votre module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), ajoutez la dépendance pour la bibliothèque NDK Crashlytics pour Android. Nous vous recommandons d'utiliser Firebase Android BoM pour contrôler le versionnage de la bibliothèque.

Pour une expérience optimale avec Crashlytics, nous vous recommandons d'activer Google Analytics dans votre projet Firebase et d'ajouter le SDK Firebase pour Google Analytics à votre application.

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.2.0"))

    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics-ndk")
    implementation("com.google.firebase:firebase-analytics")
}

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

(Alternative) Ajoutez les dépendances de la bibliothèque Firebase sans utiliser BoM.

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

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

dependencies {
    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-crashlytics-ndk:20.0.1")
    implementation("com.google.firebase:firebase-analytics:23.0.0")
}

Étape 2 : Ajoutez le plug-in Gradle Crashlytics à votre application

Dans votre fichier Gradle au niveau de la racine (au niveau du projet) (<project>/build.gradle.kts ou <project>/build.gradle), ajoutez le plug-in Gradle Crashlytics au bloc plugins :

Kotlin

Utilisez-vous toujours la syntaxe buildscript ? Découvrez comment ajouter des plug-ins Firebase à l'aide de cette syntaxe.

plugins {
    // Make sure that you have the AGP plugin 8.1+ dependency
    id("com.android.application") version "8.1.4" apply false
    // ...

    // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
    id("com.google.gms.google-services") version "4.4.3" apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id("com.google.firebase.crashlytics") version "3.0.6" apply false
}

Groovy

Utilisez-vous toujours la syntaxe buildscript ? Découvrez comment ajouter des plug-ins Firebase à l'aide de cette syntaxe.

plugins {
    // Make sure that you have the AGP plugin 8.1+ dependency
    id 'com.android.application' version '8.1.4' apply false
    // ...

    // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
    id 'com.google.gms.google-services' version '4.4.3' apply false

    // Add the dependency for the Crashlytics Gradle plugin
    id 'com.google.firebase.crashlytics' version '3.0.6' apply false
}

Dans le fichier Gradle de votre module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), ajoutez le plug-in Gradle Crashlytics :

Kotlin

plugins {
  id("com.android.application")
  // ...

  // Make sure that you have the Google services Gradle plugin
  id("com.google.gms.google-services")

  // Add the Crashlytics Gradle plugin
  id("com.google.firebase.crashlytics")
}

Groovy

plugins {
  id 'com.android.application'
  // ...

  // Make sure that you have the Google services Gradle plugin
  id 'com.google.gms.google-services'

  // Add the Crashlytics Gradle plugin
  id 'com.google.firebase.crashlytics'
}

Étape 3 : Ajoutez l'extension Crashlytics à votre build

Kotlin

import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension

// ...

android {
  // ...
  buildTypes {
      getByName("release") {
          // Add this extension
          configure<CrashlyticsExtension> {
              // Enable processing and uploading of native symbols to Firebase 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
          }
      }
  }
}

Groovy

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase 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
          }
      }
  }
}

Étape 4 : Configurez l'importation automatique des symboles natifs

Pour générer des traces de pile lisibles à partir des plantages NDK, Crashlytics doit connaître les symboles de vos binaires natifs. Le plug-in Gradle Crashlytics inclut la tâche uploadCrashlyticsSymbolFileBUILD_VARIANT pour automatiser ce processus.

Pour accéder à la tâche d'importation automatique des symboles, assurez-vous que nativeSymbolUploadEnabled est défini sur true dans le fichier Gradle de votre module (au niveau de l'application).
Pour que les noms de méthodes apparaissent dans vos traces de pile, vous devez appeler explicitement la tâche uploadCrashlyticsSymbolFileBUILD_VARIANT après chaque compilation de votre bibliothèque NDK. Exemple :
```
>./gradlew app:assembleBUILD_VARIANT\
           app:uploadCrashlyticsSymbolFileBUILD_VARIANT
```
Le SDK Crashlytics pour NDK et le plug-in Gradle Crashlytics dépendent de la présence de l'ID de compilation GNU dans les objets partagés natifs.

Vous pouvez vérifier la présence de cet ID en exécutant readelf -n sur chaque binaire. Si l'ID de build est absent, ajoutez -Wl,--build-id aux indicateurs de votre système de compilation pour résoudre le problème.

Étape 5 : Forcez un plantage du 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 test.

Ajoutez à votre application du code que vous pouvez utiliser pour forcer un plantage de test.

Vous pouvez utiliser le code suivant dans le fichier MainActivity de votre application pour ajouter un bouton qui, lorsqu'il est enfoncé, provoque un plantage. Le bouton est intitulé "Test Crash".

Kotlin

val crashButton = Button(this)
crashButton.text = "Test Crash"
crashButton.setOnClickListener {
   throw RuntimeException("Test Crash") // Force a crash
}

addContentView(crashButton, ViewGroup.LayoutParams(
       ViewGroup.LayoutParams.MATCH_PARENT,
       ViewGroup.LayoutParams.WRAP_CONTENT))

Java

Button crashButton = new Button(this);
crashButton.setText("Test Crash");
crashButton.setOnClickListener(new View.OnClickListener() {
   public void onClick(View view) {
       throw new RuntimeException("Test Crash"); // Force a crash
   }
});

addContentView(crashButton, new ViewGroup.LayoutParams(
       ViewGroup.LayoutParams.MATCH_PARENT,
       ViewGroup.LayoutParams.WRAP_CONTENT));

Compilez et exécutez votre application.
Forcez le plantage de test pour envoyer le premier rapport de plantage de votre application :
1. Ouvrez votre application depuis votre appareil de test ou votre émulateur.
2. Dans votre application, appuyez sur le bouton "Test Crash" que vous avez ajouté à l'aide du code ci-dessus.
3. Après le plantage de votre application, redémarrez-la pour qu'elle puisse envoyer le rapport d'erreur à Firebase.
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 du débogage pour voir si votre application envoie des rapports de plantage.

Et voilà ! Crashlytics surveille désormais les plantages de votre application. Vous pouvez consulter et examiner les rapports et statistiques sur les plantages dans le tableau de bord Crashlytics.

Étapes suivantes

(Recommandé) 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 GWP-ASan est explicitement activé dans votre application et que celle-ci utilise la dernière version du SDK Crashlytics pour NDK (v18.3.6 ou Firebase BoM v31.3.0).
Personnalisez la configuration de vos rapports d'erreur en ajoutant des rapports d'activation, des journaux, des clés et le suivi des erreurs non fatales.
Intégrez Google Play pour pouvoir filtrer les rapports d'erreur de votre application Android par canal Google Play directement dans le tableau de bord Crashlytics. Cela vous permet de mieux cibler votre tableau de bord sur des versions spécifiques.

Dépannage

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

Autres options pour importer des symboles

Le workflow principal de cette page s'applique aux builds Gradle standards. Toutefois, certaines applications utilisent une configuration ou des outils différents (par exemple, un processus de compilation autre que Gradle). Dans ces situations, les options suivantes peuvent vous aider à importer des symboles.

Option : importer des symboles pour les modules de bibliothèque et les dépendances externes

Cette option peut être utile dans les situations suivantes :

Si vous utilisez un processus de compilation NDK personnalisé dans Gradle
Si vos bibliothèques natives sont intégrées à un module de bibliothèque/fonctionnalité ou fournies par un tiers
Si la tâche d'importation automatique des symboles échoue ou si vous constatez des plantages non symbolisés dans le tableau de bord

Afficher les instructions pour cette option

La tâche standard d'importation des symboles Crashlytics suppose que vous compilez vos bibliothèques natives dans le cadre de la compilation Gradle du module de votre application, à l'aide d'outils de compilation NDK standards tels que CMake.

Toutefois, si vous utilisez un processus de compilation NDK personnalisé dans Gradle, ou si vos bibliothèques natives sont compilées 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. Pour ce faire, vous pouvez ajouter la propriété unstrippedNativeLibsDir dans l'extension Crashlytics de votre fichier de compilation Gradle.

Assurez-vous d'avoir effectué les tâches initiales suivantes du workflow principal plus haut sur cette page :

Pour que la tâche d'importation automatique des symboles puisse trouver les informations sur vos symboles, ajoutez les éléments suivants à votre fichier Gradle de module (au niveau de l'application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle) :

Kotlin

import com.google.firebase.crashlytics.buildtools.gradle.CrashlyticsExtension

// ...

android {
    // ...
    buildTypes {
        release {
            configure<CrashlyticsExtension> {
                nativeSymbolUploadEnabled = true
                unstrippedNativeLibsDir = file("PATH/TO/UNSTRIPPED/DIRECTORY")
            }
        }
    }
}

Groovy

// ...

android {
    // ...
    buildTypes {
        release {
            firebaseCrashlytics {
                nativeSymbolUploadEnabled true
                unstrippedNativeLibsDir file("PATH/TO/UNSTRIPPED/DIRECTORY")
            }
        }
    }
}

Le plug-in Crashlytics recherche de manière récursive les bibliothèques natives avec une extension .so dans le répertoire spécifié. Crashlytics extrait ensuite les symboles de débogage de toutes ces bibliothèques et les importe sur les serveurs Firebase.

Voici ce que vous pouvez spécifier dans la propriété unstrippedNativeLibsDir :

Tout argument autorisé pour org.gradle.api.Project#files(Object...), y compris java.lang.String, java.io.File ou org.gradle.api.file.FileCollection
Plusieurs répertoires pour une même variante de compilation en fournissant une liste ou une instance FileCollection
(À partir du plug-in Gradle v3.0.0) Accumulez plusieurs répertoires dans des produits et des variantes de compilation individuels.Crashlytics

Afficher un exemple avec plusieurs répertoires

  buildTypes {
    release {
      configure<CrashlyticsExtension> {
        nativeSymbolUploadEnabled = true
        unstrippedNativeLibsDir = file("MY/NATIVE/LIBS")
      }
    }
    productFlavors {
      flavorDimensions += "feature"
      create("basic") {
        dimension = "feature"
        // ...
      }
      create("featureX") {
        dimension = "feature"
        configure<CrashlyticsExtension> {
          unstrippedNativeLibsDir = file("MY/FEATURE_X/LIBS")
        }
      }
    }
  }

La tâche uploadCrashlyticsSymbolFilesBasicRelease n'importera que les symboles dans MY/NATIVE/LIBS, mais uploadCrashlyticsSymbolFilesFeatureXRelease importera les symboles dans MY/NATIVE/LIBS et MY/FEATURE_X/LIBS.

Enfin, forcez un plantage de test pour terminer la configuration de Crashlytics et afficher les données initiales dans le tableau de bord Crashlytics de la console Firebase.

Option : Importez des symboles pour les builds non Gradle ou les bibliothèques natives non dépouillées inaccessibles.

Cette option peut être utile dans les situations suivantes :

Si vous utilisez un processus de compilation autre que Gradle
Si vos bibliothèques natives non supprimées vous sont fournies d'une manière qui les rend inaccessibles lors des compilations Gradle

Afficher les instructions pour cette option

Cette option nécessite que vous exécutiez une commande CLI Firebase lorsque vous créez une version ou toute autre compilation pour laquelle vous souhaitez afficher des traces de pile symbolisées dans la console Firebase.

Assurez-vous d'avoir effectué les tâches initiales suivantes du workflow principal plus haut sur cette page :
1. Crashlytics est activé dans la console Firebase.
2. Ajout du SDK Crashlytics pour NDK et du plug-in Gradle Crashlytics.
Notez qu'avec cette option, vous n'avez pas besoin d'ajouter l'extension firebaseCrashlytics ni de configurer l'importation automatique des symboles, car vous utiliserez plutôt la CLI Firebase (voir les étapes suivantes ci-dessous) pour générer et importer vos fichiers de symboles.
Configurez votre environnement et votre projet pour l'importation de symboles :
1. Suivez les instructions pour installer la CLI Firebase.
  
  Si vous avez déjà installé la CLI, veillez à passer à la dernière version.
2. (uniquement pour les applications utilisant le niveau d'API Android 30 ou supérieur) Mettez à jour le modèle AndroidManifest.xml de votre application pour désactiver le taggage du pointeur :
  1. Cochez la case Android Player Settings > Publishing Settings > Build > Custom Main Manifest (Paramètres du lecteur Android > Paramètres de publication > Compilation > Manifeste principal personnalisé).
  2. Ouvrez le modèle de fichier manifeste situé à l'adresse Assets/Plugins/Android/AndroidManifest.xml.
  3. Ajoutez l'attribut suivant à la balise d'application : <application android:allowNativeHeapPointerTagging="false" ... />
Compilez votre projet.

Importez les informations sur vos symboles.

Une fois votre 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 : ID de votre application Android Firebase (et non le nom de votre package)
Exemple d'ID d'application Android Firebase : 1:567383003300:android:17104a2ced0c9b9b
Vous avez besoin de trouver l'ID de votre application Firebase ?
Voici deux façons de trouver l'ID de votre application Firebase :
- Dans votre fichier google-services.json, votre ID d'application correspond à la valeur mobilesdk_app_id.
- Dans la console Firebase, accédez à vos Paramètres du projet. Faites défiler la page jusqu'à la fiche Vos applications, puis cliquez sur l'application Firebase de votre choix pour trouver son ID.
PATH/TO/SYMBOLS : chemin d'accès au fichier de symboles généré par l'interface de ligne de commande
- Exporté vers un projet Android Studio : PATH/TO/SYMBOLS peut être n'importe quel répertoire. L'interface de ligne de commande Firebase recherchera de manière récursive les bibliothèques natives avec une extension .so dans le répertoire spécifié.
- Vous avez créé l'APK directement dans Unity : PATH/TO/SYMBOLS correspond au chemin d'accès au 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 afin de générer et d'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. L'utilisation n'est pas recommandé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 Breakpad est le paramètre par défaut pour la génération de fichiers de symboles. N'utilisez cette option que si vous avez ajouté `symbolGenerator { csym() }` dans votre configuration de compilation et que vous souhaitez la remplacer par Breakpad.
`--dry-run`	Génère les fichiers de symboles, mais ne les importe pas Ce flag est utile si vous souhaitez inspecter le contenu des fichiers envoyés.
`--debug`	Fournit des informations de débogage supplémentaires

Enfin, forcez un plantage de test pour terminer la configuration de Crashlytics et afficher les données initiales dans le tableau de bord Crashlytics de la console Firebase.

Après avoir compilé votre application pour forcer un plantage, veillez à exécuter la commande crashlytics:symbols:upload de la CLI Firebase pour importer votre fichier de symboles.

Premiers pas avec Firebase Crashlytics Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Avant de commencer

Étape 1 : Ajoutez le SDK Crashlytics pour NDK à votre application

Étape 2 : Ajoutez le plug-in Gradle Crashlytics à votre application

Kotlin

Groovy

Kotlin

Groovy

Étape 3 : Ajoutez l'extension Crashlytics à votre build

Kotlin

Groovy

Étape 4 : Configurez l'importation automatique des symboles natifs

Étape 5 : Forcez un plantage du test pour terminer la configuration

Kotlin

Java

Étapes suivantes

Dépannage

Autres options pour importer des symboles

Option : importer des symboles pour les modules de bibliothèque et les dépendances externes

Kotlin

Groovy

Option : Importez des symboles pour les builds non Gradle ou les bibliothèques natives non dépouillées inaccessibles.

Premiers pas avec Firebase Crashlytics