Premiers pas avec Performance Monitoring pour le Web

Avant de commencer

Si ce n'est pas déjà fait, consultez Ajouter Firebase à votre projet JavaScript pour découvrir comment :

  • Créer un projet Firebase

  • Enregistrer votre application Web auprès de Firebase

Notez que lorsque vous ajoutez Firebase à votre application, vous pouvez effectuer certaines des étapes décrites plus loin sur cette page (par exemple, ajouter le SDK et initialiser Firebase).

Étape 1 : Ajouter et initialiser Performance Monitoring

  1. Si ce n'est pas déjà fait, installez le SDK Firebase JS et initialisez Firebase.

  2. Ajoutez le Performance Monitoring JS SDK et initialisez Performance Monitoring :

Web 

import { initializeApp } from "firebase/app";
import { getPerformance } from "firebase/performance";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Performance Monitoring and get a reference to the service
const perf = getPerformance(app);

Web 

import firebase from "firebase/compat/app";
import "firebase/compat/performance";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Performance Monitoring and get a reference to the service
const perf = firebase.performance();

Étape 2 : Ajouter la première bibliothèque de polyfill de délai d'entrée

Pour mesurer la métrique du premier délai d'entrée, vous devez ajouter la bibliothèque de polyfill pour cette métrique. Pour obtenir des instructions d'installation, consultez la documentation de la bibliothèque.

L'ajout de cette bibliothèque de polyfill n'est pas obligatoire pour que Performance Monitoring signale les autres métriques d'application Web.

Étape 3 : Générer des événements de performances pour l'affichage des données initiales

Firebase commence à traiter les événements lorsque vous ajoutez le SDK à votre application. Si vous développez toujours localement, interagissez avec votre application pour générer des événements pour la collecte et le traitement des données initiales.

  1. Diffusez et affichez votre application Web dans un environnement local.

  2. Générez des événements en chargeant des sous-pages pour votre site, en interagissant avec votre application et/ou en déclenchant des requêtes réseau. Veillez à laisser l'onglet du navigateur ouvert pendant au moins 10 secondes après le chargement de la page.

  3. Accédez au tableau de bord Performance de la console Firebase. Vous devriez voir l'affichage de vos données initiales dans quelques minutes.

    Si vous ne voyez pas l'affichage de vos données initiales, consultez les conseils de dépannage.

Étape 4 : (Facultatif) Afficher les messages de journal pour les événements de performances

  1. Ouvrez les outils de développement de votre navigateur (par exemple, l'onglet "Réseau" des outils de développement Chrome ou le moniteur réseau de Firefox).

  2. Actualisez votre application Web dans le navigateur.

  3. Recherchez les éventuels messages d'erreur dans vos messages de journal.

  4. Après quelques secondes, recherchez un appel réseau à firebaselogging.googleapis.com dans les outils de développement de votre navigateur. La présence de cet appel réseau indique que le navigateur envoie des données de performances à Firebase.

Si votre application n'enregistre pas les événements de performances, consultez les conseils de dépannage.

Étape 5 : (Facultatif) Ajouter une surveillance personnalisée pour un code spécifique

Pour surveiller les données de performances associées à un code spécifique de votre application, vous pouvez instrumenter des traces de code personnalisées.

Avec une trace de code personnalisée, vous pouvez mesurer le temps nécessaire à votre application pour effectuer une tâche ou un ensemble de tâches spécifiques, comme 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, mais vous pouvez également ajouter des métriques personnalisées, telles que les accès au cache et les avertissements de mémoire.

Dans votre code, vous définissez le début et la fin d'une trace de code personnalisée (et ajoutez les métriques personnalisées souhaitées) à l'aide de l'API fournie par le Performance Monitoring SDK.

Consultez Ajouter une surveillance pour un code spécifique pour en savoir plus sur ces fonctionnalités et sur la manière de les ajouter à votre application.

Étape 6 : Déployer votre application, puis examiner les résultats

Une fois que vous avez validé Performance Monitoring, vous pouvez déployer la version mise à jour de votre application auprès de vos utilisateurs.

Vous pouvez surveiller les données de performances dans le tableau de bord Performance de la Firebase console.

Étapes suivantes