Personnaliser l'agrégation des données des requêtes réseau

Firebase Performance Monitoring regroupe automatiquement les données de requêtes réseau similaires pour vous aider à comprendre les tendances des performances de vos requêtes réseau.

Parfois, cependant, vous devez personnaliser la façon dont Firebase regroupe des données de requêtes réseau spécifiques pour mieux prendre en charge les cas d'utilisation de votre application. Nous proposons deux manières de personnaliser l'agrégation des données pour les requêtes réseau : agréger les données sous des modèles d'URL personnalisés et personnaliser la façon dont le taux de réussite est calculé .

Regrouper les données sous des modèles d'URL personnalisés

Pour chaque requête, Firebase vérifie si l'URL de la requête réseau correspond à un modèle d'URL . Si l'URL de la demande correspond à un modèle d'URL, Firebase regroupe automatiquement les données de la demande sous le modèle d'URL.

Vous pouvez créer des modèles d'URL personnalisés pour surveiller des modèles d'URL spécifiques que Firebase ne capture pas avec sa correspondance automatique de modèles d'URL dérivée. Par exemple, vous pouvez utiliser un modèle d'URL personnalisé pour dépanner une URL spécifique ou pour surveiller un ensemble spécifique d'URL au fil du temps.

Firebase affiche tous les modèles d'URL (y compris les modèles d'URL personnalisés) et leurs données agrégées dans le sous-onglet Demandes réseau du tableau des traces, qui se trouve au bas du tableau de bord Performances de la console Firebase.

Comment fonctionne la correspondance de modèle d'URL personnalisée ?

Firebase tente de faire correspondre les URL de requête à tous les modèles d'URL personnalisés configurés avant de revenir à la correspondance automatique des modèles d'URL. Pour toute requête correspondant à un modèle d'URL personnalisé, Firebase regroupe les données des requêtes sous le modèle d'URL personnalisé.

Si l'URL d'une requête correspond à plusieurs modèles d'URL personnalisés, Firebase mappe la requête au modèle d'URL personnalisé le plus spécifique uniquement, selon l'ordre de spécificité suivant : texte brut > * > ** de gauche à droite dans le chemin . Par exemple, une requête adressée à example.com/books/dog correspond à deux modèles d'URL personnalisés :

  • example.com/books/*
  • example.com/*/dog

Cependant, le modèle example.com/books/* est le modèle d'URL correspondant le plus spécifique , car le segment le plus à gauche books dans example.com/books/* a priorité sur le segment le plus à gauche * dans example.com/*/dog .

Lorsque vous créez un nouveau modèle d'URL personnalisé, tenez compte des points suivants :

  • Les correspondances et les données agrégées des demandes précédentes ne sont pas affectées par la création d'un nouveau modèle d'URL personnalisé. Firebase ne réagrège pas rétroactivement les données de demande.

  • Seules les demandes futures sont affectées par la création d'un nouveau modèle d'URL personnalisé. Vous devrez peut-être attendre jusqu'à 12 heures pour que l'analyse des performances collecte et regroupe les données sous un nouveau modèle d'URL personnalisé.

Créer un modèle d'URL personnalisé

Vous pouvez créer un modèle d'URL personnalisé à partir du sous-onglet Requêtes réseau du tableau des traces, qui se trouve au bas du tableau de bord Performances de la console Firebase.

Un membre du projet doit être propriétaire ou éditeur pour créer un nouveau modèle d'URL personnalisé ; cependant, tous les membres du projet peuvent afficher les modèles d'URL personnalisés et leurs données agrégées.

Vous pouvez créer jusqu'à 400 modèles d'URL personnalisés au total par application et jusqu'à 100 modèles d'URL personnalisés par domaine pour cette application.

Pour créer un modèle d'URL personnalisé, commencez par un nom d'hôte, suivi de segments de chemin. Le nom d'hôte doit inclure un domaine valide et peut éventuellement inclure le sous-domaine. Utilisez la syntaxe de segment de chemin suivante pour créer un modèle pouvant correspondre aux URL.

  • texte brut : correspond à une chaîne exacte
  • * — correspond au premier segment de sous-domaine ou à n'importe quelle chaîne dans un segment de chemin unique
  • ** — correspond à un suffixe de chemin arbitraire

Le tableau suivant décrit certaines correspondances de modèles d'URL personnalisées potentielles.

Correspondre... Créez un modèle d'URL personnalisé comme... Exemples de correspondances avec ce modèle d'URL
Une URL exacte example.com/foo/baz example.com/foo/baz
Tout segment de chemin unique ( * ) example.com/*/baz example.com/foo/baz
example.com/bar/baz
example.com/*/*/baz example.com/foo/bar/baz
example.com/bah/qux/baz
example.com/foo/* example.com/foo/baz
example.com/foo/bar

Remarque : ce modèle ne correspondra pas à example.com/foo .

Un suffixe de chemin arbitraire ( ** ) example.com/foo/** example.com/foo
example.com/foo/baz
example.com/foo/baz/more/segments
subdomain.example.com/foo.bar/** subdomain.example.com/foo.bar
subdomain.example.com/foo.bar/baz
subdomain.example.com/foo.bar/baz/more/segments
Le premier segment de sous-domaine ( * ) *.example.com/foo bar.example.com/foo
baz.example.com/foo

Afficher les modèles d'URL personnalisés et leurs données

Firebase affiche tous les modèles d'URL (y compris les modèles d'URL personnalisés) et leurs données agrégées dans le sous-onglet Demandes réseau du tableau des traces, qui se trouve au bas du tableau de bord Performances de la console Firebase.

Pour afficher uniquement les modèles d'URL personnalisés, sélectionnez Modèles personnalisés dans le menu déroulant du sous-onglet Demandes réseau du tableau des traces. Notez que si un modèle d'URL personnalisé ne contient aucune donnée agrégée, il apparaît uniquement dans cette liste.

Lorsque la période de conservation des données prend fin pour les données agrégées sous un modèle d'URL, Firebase supprime ces données du modèle d'URL. Si toutes les données agrégées sous un modèle d'URL personnalisé expirent, Firebase ne supprime pas le modèle d'URL personnalisé de la console Firebase. Au lieu de cela, Firebase continue de répertorier les modèles d'URL personnalisés « vides » dans la liste Modèles personnalisés du sous-onglet Requêtes réseau du tableau des traces.

Supprimer un modèle d'URL personnalisé

Vous pouvez supprimer les modèles d'URL personnalisés de votre projet. Notez que vous ne pouvez pas supprimer un modèle d'URL automatique.

  1. Dans le tableau de bord Performances , faites défiler jusqu'au tableau des traces, puis sélectionnez le sous-onglet Requêtes réseau .

  2. Sélectionnez Modèles personnalisés dans le menu déroulant du sous-onglet Demandes réseau .

  3. Passez la souris sur la ligne du modèle d'URL personnalisé que vous souhaitez supprimer.

  4. Cliquez sur à l'extrême droite de la ligne, sélectionnez Supprimer le modèle personnalisé , puis confirmez la suppression dans la boîte de dialogue.

Lorsque vous supprimez un modèle d'URL personnalisé, tenez compte des points suivants :

  • Toutes les demandes futures sont mappées au modèle d'URL personnalisé correspondant le plus spécifique . Si Firebase ne trouve aucun modèle d'URL personnalisé correspondant, il revient à la correspondance automatique des modèles d'URL .

  • Les correspondances et les données agrégées des demandes précédentes ne sont pas affectées par la suppression d'un modèle d'URL personnalisé.

    Vous pouvez toujours accéder à un modèle d'URL personnalisé supprimé et à ses données agrégées dans le sous-onglet Demandes réseau (avec Toutes les demandes réseau sélectionnées) jusqu'à la fin de la période de conservation des données applicable. Lorsque toutes les données agrégées sous le modèle d'URL personnalisé supprimé expirent, Firebase supprime le modèle d'URL personnalisé.

  • Le sous-onglet Demandes réseau (avec les modèles personnalisés sélectionnés) ne répertorie aucun modèle d'URL personnalisé supprimé.

Prochaines étapes

  • Configurez des alertes pour les requêtes réseau qui dégradent les performances de votre application. Par exemple, vous pouvez configurer une alerte par e-mail pour votre équipe si le temps de réponse pour un modèle d'URL spécifique dépasse un seuil que vous avez défini.

Personnalisez la façon dont le taux de réussite est calculé

L'une des mesures que Firebase surveille pour chaque requête réseau est le taux de réussite de la requête. Le taux de réussite est le pourcentage de réponses réussies par rapport au nombre total de réponses. Cette métrique vous aide à mesurer les pannes de réseau et de serveur.

Plus précisément, Firebase compte automatiquement les requêtes réseau avec un code de réponse compris entre 100 et 399 comme réponses réussies.

Vous pouvez personnaliser le calcul du taux de réussite en comptant certains codes d'erreur comme « réponses réussies » en plus des codes de réponse que Firebase compte automatiquement comme réussis.

Par exemple, si votre application dispose d'une API de point de terminaison de recherche, vous pouvez compter 404 réponses comme « réussies », car 404 réponses sont attendues pour un point de terminaison de recherche. Supposons qu’il y ait 100 échantillons pour ce point de terminaison de recherche toutes les heures, et que 60 d’entre eux contiennent 200 réponses et 40 d’entre eux contiennent 404 réponses. Avant de configurer le taux de réussite, le taux de réussite sera de 60 %. Après avoir configuré le calcul du taux de réussite pour compter 404 réponses comme réussies, le taux de réussite sera de 100 %.

Configurer le calcul du taux de réussite

Pour configurer le calcul du taux de réussite pour un modèle d'URL réseau, vous devez disposer de l'autorisation firebaseperformance.config.update . Les rôles suivants incluent cette autorisation requise par défaut : Firebase Performance Admin , Firebase Quality Admin , Firebase Admin et project Owner or Editor .

  1. Accédez à l' onglet Tableau de bord de surveillance des performances dans la console Firebase, puis sélectionnez l'application pour laquelle vous souhaitez configurer un calcul de taux de réussite.
  2. Faites défiler jusqu'au tableau des traces en bas de l'écran et sélectionnez l'onglet Demandes réseau .
  3. Recherchez le modèle d'URL pour lequel vous souhaitez configurer le calcul du taux de réussite.
  4. À l'extrême droite de la ligne, ouvrez le menu de débordement ( ) et sélectionnez Configurer le taux de réussite .
  5. Suivez les instructions à l'écran pour sélectionner les codes de réponse que vous souhaitez compter comme codes de réponse réussie.