Premiers pas avec Performance Monitoring pour Android

Avant de commencer

Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet Android.

Étape 1: Ajoutez le SDK Performance Monitoring à votre application

Une fois que vous avez ajouté le SDK Performance Monitoring, Firebase commence automatiquement à collecter des données pour l'affichage de l'écran de votre application et les données liées au cycle de vie de votre application (comme l'heure de début de l'application). Pour permettre à Firebase de surveiller les requêtes réseau, vous devez également ajouter le plug-in Gradle Performance Monitoring (étape suivante).

1. 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 de la bibliothèque Performance Monitoring pour Android. Nous vous recommandons d'utiliser Firebase Android BoM pour contrôler la gestion des versions de la bibliothèque.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.6.0"))
   
       // Add the dependency for the Performance Monitoring library
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-perf")
   }

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

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

   Si vous choisissez de ne pas utiliser Firebase BoM, vous devez spécifier chaque version de bibliothèque Firebase dans 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 de la bibliothèque, ce qui garantit que toutes les versions sont compatibles.

   dependencies {
       // Add the dependency for the Performance Monitoring library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-perf:21.0.2")
   }

   Vous recherchez un module de bibliothèque spécifique à Kotlin ? À partir d'octobre 2023 (Firebase BoM 32.5.0), les développeurs Kotlin et Java peuvent dépendre du module de bibliothèque principal (pour en savoir plus, consultez les questions fréquentes sur cette initiative).

2. Recompilez votre application.

Remarque :Lorsque vous ajoutez le SDK Performance Monitoring à votre application, le SDK Remote Config est inclus en tant que dépendance. Si vous utilisez déjà Remote Config, vous ne remarquerez aucune différence. Toutefois, si vous ne connaissez pas Remote Config, consultez la documentation Remote Config pour en savoir plus sur les différentes fonctionnalités auxquelles vous pourrez accéder dans votre application.

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

Une fois que vous avez ajouté le plug-in Gradle Performance Monitoring, Firebase commence automatiquement à collecter des données pour les requêtes réseau HTTP/S. Le plug-in vous permet également d'instrumenter des traces de code personnalisées à l'aide de l'annotation @AddTrace.

Fonctionnement du plug-in Performance Monitoring

Avant que votre code ne soit converti en fichiers DEX, le plug-in Performance Monitoring utilise l'API Transform et le framework d'instrumentation du bytecode ASM pour accéder aux fichiers de classe compilés de votre application et pour instrumenter le code (pour mesurer les performances). Le temps nécessaire pour instrumenter votre code dépend en grande partie du nombre et de la taille de vos classes.

Si la compilation de votre application prend plus de temps que vous le souhaitez, envisagez les options suivantes :

• Désactivez le plug-in Performance Monitoring pour vos versions de débogage au moment de la compilation
• Modularisez votre code pour optimiser la vitesse de compilation

1. Dans votre fichier Gradle au niveau racine (au niveau du projet) (<project>/build.gradle.kts ou <project>/build.gradle), ajoutez le plug-in Gradle Performance Monitoring :

   Kotlin

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

   plugins {
       // To benefit from the latest Performance Monitoring plugin features,
       // update your Android Gradle plugin dependency to at least v3.4.0
       id("com.android.application") version "7.3.0" apply false
   
       // Make sure that you have the Google services Gradle plugin dependency
       id("com.google.gms.google-services") version "4.4.2" apply false
   
       // Add the dependency for the Performance Monitoring Gradle plugin
       id("com.google.firebase.firebase-perf") version "1.4.2" apply false
   }

   Groovy

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

   plugins {
       // To benefit from the latest Performance Monitoring plugin features,
       // update your Android Gradle plugin dependency to at least v3.4.0
       id 'com.android.application' version '7.3.0' apply false
   
       // Make sure that you have the Google services Gradle plugin dependency
       id 'com.google.gms.google-services' version '4.4.2' apply false
   
       // Add the dependency for the Performance Monitoring Gradle plugin
       id 'com.google.firebase.firebase-perf' version '1.4.2' apply false
   }

2. Dans votre fichier Gradle au niveau du module (application) (généralement <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), ajoutez le plug-in Gradle Performance Monitoring :

   Kotlin

   plugins {
       id("com.android.application")
   
       // Make sure that you have the Google services Gradle plugin
       id("com.google.gms.google-services")
   
       // Add the Performance Monitoring Gradle plugin
       id("com.google.firebase.firebase-perf")
       ...
   }

   Groovy

   plugins {
       id 'com.android.application'
   
       // Make sure that you have the Google services Gradle plugin
       id 'com.google.gms.google-services'
   
       // Add the Performance Monitoring Gradle plugin
       id 'com.google.firebase.firebase-perf'
       ...
   }

3. Recompilez votre application.

Étape 3 : Générer des événements de performances pour l'affichage initial des données

Firebase commence à traiter les événements lorsque vous avez correctement ajouté le SDK à votre application. Si vous êtes toujours en cours de développement local, interagissez avec votre application pour générer des événements afin de collecter et de traiter les données de manière initiale.

Remarque : Le SDK Performance Monitoring regroupe les événements localement, puis les envoie à Firebase régulièrement (toutes les 30 secondes). Il existe donc un délai entre une interaction dans l'application et le moment où Firebase reçoit les informations sur l'événement de votre application.

1. Générez des événements en basculant plusieurs fois votre application entre l'arrière-plan et le premier plan, en interagissant avec votre application en naviguant sur plusieurs écrans et/ou en déclenchant des requêtes réseau.

2. Accédez au tableau de bord des performances de la console Firebase. Vos données initiales devraient s'afficher au bout de quelques minutes.

   Si vos données initiales ne s'affichent pas, consultez les conseils de dépannage.

Étape 4 : (Facultatif) Afficher les messages de journal pour les événements de performances

1. Activez la journalisation de débogage pour Performance Monitoring au moment de la compilation en ajoutant un élément <meta-data> au fichier AndroidManifest.xml de votre application, comme suit:

   <application>
       <meta-data
         android:name="firebase_performance_logcat_enabled"
         android:value="true" />
   </application>

2. Recherchez d'éventuels messages d'erreur dans les messages de journal.

3. Performance Monitoring tague ses messages de journal avec FirebasePerformance. Grâce au filtrage logcat, vous pouvez afficher spécifiquement la journalisation des requêtes réseau HTTP/S et de la trace de durée en exécutant la commande suivante:

   adb logcat -s FirebasePerformance

4. Recherchez les types de journaux suivants, qui indiquent que Performance Monitoring consigne les événements de performances:

   • Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
   • Logging network request trace: URL

5. Cliquez sur l'URL pour afficher vos données dans la console Firebase. La mise à jour des données dans le tableau de bord peut prendre quelques instants.

Si votre application n'enregistre pas les événements de performances, consultez les conseils de dépannage.

Étape 5 : (Facultatif) Ajouter une surveillance personnalisée pour un code spécifique

Pour surveiller les données de performances associées à un code spécifique de votre application, vous pouvez instrumenter des traces de code personnalisées.

Avec une trace de code personnalisée, vous pouvez mesurer le temps nécessaire à votre application pour effectuer une tâche ou un ensemble de tâches spécifique, comme charger un ensemble d'images ou interroger votre base de données. La métrique par défaut d'une trace de code personnalisée est sa durée, mais vous pouvez également ajouter des métriques personnalisées, telles que les succès de cache et les avertissements concernant la mémoire.

Dans votre code, vous définissez le début et la fin d'une trace de code personnalisée (et ajoutez les métriques personnalisées souhaitées) à l'aide de l'API fournie par le SDK Performance Monitoring. Pour les applications Android, vous pouvez également surveiller la durée de méthodes spécifiques à l'aide de l'annotation @AddTrace.

Consultez Ajouter la surveillance d'un code spécifique pour en savoir plus sur ces fonctionnalités et découvrir comment les ajouter à votre application.

Étape 6 : Déployez votre application, puis examinez les résultats

Après avoir validé Performance Monitoring à l'aide d'un ou de plusieurs appareils de test, vous pouvez déployer la version mise à jour de votre application pour vos utilisateurs.

Vous pouvez surveiller les données sur les performances dans le tableau de bord des performances de la console Firebase.

Problèmes connus

• Le plug-in Gradle Performance Monitoring v1.1.0 peut entraîner une incompatibilité dans les dépendances Guava, ce qui entraîne l'erreur suivante:

  Error:Execution failed for task ':app:packageInstantRunResourcesDebug'.
  > com.google.common.util.concurrent.MoreExecutors.directExecutor()Ljava/util/concurrent/Executor;

  Si ce message d'erreur s'affiche, plusieurs possibilités s'offrent à vous:

  • Mettez à niveau le plug-in Performance Monitoring vers la version 1.1.1 ou ultérieure (la version la plus récente est la 1.4.2).

  • Remplacez la ligne de dépendance du plug-in Performance Monitoring dans votre fichier Gradle au niveau racine (au niveau du projet) (<project>/build.gradle.kts ou <project>/build.gradle) comme suit:

    Kotlin

    buildscript {
      // ...
    
      dependencies {
        // ...
    
        // Replace the standard Performance Monitoring plugin dependency line, as follows:
        classpath("com.google.firebase:perf-plugin:1.1.0") {
            exclude(group = "com.google.guava", module = "guava-jdk5")
        }
      }
    }

    Groovy

    buildscript {
      // ...
    
      dependencies {
        // ...
    
        // Replace the standard Performance Monitoring plugin dependency line, as follows:
        classpath('com.google.firebase:perf-plugin:1.1.0') {
            exclude group: 'com.google.guava', module: 'guava-jdk5'
        }
      }
    }

• Performance Monitoring indique la taille totale de la charge utile pour les requêtes réseau HTTP en fonction de la valeur définie dans l'en-tête HTTP "content-length". Cette valeur n'est pas toujours exacte.

• Performance Monitoring n'est compatible qu'avec le processus principal des applications Android multiprocessus.

Étapes suivantes

• Examinez et exécutez l'exemple de code Android Performance Monitoring sur GitHub.

• En savoir plus sur les données collectées automatiquement par Performance Monitoring :

  • Données liées au cycle de vie de votre application, comme le temps de démarrage de l'application
  • Données sur le rendu de l'écran dans votre application
  • Données sur les requêtes réseau HTTP/S émises par votre application

• Affichez, suivez et filtrez vos données de performances dans la console Firebase.

• Ajoutez la surveillance de tâches ou de workflows spécifiques dans votre application en instrumentant des traces de code personnalisées.

• Filtrez les données de performances à l'aide d'attributs.