Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

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 des 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 qu'il faut à votre application pour terminer une tâche spécifique ou un ensemble de tâches, par exemple 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ée 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é à l'aide des API fournies par le SDK de surveillance des performances. Les traces de code personnalisées peuvent également être démarrées après leur création, et elles sont thread-safe.

Affichez les données des traces de code personnalisé dans l'onglet Sur l'appareil de la console Firebase (en savoir plus plus tard sur cette page). Notez que puisque la métrique par défaut collectée pour ces traces est «durée», elles sont parfois appelées «traces de durée». De plus, dans la console Firebase (dans l'onglet Sur l'appareil ), ces traces sont regroupées sous le tableau intitulé Durations .

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

Pour les traces de code personnalisées, Performance Monitoring enregistre automatiquement les attributs par défaut (métadonnées courantes comme le pays, le navigateur, l'URL de la page, etc.) afin que vous puissiez filtrer les données pour 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 en outre 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 d'occurrences et d'échecs de cache ou le nombre de fois où l'interface utilisateur cesse de répondre 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 par défaut et la métrique 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ées.
  • Plusieurs traces de code personnalisé peuvent s'exécuter en même temps.
  • Les noms des traces de code personnalisé doivent répondre aux exigences suivantes: aucun espace blanc 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ées prennent en charge l'ajout de métriques et d' attributs personnalisés .

Pour démarrer et arrêter une trace de code personnalisée, enveloppez le code que vous souhaitez suivre avec des lignes de code similaires à ce qui suit:

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

// code that you want to trace

trace.stop();

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 ont eu lieu avant son chargement.

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

performance.mark('measurementStart');

// code that you want to trace

performance.mark('measurementStop');
performance.measure('customTraceName', 'measurementStart', 'measurementStop');

Notez que les performance de l'exemple ci-dessus se réfèrent à 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ées. 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 mesures personnalisées doivent répondre aux exigences suivantes: aucun espace blanc 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.

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;
}

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ée spécifique. Vous pouvez définir l'attribut personnalisé à tout moment entre le début de la trace 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 blanc 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.

    En savoir plus sur ce guide

const trace = performance.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();

Suivre, afficher et filtrer les données de performances

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

Ajoutez vos indicateurs clés à votre tableau de bord pour découvrir leurs tendances. Vous pouvez identifier rapidement les régressions en observant les modifications d'une semaine à l'autre ou en vérifiant que les modifications récentes de votre code améliorent les performances.

une image du tableau de bord des mesures Firebase Performance Monitoring

Pour ajouter une métrique à votre tableau de bord, 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 de bord. Cliquez sur sur une carte de métrique remplie pour plus d'options, comme remplacer ou supprimer une métrique.

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

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

Afficher toutes les traces et leurs données

Pour afficher ces traces, accédez au tableau de bord Performances dans la console Firebase, puis cliquez sur l'onglet Sur l'appareil .

À partir de l'onglet Sur l'appareil , vous pouvez cliquer sur différents écrans pour explorer une trace et explorer les métriques d'intérêt. Sur la plupart des pages, vous pouvez utiliser le bouton filtre (en haut à gauche de l'écran) pour filtrer les données par attribut, par exemple:

une image des données Firebase Performance Monitoring filtrées par attribut
  • Filtrer par URL de page pour afficher les données d'une page spécifique de votre site
  • Filtrer par type de connexion efficace pour découvrir l'impact d'une connexion 3G sur 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