Performance Monitoring collecte des traces pour vous aider à surveiller les performances de votre application. Une trace est un rapport sur les données de performances capturées entre deux moments dans votre application.
Vous pouvez créer vos propres traces pour surveiller les données de performances associées à un code spécifique dans votre application. Avec une trace de code personnalisée, vous pouvez mesurer le temps nécessaire à votre application pour effectuer une tâche spécifique ou un ensemble de tâches, par exemple 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" (temps écoulé entre le point de départ et le point d'arrêt de la trace), mais vous pouvez également ajouter des métriques personnalisées.
Dans votre code, vous définissez le début et la fin d'une trace de code personnalisée à l'aide des API fournies par le SDK de surveillance des performances.
Les traces de code personnalisées peuvent être démarrées à tout moment après leur création et sont thread safe.
Étant donné que la métrique par défaut collectée pour ces traces est "durée", elles sont parfois appelées "traces de durée".
Vous pouvez consulter les données de ces traces dans le sous-onglet Traces personnalisées du tableau des traces, situé en bas du tableau de bord Performances (pour en savoir plus sur l'utilisation de la console, consultez la suite de cette page).
Attributs par défaut, attributs personnalisés et métriques personnalisées
Pour les traces de code personnalisées, Performance Monitoring consigne automatiquement les attributs par défaut (métadonnées courantes telles que la version de l'application, le pays, l'appareil, etc.) afin que vous puissiez filtrer les données de la trace dans la console Firebase. Vous pouvez également ajouter et surveiller des attributs personnalisés (tels que des niveaux de jeu ou des propriétés utilisateur).
Vous pouvez également configurer une trace de code personnalisée pour enregistrer des métriques personnalisées pour les événements liés aux performances qui se produisent dans le champ d'application de la trace. Par exemple, vous pouvez créer une métrique personnalisée pour le nombre de succès et d'échecs de cache ou le nombre de fois où l'UI ne répond pas pendant une période notable.
Les attributs et métriques personnalisés s'affichent dans la console Firebase, avec les attributs et la métrique par défaut de la trace.
Un attribut est une valeur de chaîne qui vous aide à filtrer et à segmenter les données dans la console.Ajouter des traces de code personnalisées
Utilisez l'API Performance Monitoring Trace pour ajouter des traces de code personnalisées afin de surveiller un code d'application spécifique.
Veuillez noter les points suivants :
- Une application peut avoir plusieurs traces de code personnalisées.
- Plusieurs traces de code personnalisé peuvent s'exécuter simultanément.
- Les noms des traces de code personnalisées doivent respecter les conditions suivantes : pas d'espace blanc au début ni à la fin, pas de trait de soulignement (
_) au début, et longueur maximale de 100 caractères. - Les traces de code personnalisées permettent d'ajouter des métriques personnalisées et des attributs personnalisés.
Pour démarrer et arrêter une trace de code personnalisé, encapsulez le code que vous souhaitez suivre avec un code semblable à celui-ci:
Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();
// Code you want to trace
await customTrace.stop();
Ajouter des métriques personnalisées aux traces de code personnalisées
Utilisez l'API Performance Monitoring Trace pour ajouter des métriques personnalisées aux traces de code personnalisées.
Veuillez noter les points suivants :
- Les noms des métriques personnalisées doivent respecter les conditions suivantes : pas d'espace blanc au début ni à la fin, pas de trait de soulignement (
_) au début, et longueur maximale de 100 caractères. - Chaque trace de code personnalisée peut enregistrer jusqu'à 32 métriques (y compris la métrique Durée par défaut).
Pour ajouter une métrique personnalisée, ajoutez une ligne de code semblable à celle-ci chaque fois que l'événement se produit. Par exemple, cette métrique personnalisée comptabilise les événements liés aux performances qui se produisent dans votre application, tels que les hits de cache ou les nouvelles tentatives.
Trace customTrace = FirebasePerformance.instance.newTrace("custom-trace");
await customTrace.start();
// Code you want to trace
customTrace.incrementMetric("metric-name", 1);
// More code
await customTrace.stop();
Créer des attributs personnalisés pour les traces de code personnalisées
Pour utiliser des attributs personnalisés, ajoutez du code à votre application qui définit l'attribut et l'associe à une trace de code personnalisée spécifique. Vous pouvez définir l'attribut personnalisé à tout moment entre le début de la trace et son arrêt.
Veuillez noter les points suivants :
Les noms des attributs personnalisés doivent respecter les conditions suivantes : pas d'espaces au début ni à la fin, pas de trait de soulignement (
_) au début, et longueur maximale de 32 caractères.Chaque trace de code personnalisé peut enregistrer jusqu'à cinq attributs personnalisés.
N'utilisez pas d'attributs personnalisés contenant des informations permettant d'identifier personnellement un individu auprès de Google.
Trace trace = FirebasePerformance.instance.newTrace("test_trace");
// Update scenario.
trace.putAttribute("experiment", "A");
// Reading scenario.
String? experimentValue = trace.getAttribute("experiment");
// Delete scenario.
trace.removeAttribute("experiment");
// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();
Suivre, afficher et filtrer les données de performances
Suivre des métriques spécifiques dans votre tableau de bord
Pour découvrir les tendances de vos métriques clés, ajoutez-les à votre tableau des métriques en haut du tableau de bord Performances. Vous pouvez identifier rapidement les régressions en observant les variations d'une semaine à l'autre ou vérifier que les modifications récentes apportées à votre code améliorent les performances.
Pour ajouter une métrique à votre tableau de métriques, accédez au tableau de bord Performances dans la console Firebase, puis cliquez sur l'onglet Tableau de bord. Cliquez sur une fiche de métrique vide, puis sélectionnez une métrique existante à ajouter à votre tableau. Cliquez sur les points de suspension verticaux (⋮) sur une fiche de métrique renseignée pour obtenir plus d'options, par exemple pour remplacer ou supprimer une métrique.
Le tableau de données sur les métriques affiche les données de métriques collectées au fil du temps, à la fois sous forme graphique et sous forme de pourcentage numérique.
En savoir plus sur l'utilisation du tableau de bord
Afficher les traces et leurs données
Pour afficher vos traces, accédez au tableau de bord "Performances" dans la console Firebase, faites défiler la table des traces vers le bas, puis cliquez sur le sous-onglet approprié. Le tableau affiche certaines des principales métriques pour chaque trace, et vous pouvez même trier la liste en fonction du pourcentage de variation pour une métrique spécifique.
Si vous cliquez sur un nom de trace dans le tableau des traces, vous pouvez ensuite passer par différents écrans pour explorer la trace et examiner les métriques qui vous intéressent. Sur la plupart des pages, vous pouvez utiliser le bouton Filtrer (en haut à gauche de l'écran) pour filtrer les données par attribut, par exemple :
- Filtrez les données par Version de l'application pour afficher les données d'une version précédente ou de votre dernière version.
- Filtrez par Appareil pour savoir comment les appareils plus anciens gèrent votre application.
- Filtrez les données par Pays pour vous assurer que l'emplacement de votre base de données n'affecte pas une région spécifique.
Découvrez comment afficher les données de vos traces.
Étapes suivantes
Découvrez comment utiliser des attributs pour examiner les données sur les performances.
Découvrez comment suivre les problèmes de performances dans la console Firebase.
Configurez des alertes pour les modifications de code qui dégradent les performances de votre application. Par exemple, vous pouvez configurer une alerte par e-mail pour votre équipe si la durée d'une trace de code personnalisée spécifique dépasse un seuil que vous avez défini.