Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Présentation de Key Visualizer

Cette page présente une vue d'ensemble de l'outil de diagnostic Key Visualizer pour Firestore.

Qu'est-ce que Key Visualizer ?

Key Visualizer est un outil qui permet d'analyser vos habitudes d'utilisation de Firestore. Il génère des rapports visuels qui détaillent votre utilisation en fonction des documents auxquels vous accédez.

Key Visualizer fournit des informations sur les modes d'utilisation à grande échelle. Les utilisations de Key Visualizer incluent :

  • La résolution des problèmes liés aux performances Key Visualizer vous aide à identifier les problèmes de performances de votre base de données dus à des hotspots de clés de documents séquentielles ou à des augmentations soudaines du trafic.
  • Une meilleure compréhension des moyens d'accéder aux données stockées dans Firestore
  • La conception itérative d'un modèle de données ou l'amélioration de la conception d'un modèle de données existant. À chaque itération, vous pouvez vérifier Key Visualizer pour détecter les problèmes liés à votre modèle de données.

Pour atteindre ces objectifs, Key Visualizer peut vous aider à effectuer les tâches suivantes :

  • Vérifiez si vos lectures ou écritures créent des hotspots sur des plages de documents spécifiques.
  • Découvrez comment une augmentation soudaine du trafic affecte la latence.
  • Vérifiez si vos modèles d'accès sont équilibrés au sein de votre base de données.

Critères d'éligibilité pour l'analyse

Chaque analyse Key Visualizer porte sur une période de deux heures. Une analyse pour une période donnée est disponible pour les bases de données dont le trafic dépasse 3000 opérations de document par minute dans cette période.

Les critères d'éligibilité pour l'analyse dépendent entièrement de l'activité de la base de données. Elle ne dépend pas de la quantité de données ni du type de données figurant dans votre base de données.

Analyses de Key Visualizer

L'image suivante montre une analyse de Key Visualizer. Chaque analyse comprend une carte de densité qui affiche les modèles d'accès ou les métriques de performances d'un groupe de clés de document au fil du temps.

Exemple d'analyse de Key Visualizer

Partager les URL d'analyse

Vous pouvez partager ou ajouter aux favoris l'URL d'une analyse Key Visualizer. L'URL ouvre la même analyse Key Visualizer et sélectionne la même métrique. Cette URL est valide jusqu'à l'expiration de la durée d'analyse.

Cartes de densité

La carte de densité constitue le cœur d'une analyse Key Visualizer. Elle représente la valeur d’une métrique dans le temps, ventilée jusqu'à 1000 buckets de clés contigus. L'axe des abscisses de la carte représente la période et l'axe des ordonnées les clés de document. Chaque analyse Key Visualizer pour Firestore couvre deux heures d'activité divisées en segments de 10 secondes.

Une valeur faible d'une métrique est considérée comme "froide" et apparaît en couleur sombre. Une valeur élevée est considérée comme "chaude" et apparaît sous la forme d'une couleur vive. Les valeurs les plus élevées apparaissent en blanc.

Sur la carte de densité, différents types d'utilisation génèrent des modèles visuels différents, ce qui permet de diagnostiquer les problèmes en un coup d'œil. Consultez la section Modèles de cartes de densité pour des exemples courants.

Key Visualizer fournit des outils pour vous aider à comprendre les données de chaque analyse. Consultez les pages Premiers pas avec Key Visualizer et Explorer les cartes de densité.

Buckets clés

Key Visualizer divise toutes les clés de votre base de données en jusqu'à 1000 plages contiguës, avec à peu près le même nombre de clés dans chaque plage. Ces plages sont appelées des buckets de clés.

Dans chaque bucket de clés, Key Visualizer enregistre la plupart des métriques en tant que moyennes ou en tant que valeurs maximales.

Métriques

Les métriques suivantes sont disponibles dans les analyses Key Visualizer pour Firestore :

Métriques Description
Données d'activités
Opérations par seconde Nombre moyen d'opérations de documents par seconde. Environ égal à la somme des écritures, des recherches et des requêtes par seconde. Cette métrique peut indiquer quelles clés sont actives.
Opérations d'écriture par seconde Nombre moyen d'opérations de documents par seconde pour les écritures et les suppressions.
Opérations de recherche par seconde Nombre moyen d'opérations de documents par seconde pour les recherches.
Opérations de requête par seconde Nombre moyen d'opérations de documents par seconde pour les requêtes.
Statistiques relatives aux performances
Latence d'écriture moyenne Latence moyenne d'écriture et de suppression pour les données traitées dans le bucket.
Latence de recherche moyenne Latence moyenne des recherches effectuées pour les données traitées dans le bucket.
Latence moyenne des requêtes Latence moyenne des requêtes effectuées pour les données traitées dans le bucket.
Latence de queue d'écriture Latence d'écriture ou de suppression maximale observée pour les données traitées dans le bucket.
Latence de queue de recherche Latence de recherche maximale constatée pour les données traitées dans le bucket.
Latence de queue de requête Latence observée maximale des requêtes pour les données traitées dans le bucket.

Moyennes de performances

Les métriques de latence moyenne utilisent une moyenne des clés du bucket de clés. Cette mesure étant effectuée au niveau de la couche de stockage, la latence signalée ici peut être inférieure à la latence totale observée par un appel d'API.

Limites

Bien que Key Visualizer présente différentes métriques, celles susceptibles d'affecter les performances de Firestore ne sont pas toutes affichées. Exemple :

  • Les problèmes réseau entre votre application et Google Cloud peuvent ne pas être visibles. Ils peuvent apparaître sous forme de bandes verticales sur toutes les clés dans Key Visualizer, ce qui vous donne uniquement des indications sur le moment où les problèmes se sont produits.

  • Les problèmes de performances causés par les index peuvent ne pas être visibles. Aucune métrique ne mesure directement les performances des opérations d'écriture d'index. Cependant, les index affectent les métriques de latence.

Durée de vie des données

Les données collectées par Key Visualizer pour Firestore sont supprimées au bout de 14 jours.

Les données Key Visualizer sont disponibles pour les 14 derniers jours. Par exemple, si vous lancez Key Visualizer le 19 décembre à 12h45, l'heure de début la plus ancienne que vous pouvez choisir est le 5 décembre à 13h00.

Cette limite signifie également que, si vous partagez ou ajoutez à vos favoris l'URL d'une analyse Key Visualizer, celle-ci a une durée de vie maximale de 14 jours.

Étapes suivantes