Premiers pas avec Crashlytics pour Android

Ce guide explique comment commencer à utiliser Firebase Crashlytics dans votre application Android.

Une fois que vous avez configuré le Firebase Crashlytics SDK dans votre application, vous pouvez obtenir des rapports de plantage complets dans la console Firebase. Avec Crashlytics pour Android, vous recevez des rapports sur les plantages, les erreurs non fatales et "L'application ne répond pas" (ANR).

La configuration de Crashlytics nécessite des tâches à la fois dans la console Firebase et votre IDE (comme l'ajout d'un fichier de configuration Firebase et du 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 Android. Si vous n'avez pas d'application Android, vous pouvez télécharger un exemple d'application.

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

   • S'il s'agit d'un nouveau projet Firebase, activez Google Analytics pendant que vous le créez.

   • Si vous utilisez un projet Firebase existant où Google Analytics n'est pas activé, vous pouvez l'activer dans les settings Paramètres > Intégrations page de la Firebase console.

3. 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 à votre application

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

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

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

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

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

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

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

   Kotlin

   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.4" apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id("com.google.firebase.crashlytics") version "3.0.7" apply false
   }

   Groovy

   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.4' apply false
   
       // Add the dependency for the Crashlytics Gradle plugin
       id 'com.google.firebase.crashlytics' version '3.0.7' apply false
   }

2. Dans le fichier Gradle 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 : Forcez un plantage de test pour terminer la configuration

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

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

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

   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));

2. Compilez et exécutez votre application.

3. Forcez le plantage de test afin d'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" (Test de plantage) que vous avez ajouté à l'aide du code ci-dessus.

   3. Une fois votre application plantée, redémarrez-la pour qu'elle puisse envoyer le rapport de plantage à Firebase.

4. Dans la console Firebase, accédez au tableau de bord DevOps et engagement > Crashlytics pour vérifier votre rapport de plantage de test .

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

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

Étapes suivantes

• Personnalisez la configuration de votre rapport de plantage en ajoutant des rapports facultatifs, des journaux, des clés et le suivi des erreurs non fatales.

• Intégrez Google Play pour pouvoir filtrer les rapports de plantage 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 builds spécifiques.

• Dans Android Studio, affichez et filtrez les données Crashlytics.

  • Utilisez la fenêtre Insights sur la qualité des applications (AQI) dans Android Studio pour afficher les données Crashlytics à côté de votre code. Vous n'avez pas besoin de passer constamment du tableau de bord Crashlytics à l'IDE pour commencer à déboguer les principaux problèmes.
  • Découvrez comment utiliser la fenêtre AQI dans la documentation Android Studio.
  • Nous serions ravis de recevoir vos commentaires. Envoyez-nous vos commentaires sur la fenêtre AQI en envoyant un rapport de bug.

• Exportez vos données vers BigQuery ou Cloud Logging pour bénéficier d'analyses et de fonctionnalités avancées, comme l'interrogation de vos données, la création de tableaux de bord personnalisés et la configuration d'alertes personnalisées.