Check out what’s new from Firebase@ Google I/O 2021, and join our alpha program for early access to the new Remote Config personalization feature. Learn more

Premiers pas avec la surveillance des performances pour Android

Avant que tu commences

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

Étape 1 : Ajoutez le SDK de surveillance des performances à votre application

Une fois que vous avez ajouté le SDK de surveillance des performances, Firebase commence automatiquement à collecter des données pour le rendu de l'écran de votre application et des 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 Performance Monitoring Gradle (étape suivante).

  1. À l'aide de Firebase Android BoM , déclarez la dépendance de la bibliothèque Android Performance Monitoring dans le fichier Gradle de votre module (au niveau de l'application) (généralement app/build.gradle ).

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:28.1.0')
    
        // Declare 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) Déclarer les dépendances de la 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 nomenclature pour gérer les versions de la bibliothèque, ce qui garantit que toutes les versions sont compatibles.

    dependencies {
        // Declare 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:20.0.1'
    }
    

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:28.1.0')
    
        // Declare 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-ktx'
    }
    

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

    (Alternative) Déclarer les dépendances de la 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 nomenclature pour gérer les versions de la bibliothèque, ce qui garantit que toutes les versions sont compatibles.

    dependencies {
        // Declare 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-ktx:20.0.1'
    }
    

  2. Recompilez votre application.

Étape 2 : Ajoutez le plugin Performance Monitoring à votre application

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

  1. Dans votre fichier Gradle de module (au niveau de l'application) (généralement app/build.gradle ), appliquez le plugin Performance Monitoring :

    apply plugin: 'com.android.application'
    apply plugin: 'com.google.gms.google-services'
    // Apply the Performance Monitoring plugin
    apply plugin: 'com.google.firebase.firebase-perf'
    
    android {
      // ...
    }
    
  2. Dans votre fichier Gradle au niveau racine (au niveau du projet) ( build.gradle ), ajoutez les règles pour inclure le plug-in Performance Monitoring.

    buildscript {
    
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // Add the Bintray repository
          jcenter()
        }
    
        dependencies {
          // ...
    
          // To benefit from the latest Performance Monitoring plugin features,
          // update your Android Gradle Plugin dependency to at least v3.4.0
          classpath 'com.android.tools.build:gradle:3.4.0'
    
          classpath 'com.google.gms:google-services:4.3.8'  // Google Services plugin
    
          // Add the dependency for the Performance Monitoring plugin
          classpath 'com.google.firebase:perf-plugin:1.4.0'  // Performance Monitoring plugin
        }
    }
    
  3. Recompilez votre application.

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

Firebase commence à traiter les événements lorsque vous ajoutez avec succès le SDK à votre application. Si vous développez toujours localement, interagissez avec votre application pour générer des événements pour la collecte et le traitement initiaux des données.

  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 les écrans et/ou en déclenchant des requêtes réseau.

  2. Accédez au tableau de bord Performances de la console Firebase. Vous devriez voir vos données initiales s'afficher dans quelques minutes.

    Si vous ne voyez pas d'affichage de vos données initiales, 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 la surveillance des performances au moment de la génération en ajoutant un élément <meta-data> au fichier AndroidManifest.xml votre application, comme AndroidManifest.xml :

    <application>
        <meta-data
          android:name="firebase_performance_logcat_enabled"
          android:value="true" />
    </application>
    
  2. Vérifiez vos messages de journal pour tout message d'erreur.

  3. Performance Monitoring balise ses messages de journal avec FirebasePerformance . À l'aide du filtrage logcat, vous pouvez afficher spécifiquement la trace de durée et la journalisation des requêtes réseau HTTP/S en exécutant la commande suivante :

    adb logcat -s FirebasePerformance
  4. Recherchez les types de journaux suivants qui indiquent que la surveillance des performances enregistre les événements de performances :

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

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

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

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

Avec une trace de code personnalisée, vous pouvez mesurer le temps qu'il faut à votre application pour effectuer une tâche ou un ensemble de tâches spécifiques, comme le chargement d'un ensemble d'images ou l'interrogation de votre base de données. La métrique par défaut pour une trace de code personnalisé est sa durée, mais vous pouvez également ajouter des métriques personnalisées, telles que les accès au cache et les avertissements de mémoire.

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

Visitez Ajouter une surveillance pour un code spécifique pour en savoir plus sur ces fonctionnalités et sur la façon de les ajouter à votre application.

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

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

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

Problèmes connus

  • Le plug-in Performance Monitoring Gradle v1.1.0 peut provoquer 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 vous voyez cette erreur, vous pouvez soit :

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

    • Remplacez la ligne de dépendance du plug-in Performance Monitoring dans votre fichier Gradle de niveau racine (niveau projet) ( build.gradle ), comme suit :

      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'
          }
        }
      }
      
  • La surveillance des performances signale la taille totale de la charge utile pour les demandes de réseau HTTP en fonction de la valeur définie dans l'en-tête de longueur de contenu HTTP. Cette valeur peut ne pas toujours être exacte.

  • La surveillance des performances ne prend en charge que le processus principal dans les applications Android multi-processus.

Prochaines étapes