Premiers pas avec Performance Monitoring pour le Web

Avant de commencer

Si ce n'est pas encore 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 : Ajoutez et initialisez Performance Monitoring

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

  2. Ajoutez le SDK JS Performance Monitoring 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 : Ajoutez la première bibliothèque de polyfills pour le délai de première entrée

Pour mesurer la métrique First Input Delay, vous devez ajouter la bibliothèque 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 polyfills n'est pas nécessaire 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 initial des données

Firebase commence à traiter les événements lorsque vous ajoutez le SDK à votre application. Si vous êtes encore en phase de développement local, interagissez avec votre application pour générer des événements pour la collecte et le traitement des données initiales.

  1. Diffuser et afficher votre application Web dans un environnement local

  2. Générez des événements en chargeant des sous-pages de 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 Performances de la console Firebase. Vos premières données devraient s'afficher au bout de quelques minutes.

    Si vos données initiales ne s'affichent pas, consultez les conseils de dépannage.

Étape 4 : (facultatif) Affichez les messages du journal pour les événements de performances.

  1. Ouvrez les outils pour les développeurs de votre navigateur (par exemple, l'onglet "Réseau" des outils pour les développeurs Chrome ou le contrôleur réseau de Firefox).

  2. Actualisez votre application Web dans le navigateur.

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

  4. Au bout de quelques secondes, recherchez un appel réseau vers 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) Ajoutez une surveillance personnalisée pour un code spécifique

Pour surveiller les données de performances associées à un code spécifique dans 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 charger un ensemble d'images ou interroger votre base de données. La métrique par défaut pour une trace de code personnalisé 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 SDK Performance Monitoring.

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

Étape 6 : Déployez votre application, puis examinez 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 sur les performances dans le tableau de bord des performances de la console Firebase.

Étapes suivantes