Cette page explique comment utiliser le tableau de bord d'Insights sur les requêtes pour détecter et analyser les performances des requêtes.
Présentation d'Insights sur les requêtes
Utilisez le tableau de bord Insights sur les requêtes pour surveiller les requêtes liées aux métriques. En fonction des métriques, vous pouvez identifier les requêtes les plus fréquemment utilisées et celles présentant des latences élevées qui peuvent nécessiter une optimisation. Utilisez le tableau de bord d'Insights sur les requêtes pour :
- Optimisation des performances des requêtes : identifiez les requêtes présentant des latences élevées et qui peuvent nécessiter une optimisation.
- Gestion des coûts des requêtes : découvrez les requêtes coûteuses et optimisez-les pour réduire les coûts.
- Surveillance des statistiques de requêtes : suivez les statistiques de requêtes au fil du temps.
- Recommandations d'index : identifiez les index composites manquants ou non optimaux, et créez des index recommandés directement depuis le tableau de bord (édition Enterprise).
Données d'insights sur les requêtes
Insights sur les requêtes inclut les données des méthodes d'API suivantes :
findaggregate
Vous pouvez afficher les données sur les requêtes qui utilisent ces méthodes pour un projet, une base de données et une durée donnés, allant de 10 minutes à 30 jours. Les données des requêtes ayant des structures équivalentes sont capturées sous une seule requête normalisée.
Insights sur les requêtes renvoie les informations suivantes sur une requête :
| Texte de requête normalisé | Structure de la requête représentée sous forme de texte. |
| Nombre d'exécutions | Nombre d'exécutions au cours de la période sélectionnée. |
| Nombre d'erreurs | Nombre d'erreurs au cours de la période sélectionnée. |
| Durée d'exécution moyenne (ms) | Temps moyen (en millisecondes) nécessaire à la base de données pour traiter la requête. |
| Nombre moyen de résultats renvoyés | Nombre de résultats renvoyés par la requête. Les résultats incluent des documents, des ID de collection et des buckets agrégés. |
| Nombre moyen de documents analysés | Nombre de documents analysés dans une requête. |
| Nombre moyen d'entrées d'index analysées | Nombre d'entrées d'index examinées pour exécuter la requête. |
| Charge par temps moyen | Données permettant de filtrer les requêtes les plus fréquentes en fonction de la latence moyenne. |
| Charge par nombre total d'opérations de lecture (facturables) | Données permettant de filtrer les requêtes principales en fonction du nombre total d'opérations de lecture facturables. |
| Recommandations d'index | Index composites recommandés, index utilisés et impact estimé de la charge de travail pour les requêtes dans les bases de données Enterprise Edition. |
Précision et conservation des données
La précision des données dépend de la durée spécifiée :
- Granularité de 10 minutes pour les intervalles allant jusqu'à quatre jours auparavant
- Précision d'une heure pour les intervalles allant jusqu'à 30 jours
La durée maximale de conservation des données pour Insights sur les requêtes est de 30 jours. Les données de 10 minutes sont stockées pendant quatre jours, et les données horaires sont stockées pendant 30 jours.
Afficher les insights sur les requêtes
Console Firebase
- Pour afficher les insights sur les requêtes d'une base de données Cloud Firestore, ouvrez le volet Insights sur les requêtes de la base de données dans la console Google Cloud.
Dans la console Firebase, accédez à la page Base de données Firestore.
- Dans la liste des bases de données, sélectionnez-en une.
- Dans la liste des onglets, cliquez sur Insights sur les requêtes.
Pour trouver les requêtes les plus fréquentes en fonction de la latence ou du nombre d'opérations de lecture, cliquez sur Latence ou Opérations de lecture.
Recommandations d'index
Les recommandations d'index pour Insights sur les requêtes identifient automatiquement les configurations d'index composites manquantes ou non optimales pour les formes de requêtes fréquemment exécutées dans les bases de données Firestore Enterprise.
Dans l'édition Firestore Enterprise, les requêtes peuvent s'exécuter même sans index composites correspondants, ce qui peut entraîner des analyses de collection complètes ou des opérations de tri en mémoire lentes. Le tableau de bord Insights sur les requêtes analyse l'historique des statistiques d'exécution des requêtes et suggère des index composites ciblés pour optimiser la latence des requêtes et réduire le nombre de documents analysés facturables.
Fonctionnement des recommandations d'index
Un pipeline par lot hors connexion évalue régulièrement les requêtes les plus fréquentes de l'historique :
- Analyse de la structure des requêtes : extrait les prédicats d'égalité, de tri et de plage des requêtes fréquemment exécutées.
- Génération d'index candidats : génère des définitions d'index composites potentielles à l'aide d'heuristiques d'ordonnancement des index (Égalité > Tri > Plage).
- Évaluation de l'optimiseur : injecte des index candidats dans le modèle de coût du moteur de requête pour comparer les coûts d'exécution de la requête de référence aux plans d'exécution indexés hypothétiques.
- Classement de l'impact sur la charge de travail : classe les index recommandés en niveaux d'impact en fonction des économies totales estimées sur les coûts de la charge de travail :
- HIGH : convertit les analyses de collections complètes en recherches d'index sélectives, ce qui réduit considérablement les lectures de documents et la latence d'exécution.
- MEDIUM : élimine les opérations coûteuses telles que le tri en mémoire en fournissant des résultats d'index pré-triés.
- LOW : offre des améliorations mineures de la recherche.
Afficher et créer des index recommandés
Pour afficher les recommandations d'index et créer les index suggérés à partir de la console Firebase :Dans la console Firebase, accédez à la page Base de données Firestore.
Dans la liste des bases de données, sélectionnez une base de données de l'édition Enterprise.
Cliquez sur l'onglet Insights sur les requêtes.
Dans la table des requêtes, recherchez une forme de requête avec des recommandations, puis cliquez sur Examiner les recommandations dans la ligne ou le popover.
Dans la boîte de dialogue de recommandation d'index, examinez la définition de l'index composite, l'ordre des champs et le niveau d'impact estimé sur la charge de travail (ÉLEVÉ, MOYEN ou FAIBLE).
Cliquez sur Enregistrer. Le panneau Opérations de longue durée (LRO) s'ouvre pour suivre la progression de la création de l'index.
Une fois la compilation terminée, l'index est listé sous l'onglet Index et l'indicateur de recommandation disparaît de la ligne de la requête.
Éditions compatibles
Les recommandations d'index ne sont compatibles qu'avec les bases de données Firestore Enterprise. Les bases de données de l'édition Standard ne sont pas compatibles.
Limites
- Les données d'insights sur les requêtes sont retardées d'une à deux heures.
- Les recommandations d'index sont générées périodiquement en fonction des données de requête historiques, et non en temps réel.
- Les recommandations d'index suggèrent de nouveaux index composites. Elles ne suggèrent pas de modifier ni de supprimer des index existants.
- La création automatique d'index n'est pas prise en charge. Les index recommandés doivent être créés manuellement.
- La normalisation des requêtes remplace les valeurs littérales par des espaces réservés. Les recommandations d'index sont basées sur des modèles de requête normalisés plutôt que sur des valeurs d'exécution spécifiques.
- L'évaluation des coûts utilise des heuristiques plutôt qu'un échantillonnage de données en direct. Les index recommandés n'améliorent pas nécessairement les performances dans tous les scénarios, et la création d'un index entraîne des frais d'écriture et de stockage supplémentaires.
Tarifs
Insights sur les requêtes et les recommandations d'index n'entraînent aucuns frais supplémentaires.
Rôles requis
Pour obtenir les autorisations nécessaires pour afficher le tableau de bord Insights sur les requêtes et créer des index recommandés, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :
- Pour afficher les insights sur les requêtes : Lecteur Datastore (
roles/datastore.viewer) - Pour créer des index recommandés : Administrateur de l'index Datastore (
roles/datastore.indexAdmin) ou Propriétaire Cloud Datastore (roles/datastore.owner)
Ces rôles prédéfinis contiennent les autorisations datastore.insights.get et datastore.indexes.create.
Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.