Ajouter une surveillance personnalisée pour un 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 points dans le temps 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 qu'il faut à 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é est sa "durée" (le temps entre les points de départ 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ée à l'aide des API fournies par le SDK Performance Monitoring.Les traces de code personnalisées peuvent être lancé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 "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 en bas du tableau de bord des 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

Vous pouvez également configurer une trace de code personnalisé 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 avec les attributs et la métrique par défaut de 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 un code d'application spécifique.

Notez ce qui suit :

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

Pour démarrer et arrêter un suivi de code personnalisé, encapsulez le code que vous souhaitez suivre avec des lignes de code similaires à celles-ci :

import { trace } from "firebase/performance";

const t = trace(perf, "CUSTOM_TRACE_NAME");
t.start();

// Code that you want to trace 
// ...

t.stop();
perf_add_custom_trace.js

const trace = perf.trace("CUSTOM_TRACE_NAME");
trace.start();

// Code that you want to trace 
// ...

trace.stop();
index.js

Ajouter des traces de code personnalisées à l'aide de l'API User Timing

En plus de l'API Performance Monitoring Trace, vous pouvez ajouter des traces de code personnalisées à l'aide de l' API User Timing native d'un navigateur. La durée d'une trace mesurée à l'aide de cette API est automatiquement récupérée par le SDK de surveillance des performances. L'utilisation de l'API User Timing est particulièrement utile si vous préférez charger le SDK de surveillance des performances de manière asynchrone. Une fois le SDK initialisé, le SDK enregistrera les mesures qui se sont produites avant son chargement.

Pour utiliser cette fonctionnalité, enveloppez le code que vous souhaitez tracer avec des marques de synchronisation utilisateur :

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");
perf_user_timing_marks.js

const performance = window.performance;

performance.mark("measurementStart");

// Code that you want to trace 
// ...

performance.mark("measurementStop");
performance.measure("customTraceName", "measurementStart", "measurementStop");
index.js

Notez que performance dans l'exemple ci-dessus font référence à l'objet window.performance du navigateur.

Lors de l'utilisation de l'API User Timing, les métriques et attributs personnalisés ne peuvent pas être ajoutés aux traces de code personnalisé. Utilisez l' API Performance Monitoring Trace si vous souhaitez ajouter ces éléments personnalisés à une trace de code personnalisée.

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 : pas d'espaces au début ou à la fin, pas de trait de soulignement ( _ ) au 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 de 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.

import { trace } from "firebase/performance";

async function getInventory(inventoryIds) {
  const t = trace(perf, "inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  t.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  t.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  t.stop();

  return inventoryData;
}
perf_add_custom_metrics.js

async function getInventory(inventoryIds) {
  const trace = perf.trace("inventoryRetrieval");

  // Tracks the number of IDs fetched (the metric could help you to optimize in the future)
  trace.incrementMetric("numberOfIds", inventoryIds.length);

  // Measures the time it takes to request inventory based on the amount of inventory
  trace.start();
  const inventoryData = await retrieveInventory(inventoryIds);
  trace.stop();

  return inventoryData;
}
index.js

Créer des attributs personnalisés pour les traces de code personnalisées

Utilisez l' API Performance Monitoring Trace pour ajouter des attributs personnalisés aux 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émarrage et l'arrêt de la trace.

Notez ce qui suit :

• Les noms des attributs personnalisés doivent répondre aux exigences suivantes :

  • Pas d'espaces de début ou de fin, pas de caractère de soulignement ( _ ) de début
  • Sans espaces
  • La longueur maximale est de 32 caractères
  • Les caractères autorisés pour le nom sont AZ , az et _ .

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

• Veuillez vous assurer que les attributs personnalisés ne contiennent aucune information permettant d'identifier personnellement un individu auprès de Google.

  En savoir plus sur cette directive

import { trace } from "firebase/performance";

const t = trace(perf, "test_trace");
t.putAttribute("experiment", "A");

// Update scenario
t.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = t.getAttribute("experiment");

// Delete scenario
t.removeAttribute("experiment");

// Read attributes
const traceAttributes = t.getAttributes();
perf_add_custom_attributes.js

const trace = perf.trace("test_trace");
trace.putAttribute("experiment", "A");

// Update scenario
trace.putAttribute("experiment", "B");

// Reading scenario
const experimentValue = trace.getAttribute("experiment");

// Delete scenario
trace.removeAttribute("experiment");

// Read attributes
const traceAttributes = trace.getAttributes();
index.js

Suivre, afficher et filtrer les données de performances

Pour afficher les données de performances en temps réel, assurez-vous que votre application utilise une version du SDK de surveillance des performances compatible avec le traitement des données en temps réel. En savoir plus sur les données de performances en temps réel .

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

Pour connaître l'évolution de vos métriques clés, ajoutez-les à votre tableau de métriques en haut du tableau de bord des performances . Vous pouvez rapidement identifier les régressions en voyant les changements d'une semaine sur l'autre ou vérifier que les modifications récentes de votre code améliorent les performances.

Pour ajouter une statistique à votre tableau de statistiques, procédez comme suit :

1. Accédez au tableau de bord des performances dans la console Firebase.
2. Cliquez sur une carte de métrique vide, puis sélectionnez une métrique existante à ajouter à votre tableau.
3. Cliquez sur more_vert sur une carte de métrique remplie pour plus d'options, par exemple pour 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 pourcentage de variation numérique.

En savoir plus sur l'utilisation du tableau de bord .

Visualiser les traces et leurs données

Pour afficher vos traces, accédez au tableau de bord des 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 métriques pour chaque trace, et vous pouvez même trier la liste en fonction du pourcentage de changement pour une métrique spécifique.

La surveillance des performances fournit une page de dépannage dans la console Firebase qui met en évidence les changements de métriques, ce qui permet de résoudre rapidement et de minimiser l'impact des problèmes de performances sur vos applications et vos utilisateurs. Vous pouvez utiliser la page de dépannage lorsque vous découvrez des problèmes de performances potentiels, par exemple, dans les scénarios suivants :

• Vous sélectionnez des métriques pertinentes sur le tableau de bord et vous remarquez un grand delta.
• Dans le tableau des traces, vous triez pour afficher les plus grands deltas en haut, et vous constatez une variation significative en pourcentage.
• Vous recevez une alerte par e-mail vous informant d'un problème de performances.

Vous pouvez accéder à la page de dépannage des manières suivantes :

• Dans le tableau de bord des métriques, cliquez sur le bouton Afficher les détails des métriques .
• Sur n'importe quelle carte de métrique, sélectionnez more_vert => Afficher les détails . La page de dépannage affiche des informations sur la métrique que vous avez sélectionnée.
• Dans le tableau des traces, cliquez sur un nom de trace ou sur n'importe quelle valeur de mesure dans la ligne associée à cette trace.
• Dans une alerte par e-mail, cliquez sur Enquêter maintenant .

Lorsque vous cliquez sur un nom de trace dans le tableau des traces, vous pouvez ensuite explorer les métriques qui vous intéressent. Cliquez sur le bouton Filter add pour filtrer les données par attribut, par exemple :

• Filtrer par URL de page pour afficher les données d'une page spécifique de votre site
• Filtrez par Type de connexion effective pour savoir comment une connexion 3G impacte 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 pour vos traces .

Prochaines étapes

• En savoir plus sur l'utilisation des attributs pour examiner les données de performances.

• En savoir plus sur le suivi des 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.