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

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

Toutefois, vous devez parfois personnaliser la façon dont Firebase agrège des données de requête réseau spécifiques pour mieux répondre aux cas d'utilisation de votre application. Nous vous proposons deux façons de personnaliser l'agrégation des données pour les requêtes réseau : agréger les données selon des formats d'URL personnalisés et personnaliser le calcul du taux de réussite.

Agréger les données selon des formats d'URL personnalisés

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

Vous pouvez créer des formats d'URL personnalisés pour surveiller des formats d'URL spécifiques que Firebase ne capture pas avec sa mise en correspondance automatique des formats d'URL dérivée. Par exemple, vous pouvez utiliser un format d'URL personnalisé pour résoudre les problèmes d'une URL spécifique ou pour surveiller un ensemble d'URL spécifique au fil du temps.

Firebase affiche tous les formats d'URL (y compris les formats d'URL personnalisés) et leurs données globales dans le sous-onglet Requêtes réseau du tableau des traces, qui se trouve en bas du tableau de bord Performances de la console Firebase.

Comment fonctionne la mise en correspondance de formats d'URL personnalisés ?

Firebase tente de faire correspondre les URL de requête à tous les formats d'URL personnalisés configurés avant de revenir à la mise en correspondance automatique des formats d'URL. Pour toutes les requêtes correspondant à un format d'URL personnalisé, Firebase agrège les données des requêtes sous le format d'URL personnalisé.

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

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

Toutefois, le format example.com/books/* est le format d'URL correspondant le plus spécifique, car le segment le plus à gauche books dans example.com/books/* est prioritaire sur le segment le plus à gauche * dans example.com/*/dog.

Lorsque vous créez un format d'URL personnalisé, tenez compte des points suivants :

• La création d'un format d'URL personnalisé n'affecte pas les correspondances et les données agrégées des requêtes précédentes. Firebase ne réagrège pas rétroactivement les données de requête.

• La création d'un format d'URL personnalisé n'affecte que les futures requêtes. Vous devrez peut-être attendre jusqu'à 12 heures pour que Performance Monitoring collecte et agrège les données sous un nouveau format d'URL personnalisée.

Créer un format d'URL personnalisé

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

Un membre du projet doit être propriétaire ou éditeur pour créer un format d'URL personnalisé. Toutefois, tous les membres du projet peuvent afficher les formats d'URL personnalisés et leurs données agrégées.

Vous pouvez créer jusqu'à 400 formats d'URL personnalisés par application et jusqu'à 100 formats d'URL personnalisés par domaine pour cette application.

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

• Texte brut : correspond à une chaîne exacte.
• * : correspond au premier segment de sous-domaine ou à n'importe quelle chaîne d'un seul segment de chemin d'accès.
• ** : correspond à un suffixe de chemin d'accès arbitraire.

Le tableau suivant décrit quelques correspondances de formats d'URL personnalisées possibles.

Pour faire correspondre...	Créer un format d'URL personnalisé, par exemple…	Exemples de correspondances avec ce format d'URL
Une URL exacte	example.com/foo/baz	example.com/foo/baz
Un segment de chemin (*)	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 format ne correspond pas à example.com/foo.
Un suffixe de chemin d'accès 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 du sous-domaine (*)	*.example.com/foo	bar.example.com/foo baz.example.com/foo

Remarque : Pour les formats d'URL personnalisés, Firebase n'est pas compatible avec la syntaxe de *.file-extension, comme *.png ou *.css.

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

Firebase affiche tous les formats d'URL (y compris les formats d'URL personnalisés) et leurs données globales dans le sous-onglet Requêtes réseau du tableau des traces, qui se trouve en bas du tableau de bord Performances de la console Firebase.

Pour n'afficher que les formats d'URL personnalisés, sélectionnez Formats personnalisés dans le menu déroulant du sous-onglet Requêtes réseau du tableau des traces. Notez que si un format d'URL personnalisé ne comporte aucune donnée globale, il n'apparaît que dans cette liste.

Lorsque la durée de conservation des données se termine pour les données agrégées sous un format d'URL, Firebase supprime ces données du format d'URL. Si toutes les données agrégées sous un format d'URL personnalisé expirent, Firebase ne supprime pas le format d'URL personnalisé de la console Firebase. Au lieu de cela, Firebase continue de lister les formats d'URL personnalisés "vides" dans la liste Formats personnalisés du sous-onglet Requêtes réseau du tableau des traces.

Supprimer un format d'URL personnalisé

Vous pouvez supprimer des formats d'URL personnalisés de votre projet. Notez que vous ne pouvez pas supprimer un format d'URL automatique.

1. Dans le tableau de bord Performances, faites défiler la page 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 Requêtes réseau.

3. Pointez sur la ligne du format d'URL personnalisé que vous souhaitez supprimer.

4. Cliquez sur tout à droite de la ligne, sélectionnez Supprimer le motif personnalisé, puis confirmez la suppression dans la boîte de dialogue.

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

• Toutes les requêtes futures sont mappées au format d'URL personnalisée correspondant le plus spécifique suivant. Si Firebase ne trouve aucun format d'URL personnalisé correspondant, il utilise la mise en correspondance automatique de formats 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 format d'URL personnalisé.

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

• Le sous-onglet Requêtes réseau (avec l'option Formats personnalisés sélectionnée) ne liste aucun format d'URL personnalisé supprimé.

Étapes suivantes

• 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 d'un format d'URL spécifique dépasse un seuil que vous avez défini.

Personnaliser le calcul du taux de réussite

L'une des métriques surveillées par Firebase pour chaque requête réseau est le taux de réussite de la requête. Le taux de réussite correspond au pourcentage de réponses positives par rapport au nombre total de réponses. Cette métrique vous aide à mesurer les défaillances du réseau et du serveur.

Plus précisément, Firebase comptabilise automatiquement les requêtes réseau dont le code de réponse est compris entre 100 et 399 comme des réponses réussies.

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

Par exemple, si votre application dispose d'une API de point de terminaison de recherche, vous pouvez comptabiliser les réponses 404 comme "réussies", car les réponses 404 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 soient des réponses 200 et 40 des réponses 404. Avant de configurer le taux de réussite, celui-ci sera de 60 %. Après avoir configuré le calcul du taux de réussite pour comptabiliser les réponses 404 comme des réussites, le taux de réussite sera de 100 %.

Remarque : Les nouvelles configurations de taux de réussite ne s'appliquent qu'aux données collectées après la création de la configuration.

Configurer le calcul du taux de réussite

Pour configurer le calcul du taux de réussite d'un format d'URL réseau, vous devez disposer de l'autorisation firebaseperformance.config.update. Les rôles suivants incluent cette autorisation requise par défaut : Administrateur Firebase Performance, Administrateur de qualité Firebase, Administrateur Firebase et Propriétaire ou Éditeur du projet.

1. Accédez à l'onglet Tableau de bord de Performance Monitoring dans la console Firebase, puis sélectionnez l'application pour laquelle vous souhaitez configurer un calcul du taux de réussite.
2. Faites défiler l'écran jusqu'au tableau des traces en bas de l'écran, puis sélectionnez l'onglet Requêtes réseau.
3. Recherchez le format 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 à développer () 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 comptabiliser comme codes de réponse réussis.

Remarque : Vous pouvez configurer le taux de réussite pour les formats d'URL automatiques et les URL personnalisées. Nous vous recommandons de ne configurer le taux de réussite que pour les formats d'URL personnalisés, car les formats d'URL automatiques peuvent changer au fil du temps en fonction de l'évolution de vos données.