Dépannage et questions fréquentes concernant Performance Monitoring

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. À 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 Performance Monitoring consigne des é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 ne consigne pas d'événements de performances, consultez les conseils de dépannage.

J'ai ajouté le SDK à l'application, mais la console indique toujours d'ajouter le SDK.

Firebase peut détecter si vous avez correctement ajouté le SDK Performance Monitoring à votre application lorsqu'il reçoit des informations sur les événements (comme les interactions avec l'application) de votre application. Généralement, dans les 10 minutes suivant le démarrage de votre application, le tableau de bord des performances de la console Firebase affiche un message "SDK détecté". Ensuite, dans un délai de 30 minutes, le tableau de bord affiche les données traitées initialement.

Si vous avez ajouté la dernière version du SDK à votre application il y a plus de 10 minutes et que vous ne constatez toujours aucun changement, vérifiez vos messages de journal pour vous assurer que Performance Monitoring consigne les événements. Suivez les étapes de dépannage appropriées décrites ci-dessous pour résoudre le problème d'un message de détection du SDK retardé.

La console indique que le SDK est détecté, mais aucune donnée n'est affichée

Performance Monitoring traite les données des événements de performances avant de les afficher dans le tableau de bord Performances.

Si plus de 24 heures se sont écoulées depuis l'apparition du message "SDK détecté" et que vous ne voyez toujours pas de données, consultez le tableau de bord d'état Firebase pour vérifier si une panne est connue. Si aucune panne n'est signalée, contactez l'assistance Firebase.

L'application n'enregistre pas les événements de performances

Si vous ne voyez pas de messages de journal pour les événements de performances, suivez la procédure de dépannage ci-dessous:

1. Vérifiez la configuration du plug-in Gradle Performance Monitoring comme suit:

   1. Assurez-vous d'avoir correctement ajouté le plug-in. Vérifiez plus précisément les points suivants:

      • Vous avez ajouté le plug-in (apply plugin: 'com.google.firebase.firebase-perf') dans le fichier build.gradle de votre module (au niveau de l'application).
      • Vous avez inclus la dépendance de chemin de classe pour le plug-in (classpath 'com.google.firebase:perf-plugin:1.4.2') dans votre fichier build.gradle au niveau du projet.

   2. Assurez-vous que le plug-in n'est pas désactivé à l'aide de l'un des indicateurs suivants:

      • instrumentationEnabled dans le fichier build.gradle de votre module (au niveau de l'application)
      • firebasePerformanceInstrumentationEnabled dans votre fichier gradle.properties

2. Vérifiez que le SDK Performance Monitoring n'est pas désactivé dans votre fichier AndroidManifest.xml à l'aide de l'une des options suivantes:

   • firebase_performance_collection_enabled
   • firebase_performance_collection_deactivated

3. Assurez-vous que Performance Monitoring n'est pas désactivé au moment de l'exécution.

4. Si vous ne trouvez rien de désactivé dans votre application, contactez l'assistance Firebase.

Données de trace d'écran manquantes dans le tableau de bord des performances

Si des données sont manquantes pour les traces de rendu d'écran, suivez les étapes de dépannage ci-dessous:

1. Assurez-vous d'utiliser la dernière version du SDK Android (version 21.0.2). Les traces de rendu d'écran ne sont disponibles qu'avec la version 15.2.0 ou ultérieure.

2. Assurez-vous de ne pas avoir désactivé manuellement l'accélération matérielle pour un écran.

3. Assurez-vous de ne pas utiliser DexGuard ni Jack. Performance Monitoring est incompatible avec ces chaînes d'outils.

   • DexGuard désactive la collecte automatique des traces de démarrage de l'application, de l'application au premier plan et de l'application en arrière-plan. Toutefois, toutes les traces de code personnalisé doivent se comporter normalement si votre application utilise DexGuard.

   • Jack est obsolète et ne doit généralement pas être utilisé dans votre application.

Il manque des données de trace personnalisées dans le tableau de bord des performances

Affichez-vous des données de performances pour les traces collectées automatiquement, mais pas pour les traces de code personnalisé ? Suivez les étapes de dépannage ci-dessous:

1. Si vous avez instrumenté des traces de code personnalisées via l'API Trace, vérifiez la configuration des traces, en particulier les éléments suivants:

   • Les noms des traces de code personnalisées et des métriques personnalisées doivent respecter les conditions suivantes: pas d'espace blanc au début ni à la fin, pas de caractère de soulignement (_) au début, et longueur maximale de 32 caractères.
   • Toutes les traces doivent être démarrées et arrêtées. Aucune trace qui n'est pas démarrée, pas arrêtée ou arrêtée avant le démarrage ne sera journalisée.

2. Si vous avez instrumenté des traces de code personnalisées via la notation @AddTrace, vérifiez la configuration du plug-in Gradle Performance Monitoring:

   1. Assurez-vous d'avoir correctement ajouté le plug-in. Vérifiez plus précisément les points suivants:

      • Vous avez ajouté le plug-in (apply plugin: 'com.google.firebase.firebase-perf') dans le fichier build.gradle de votre module (au niveau de l'application).
      • Vous avez inclus la dépendance de chemin de classe pour le plug-in (classpath 'com.google.firebase:perf-plugin:1.4.2') dans votre fichier build.gradle au niveau du projet.

   2. Assurez-vous que le plug-in n'est pas désactivé à l'aide de l'un des indicateurs suivants:

      • instrumentationEnabled dans le fichier build.gradle de votre module (au niveau de l'application)
      • firebasePerformanceInstrumentationEnabled dans votre fichier gradle.properties

3. Vérifiez vos messages de journal pour vous assurer que Performance Monitoring consigne les traces de code personnalisé attendues.

4. Si Performance Monitoring enregistre des événements, mais qu'aucune donnée ne s'affiche au bout de 24 heures, contactez l'assistance Firebase.

Données de requête réseau manquantes dans le tableau de bord des performances

Si les données de requête réseau sont manquantes, essayez de suivre les étapes de dépannage ci-dessous:

1. Pour les applications Android, le plug-in Gradle Performance Monitoring permet une instrumentation qui fournit une surveillance automatique des requêtes réseau HTTP/S. Vérifiez les éléments suivants :

   1. Assurez-vous d'avoir correctement ajouté le plug-in. Vérifiez plus précisément les points suivants:

      • Vous avez ajouté le plug-in (apply plugin: 'com.google.firebase.firebase-perf') dans le fichier build.gradle de votre module (au niveau de l'application).
      • Vous avez inclus la dépendance de chemin de classe pour le plug-in (classpath 'com.google.firebase:perf-plugin:1.4.2') dans votre fichier build.gradle au niveau du projet.

   2. Assurez-vous que le plug-in n'est pas désactivé à l'aide de l'un des indicateurs suivants:

      • instrumentationEnabled dans le fichier build.gradle de votre module (au niveau de l'application)
      • firebasePerformanceInstrumentationEnabled dans votre fichier gradle.properties

2. Vérifiez si la bibliothèque réseau est incompatible. Performance Monitoring collecte automatiquement les métriques pour les requêtes réseau qui utilisent les bibliothèques réseau suivantes: OkHttp 3.x.x, URLConnection de Java et Apache HttpClient.

   Notez que vous pouvez ajouter une surveillance personnalisée pour les requêtes réseau.

3. Important :

   • En fonction du comportement de votre code et des bibliothèques réseau utilisées par votre code, Performance Monitoring ne peut signaler que les requêtes réseau terminées. Cela signifie que les connexions HTTP/S laissées ouvertes ne sont pas nécessairement signalées.

   • Performance Monitoring n'est pas compatible avec DexGuard et Jack.

     • DexGuard désactive la surveillance des requêtes réseau HTTP/S.
     • Jack est obsolète et ne doit généralement pas être utilisé dans votre application.

   • Performance Monitoring ne signale pas les requêtes réseau avec des en-têtes Content-Type non valides. Toutefois, les requêtes réseau sans en-têtes Content-Type seront toujours acceptées.

Les données des requêtes réseau ne sont pas agrégées comme prévu

Découvrez comment Performance Monitoring agrège les données de requête réseau sous les formats d'URL.

Vous pouvez également essayer les formats d'URL personnalisés.

Qu'est-il arrivé aux principaux problèmes dans la fiche "Performances" de la page d'accueil du projet ?

Nous avons remplacé Problèmes courants par Alertes récentes, suite à l'introduction récente des alertes, qui vous avertissent automatiquement lorsque les seuils que vous définissez sont dépassés. Les problèmes sont désormais obsolètes et remplacés par des alertes.

Le sélecteur d'applications en haut de la fiche "Performances" filtre les entrées d'alerte sous Alertes récentes. Seules les trois alertes les plus récentes pour l'application ou les applications sélectionnées sont affichées.

Pour en savoir plus sur les alertes, consultez la section Configurer des alertes pour les problèmes de performances.

Qu'est-il arrivé à la possibilité de définir des seuils pour les problèmes dans la console ?

Performance Monitoring est compatible avec les alertes pour les métriques qui dépassent les seuils définis. Pour éviter toute confusion avec ces seuils configurables pour les métriques de performances, nous avons supprimé la possibilité de configurer des seuils pour les problèmes.

Qu'est-il arrivé aux informations "Détails" et "Métriques" dans la console Firebase ?

Nous avons remplacé les pages "Détails" et "Métriques" par une interface utilisateur (UI) centralisée et repensée pour vous permettre de résoudre les problèmes plus efficacement. Cette nouvelle interface de dépannage offre les mêmes fonctionnalités de base que les options "Détails" et "Métriques". Pour en savoir plus sur le dépannage, consultez la section Afficher plus de données pour une trace spécifique.

Pourquoi le nombre d'échantillons ne correspond-il pas à mes attentes ?

Performance Monitoring collecte des données de performances sur les appareils des utilisateurs de votre application. Si votre application compte de nombreux utilisateurs ou génère une grande quantité d'activité de performances, Performance Monitoring peut limiter la collecte de données à un sous-ensemble d'appareils afin de réduire le nombre d'événements traités. Ces limites sont suffisamment élevées pour que, même avec moins d'événements, les valeurs des métriques restent représentatives de l'expérience de l'utilisateur dans l'application.

Pour gérer le volume de données que nous recueillons, Performance Monitoring utilise les options d'échantillonnage suivantes:

• Limitation de la fréquence d'envoi sur l'appareil: pour empêcher un appareil d'envoyer des rafales soudaines de traces, nous limitons le nombre de traces de code et de requêtes réseau envoyées depuis un appareil à 300 événements toutes les 10 minutes. Cette approche protège l'appareil contre les instrumentations en boucle qui peuvent envoyer de grandes quantités de données de performances, et empêche un seul appareil de fausser les mesures de performances.

• Échantillonnage dynamique: Performance Monitoring collecte chaque jour un nombre limité de traces de code et de traces de requêtes réseau par application pour tous les utilisateurs de l'application. Un taux d'échantillonnage dynamique est extrait sur les appareils (à l'aide de Firebase Remote Config) pour déterminer si un appareil aléatoire doit capturer et envoyer des traces. Un appareil qui n'est pas sélectionné pour l'échantillonnage n'envoie aucun événement. Le taux d'échantillonnage dynamique est spécifique à l'application et s'ajuste pour s'assurer que le volume global de données collectées reste inférieur à la limite.

  Les projets ayant activé l'intégration BigQuery reçoivent une limite plus élevée pour le nombre de traces de requêtes réseau.

  Les sessions utilisateur envoient des données détaillées supplémentaires à partir de l'appareil de l'utilisateur, ce qui nécessite plus de ressources pour les capturer et les envoyer. Pour minimiser l'impact des sessions utilisateur, Performance Monitoring peut également limiter le nombre de sessions.

• Limitation de débit côté serveur: pour s'assurer que les applications ne dépassent pas la limite d'échantillonnage, Performance Monitoring peut utiliser l'échantillonnage côté serveur pour supprimer certains événements reçus des appareils. Bien que ce type de limitation ne modifie pas l'efficacité de nos métriques, il peut entraîner des changements mineurs de tendances, y compris les suivants:

  • Le nombre de traces peut différer du nombre de fois qu'un code a été exécuté.
  • Les traces étroitement associées dans le code peuvent avoir chacune un nombre d'échantillons différent.

Qu'est-il arrivé à l'onglet Problèmes de la console ?

Nous avons remplacé l'onglet "Problèmes" par "Alertes", qui vous avertit automatiquement lorsque les seuils que vous définissez sont dépassés. Vous n'avez plus besoin de vérifier manuellement la console Firebase pour déterminer l'état d'un seuil. Pour en savoir plus sur les alertes, consultez Configurer des alertes pour les problèmes de performances.

Qu'est-il arrivé aux onglets Sur l'appareil et Réseau de la console ? Comment puis-je consulter les traces qui se trouvaient sur ces pages ?

Nous avons repensé la section Performance Monitoring de la console Firebase afin que l'onglet Tableau de bord affiche vos métriques clés et toutes vos traces au même endroit. Lors de la refonte, nous avons supprimé les pages Sur l'appareil et Réseau.

Le tableau des traces en bas de l'onglet Dashboard contient toutes les informations affichées dans les onglets Sur l'appareil et Réseau, mais avec des fonctionnalités supplémentaires, y compris la possibilité de trier vos traces en fonction du pourcentage de variation d'une métrique spécifique. Pour afficher toutes les métriques et données d'une trace spécifique, cliquez sur son nom dans le tableau des traces.

Affichez vos traces dans les sous-onglets suivants du tableau des traces:

• Traces de requêtes réseau (prêt à l'emploi et personnalisées) : sous-onglet Requêtes réseau
• Traces de code personnalisées : sous-onglet Traces personnalisées
• Traces de démarrage, d'application au premier plan et d'application en arrière-plan : sous-onglet Traces personnalisées
• Traces de rendu d'écran : sous-onglet Rendu de l'écran
• Traces de chargement de page : sous-onglet Chargement de la page

Pour en savoir plus sur le tableau des traces, ainsi que sur les métriques et les données de visualisation, consultez la page "Vue d'ensemble de la console" (iOS+ | Android | Web).

Pourquoi le nombre d'images lentes et figées ne correspond-il pas à ce que j'attendais ?

Les images de rendu lent et les images figées sont calculées avec une fréquence d'actualisation de l'appareil de 60 Hz. Si la fréquence d'actualisation d'un appareil est inférieure à 60 Hz, le délai d'affichage de chaque frame est plus long, car moins de frames sont affichés par seconde. Des temps d'affichage plus lents peuvent entraîner l'affichage de plus de frames lents ou figés, car un plus grand nombre de frames seront affichés plus lentement ou seront figés. Toutefois, si la fréquence d'actualisation d'un appareil est supérieure à 60 Hz, le temps de rendu de chaque frame est plus rapide. Cela peut entraîner moins de rapports sur les images lentes ou figées. Il s'agit d'une limitation actuelle du SDK Performance Monitoring.

Pourquoi ne vois-je pas les traces de fragments ?

Pour afficher les performances des fragments en plus de l'activité de l'application, assurez-vous que votre application utilise la version 20.1.0 ou ultérieure du SDK Android Performance Monitoring. Pour en savoir plus, consultez Ajouter Performance Monitoring à votre application.

Comment savoir quelles traces sont associées aux fragments et aux activités ?

Chacune des traces de fragment et d'activité est basée sur son nom de classe tel que défini dans votre application. Chacune des traces d'écran contient le préfixe st, suivi du nom de la classe. Dans la console Firebase, le préfixe est supprimé. Pour en savoir plus, consultez En savoir plus sur les données de performance du rendu d'écran (applications Apple et Android) .

Pourquoi les traces de fragments sont-elles moins nombreuses que les autres ?

Performance Monitoring effectue un échantillonnage des événements pour tous les événements collectés sur un appareil. Cette approche nous permet de collecter le nombre minimal d'événements nécessaires sur les appareils des utilisateurs pour fournir des métriques de performances.

Comment suis-je informé en cas de problème avec les performances de rendu de mon application ?

Performance Monitoring vous permet de configurer des alertes pour les métriques qui vous intéressent. Pour les traces de rendu d'écran générées, vous pouvez configurer des alertes pour être averti lorsque le pourcentage de frames lents et figés dépasse un seuil que vous avez défini.

Les temps de compilation sont longs après l'activation du plug-in Gradle Performance Monitoring. Comment puis-je m'améliorer ?

Performance Monitoring pour Android utilise l'instrumentation de bytecode pour fournir certaines fonctionnalités prêtes à l'emploi, comme la surveillance des requêtes réseau HTTP/S. Lors de la compilation, le processus nécessite d'itérer dans toutes les classes de votre application (y compris les dépendances) pour instrumenter le code qui est essentiel pour mesurer les performances des requêtes réseau de votre application.

Voici quelques facteurs clés qui peuvent entraîner une augmentation du temps de compilation:

• Nombre de cours ou de fichiers
• Taille de chacune de ces classes (lignes de code)
• Configuration de votre machine
• Build initial par rapport à un build ultérieur (les builds ultérieurs sont généralement plus rapides que le build initial)

Pour optimiser le temps de compilation, envisagez de modulariser votre code.

À partir de la version 1.3.3 du plug-in Performance Monitoring, nous nous sommes concentrés sur l'amélioration considérable du traitement de compilation incrémentielle et du mise en cache des entrées de bibliothèque. Pour bénéficier des dernières améliorations du temps de compilation, assurez-vous d'utiliser la dernière version du plug-in (v1.4.2).

Notez que vous pouvez désactiver le plug-in Performance Monitoring pour vos builds de débogage localement si vous souhaitez éviter de longs délais de compilation. Toutefois, cette approche n'est pas recommandée pour les builds de production, car elle peut entraîner des mesures de performances manquées pour les requêtes réseau de votre application.

Que faire si je reçois des erreurs de compilation en raison de bibliothèques incompatibles avec le plug-in Gradle Performance Monitoring ?

Performance Monitoring pour Android utilise l'instrumentation de bytecode pour fournir certaines fonctionnalités prêtes à l'emploi, comme la surveillance des requêtes réseau HTTP/S. Lors de la compilation, le processus nécessite d'itérer dans toutes les classes de votre application (y compris les dépendances) pour instrumenter le code qui est essentiel pour mesurer les performances des requêtes réseau de votre application.

Si vous obtenez des erreurs de compilation telles que JSR/RET are not supported with computeFrames option ou des erreurs similaires après l'intégration avec le plug-in Performance Monitoring, cela peut être dû au fait que vous dépendez également d'une bibliothèque incompatible avec le plug-in Gradle Performance Monitoring.

Pour contourner ce problème, vous pouvez exclure l'instrumentation des classes/bibliothèques incompatibles en procédant comme suit:

1. Mettez à jour la dernière version du plug-in Gradle Performance Monitoring (version 1.4.0 minimum).
2. Mettez à jour votre plug-in Android Gradle vers la version 7.2.0 ou ultérieure.
3. Ajoutez l'indicateur suivant au fichier build.gradle de votre module (au niveau de l'application) pour exclure l'instrumentation des classes/bibliothèques incompatibles:

   android {
     // ...
     androidComponents {
       onVariants(selector().all(), {
           instrumentation.excludes.add("example.incompatible.library")
       })
     }
   }

   Pour en savoir plus sur la propriété exclude de l'API Instrumentation du plug-in Android Gradle, consultez Instrumentation.

Veuillez signaler un problème sur GitHub lorsque vous rencontrez des erreurs de compilation dues à des bibliothèques incompatibles afin qu'elles puissent également être exclues de l'instrumentation dans le plug-in Performance Monitoring.

L'exportation de mes données Performance Monitoring vers BigQuery prend plus de temps que prévu. N'est-ce pas en temps réel ?

Si vous avez activé l'intégration BigQuery pour Firebase Performance Monitoring, vos données seront exportées vers BigQuery 12 à 24 heures après la fin de la journée (heure du Pacifique).

Par exemple, les données du 19 avril seront disponibles dans BigQuery le 20 avril entre 12h00 et minuit (toutes les dates et heures sont exprimées en heure du Pacifique).

Que signifie "temps quasi réel" ?

Firebase Performance Monitoring traite les données de performances collectées à mesure qu'elles arrivent, ce qui permet d'afficher les données en quasi temps réel dans la console Firebase. Les données traitées s'affichent dans la console dans les minutes qui suivent leur collecte. C'est pourquoi on parle de "quasi-temps réel".

Pour profiter du traitement des données en quasi-temps réel, assurez-vous que votre application utilise une version de SDK compatible avec le temps réel.

Comment obtenir des données sur les performances de mon application en quasi-temps réel ?

Pour profiter du traitement des données en quasi-temps réel, il vous suffit de vous assurer que votre application utilise une version du SDK Performance Monitoring compatible avec le traitement des données en temps réel.

Voici les versions du SDK compatibles avec la surveillance en temps réel:

• iOS : version 7.3.0 ou ultérieure
• tvOS : version 8.9.0 ou ultérieure
• Android : version 19.0.10 ou ultérieure (ou Firebase Android BoM v26.1.0 ou version ultérieure)
• Web : version 7.14.0 ou ultérieure

Notez que nous vous recommandons toujours d'utiliser la dernière version du SDK, mais n'importe quelle version listée ci-dessus permet à Performance Monitoring de traiter vos données en quasi-temps réel.

Quelles versions du SDK Performance Monitoring sont considérées comme compatibles avec la surveillance en temps réel ?

Voici les versions de SDK compatibles avec le traitement des données en temps réel:

• iOS : version 7.3.0 ou ultérieure
• tvOS : version 8.9.0 ou ultérieure
• Android : version 19.0.10 ou ultérieure (ou Firebase Android BoM v26.1.0 ou version ultérieure)
• Web : version 7.14.0 ou ultérieure

Notez que nous vous recommandons toujours d'utiliser la dernière version du SDK, mais n'importe quelle version listée ci-dessus permet à Performance Monitoring de traiter vos données en quasi-temps réel.

Que se passe-t-il si je ne mets pas à jour mon application pour qu'elle utilise une version du SDK compatible avec le temps réel ?

Si votre application n'utilise pas de version de SDK compatible avec le temps réel, vous verrez toujours toutes les données de performances de votre application dans la console Firebase. Toutefois, l'affichage des données de performances sera retardé d'environ 36 heures à compter de leur collecte.

J'ai mis à jour ma version du SDK vers une version compatible avec la surveillance en temps réel, mais certains de mes utilisateurs utilisent toujours d'anciennes versions de mon application. Vais-je continuer à voir leurs données de performances dans la console Firebase ?

Oui ! Quelle que soit la version de SDK utilisée par une instance d'application, vous verrez les données de performances de tous vos utilisateurs.

Toutefois, si vous consultez des données récentes (datant de moins de 36 heures environ), les données affichées proviennent des utilisateurs d'instances d'application utilisant une version du SDK compatible avec le temps réel. Les données non récentes incluent toutefois les données de performances de toutes les versions de votre application.