Ajouter une surveillance personnalisée pour le code d'application spécifique

La surveillance des performances collecte des traces pour vous aider à surveiller les performances de votre application. Une trace est un rapport de 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 en chargeant un ensemble d'images ou en interrogeant votre base de données.

La métrique par défaut d'une trace de code personnalisée est sa « durée » (le temps entre les points de début et 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é à l'aide des API fournies par le SDK Performance Monitoring.

Les traces de code personnalisé peuvent être démarrées à tout moment après leur création et elles sont thread-safe.

Étant donné que la métrique par défaut collectée pour ces traces est la « durée », elles sont parfois appelées « traces de durée ».

Vous pouvez afficher les données de ces traces dans le sous-onglet Traces personnalisées du tableau des traces, qui se trouve au bas du tableau de bord Performances (en savoir plus sur l'utilisation de la console plus loin sur cette page).

Attributs par défaut, attributs personnalisés et métriques personnalisées

Pour les traces de code personnalisé, Performance Monitoring enregistre automatiquement les attributs par défaut (métadonnées communes 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 le niveau de jeu ou les propriétés de l'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 la portée de la trace. Par exemple, vous pouvez créer une métrique personnalisée pour le nombre de réussites et d'échecs du cache ou le nombre de fois où l'interface utilisateur ne répond plus pendant une période de temps notable.

Les attributs personnalisés et les métriques personnalisées s'affichent dans la console Firebase à côté des attributs et des métriques par défaut pour la trace.

Ajouter des traces de code personnalisées

Utilisez l'API Performance Monitoring Trace pour ajouter des traces de code personnalisées afin de surveiller le code d'application spécifique.

Notez ce qui suit :

  • Une application peut avoir plusieurs traces de code personnalisé.
  • Plusieurs traces de code personnalisé peuvent être exécutées simultanément.
  • Les noms des traces de code personnalisé doivent répondre aux exigences suivantes : aucun espace de début ou de fin, aucun caractère de soulignement ( _ ) de début et la longueur maximale est de 100 caractères.
  • Les traces de code personnalisé prennent en charge l'ajout de métriques et d'attributs personnalisés .

Pour démarrer et arrêter une trace de code personnalisé, encapsulez le code que vous souhaitez tracer avec un code similaire au suivant :

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.

Notez ce qui suit :

  • Les noms des métriques personnalisées doivent répondre aux exigences suivantes : aucun espace de début ou de fin, aucun caractère de soulignement ( _ ) de début et la longueur maximale est de 100 caractères.
  • Chaque trace de code personnalisé 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 similaire à la suivante chaque fois que l'événement se produit. Par exemple, cette métrique personnalisée compte les événements liés aux performances qui se produisent dans votre application, tels que les accès au cache ou les 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é spécifique. Vous pouvez définir l'attribut personnalisé à tout moment entre le début et l'arrêt de la trace.

Notez ce qui suit :

  • Les noms des attributs personnalisés doivent répondre aux exigences suivantes : aucun espace de début ou de fin, aucun caractère de soulignement ( _ ) de début et la longueur maximale est de 32 caractères.

  • Chaque trace de code personnalisé peut enregistrer jusqu'à 5 attributs personnalisés.

  • Vous ne devez pas utiliser d'attributs personnalisés contenant des informations permettant d'identifier personnellement une personne 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

Suivez des métriques spécifiques dans votre tableau de bord

Pour connaître l'évolution de vos indicateurs clés, ajoutez-les à votre tableau de indicateurs en haut du tableau de bord Performance . Vous pouvez identifier rapidement les régressions en observant les changements 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 carte de métrique remplie pour plus d'options, comme remplacer ou supprimer une métrique.

Le tableau des métriques affiche les données métriques collectées au fil du temps, à la fois sous forme graphique et sous forme de variation numérique en pourcentage.

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 jusqu'au tableau des traces, puis cliquez sur le sous-onglet approprié. Le tableau affiche certaines des principales mesures pour chaque trace, et vous pouvez même trier la liste en fonction du pourcentage de variation pour une mesure spécifique.

Si vous cliquez sur un nom de trace dans le tableau des traces, vous pouvez ensuite cliquer sur différents écrans pour explorer la trace et accéder aux 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 :

  • Filtrer par version de l'application pour afficher les données sur une version précédente ou votre dernière version
  • Filtrer par appareil pour savoir comment les anciens appareils gèrent votre application
  • Filtrez par pays pour vous assurer que l'emplacement de votre base de données n'affecte pas une région spécifique

En savoir plus sur l'affichage des données de vos traces .

Prochaines étapes

  • Apprenez-en davantage sur l’utilisation des attributs pour examiner les données de 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é spécifique dépasse un seuil que vous avez défini.