Surveiller l'utilisation

Cette page explique comment surveiller votre utilisation de Firestore et identifier les problèmes potentiels dans votre application. La surveillance de l'utilisation de votre application peut également vous permettre de savoir à quoi vous attendre pour votre facture. De plus, si vous avez l'impression qu'il y a un problème, avoir une vision claire des opérations de votre base de données peut être un outil de dépannage utile.

Tableau de bord sur l'utilisation

Google Cloud Console et la console Firebase incluent un tableau de bord d'utilisation Firestore qui affiche les lectures, les écritures et les suppressions de documents au fil du temps.

Cloud Console

Accéder à la page d'utilisation de Firestore (Cloud Console)

Le tableau de bord d'utilisation Firestore dans Cloud Console

Contrôle des accès

Le tableau de bord d'utilisation nécessite l'autorisation Cloud IAM monitoring.timeSeries.list. Les rôles "Propriétaire", "Éditeur" et "Lecteur" accordent cette autorisation. Vous pouvez également accorder cette autorisation via un rôle Cloud Monitoring ou un rôle personnalisé.

Console Firebase

Accéder à la page d'utilisation de Firestore (console Firebase)

Le tableau de bord d'utilisation de Firestore dans la console Firebase.

Utilisation des règles de sécurité

En outre, la console Firebase fournit un tableau de bord d'évaluation des règles de sécurité, une vue d'ensemble utile des appels de règles. Vous pouvez compléter ce tableau de bord par une analyse détaillée dans Cloud Monitoring.

Accéder à la page Règles

Tableau de bord de surveillance des règles Firestore dans la console Firebase

Quotas quotidiens

La page Quotas d'App Engine de Cloud Console permet de suivre les informations d'utilisation quotidiennes de Firestore : lectures, écritures, écritures d'index, suppressions, données stockées et sortie réseau.

Accéder à la page Quotas

Utilisation de Firestore sur la page Quotas d'App Engine.

Cloud Monitoring

Cloud Monitoring collecte des métriques, des événements et des métadonnées provenant des produits Google Cloud. Le tableau de bord d'utilisation de la console Firestore fournit les mêmes métriques. Pour configurer des tableaux de bord personnalisés et des alertes d'utilisation, utilisez Cloud Monitoring.

Cloud Monitoring inclut les métriques Firestore suivantes :

Nom de la métrique Description
Lectures de documents

Nombre de lectures de documents réussies. Vous pouvez décomposer cette métrique par type de lecture : RECHERCHE ou REQUÊTE.

Cette métrique n'inclut pas les lectures provenant des opérations d'exportation gérées.

Écritures de documents

Nombre d'écritures de documents réussies. Vous pouvez décomposer cette métrique par type d'écriture : CRÉATION ou MISE À JOUR.

Cette métrique n'inclut pas les écritures provenant des opérations d'importation gérées.

Suppressions de documents Nombre de suppressions de documents réussies.
Connexions actives

Nombre de connexions actives à votre base de données.

Chaque SDK mobile et Web actif conserve une connexion unique, qui peut être partagée entre plusieurs écouteurs d'instantanés. Les bibliothèques clientes du serveur créent une connexion par écouteur d'instantanés.

Écouteurs d'instantanés

Nombre d'écouteurs d'instantanés sur l'ensemble des connexions actives.

Évaluations des règles

Nombre d'évaluation de règles Firestore effectuées en réponse à des requêtes d'écriture ou de lecture. Vous pouvez décomposer cette métrique par résultat de la requête (AUTORISER, REFUSER ou ERREUR).

Utilisation des mises à jour en temps réel

Utilisez les métriques relatives aux connexions actives et aux écouteurs d'instantanés pour mesurer votre utilisation des mises à jour en temps réel.

Supposons qu'un utilisateur ouvre votre application sur son téléphone. L'application se connecte ensuite à Firestore et s'abonne à 10 requêtes. Ainsi, vos métriques augmentent d'une connexion active et de 10 écouteurs d'instantanés.

Taux d'échantillonnage

Les métriques Firestore sont échantillonnées toutes les minutes, mais les mises à jour peuvent mettre jusqu'à quatre minutes à s'afficher dans vos tableaux de bord.

À l'aide de ces métriques, vous pouvez configurer un tableau de bord Firestore comme suit :

Utilisation de Firestore dans un tableau de bord Cloud Monitoring

Effectuez les étapes ci-dessous pour commencer à surveiller Firestore avec Cloud Monitoring.

Créer un espace de travail Cloud Monitoring

Pour surveiller Firestore avec Cloud Monitoring, vous devez configurer un espace de travail pour votre projet. Un espace de travail organise les informations de surveillance d'un ou de plusieurs projets. Après avoir configuré un espace de travail, vous pouvez créer des tableaux de bord et des règles d'alerte personnalisés.

  1. Ouvrir la page Cloud Monitoring

    Si votre projet fait déjà partie d'un espace de travail, la page Cloud Monitoring s'ouvre. Sinon, sélectionnez un espace de travail pour votre projet.

  2. Sélectionnez l'option Nouvel espace de travail ou sélectionnez un espace de travail existant.

  3. Cliquez sur Ajouter. Une fois votre espace de travail créé, la page Cloud Monitoring s'ouvre.

Créer un tableau de bord et ajouter un graphique

Affichez les métriques Firestore recueillies par Cloud Monitoring dans vos propres graphiques et tableaux de bord.

Avant de continuer, assurez-vous que votre projet fait partie d'un espace de travail Cloud Monitoring.

  1. Sur la page Cloud Monitoring, ouvrez votre espace de travail et accédez à la page Tableaux de bord.

    Accéder à la page Tableaux de bord

  2. Cliquez sur Créer un tableau de bord et entrez un nom.

  3. Dans le coin supérieur droit, cliquez sur Ajouter un graphique.

  4. Dans la fenêtre Ajouter un graphique, entrez un titre pour le graphique. Cliquez sur l'onglet Metric (Métrique).

  5. Dans le champ Find resource type and metric (Rechercher un type de ressource et une métrique), saisissez Firestore. Dans la liste déroulante renseignée automatiquement, sélectionnez l'une des métriques Firestore.

  6. Pour ajouter des métriques au même graphique, cliquez sur Add Metric (Ajouter une métrique), puis répétez l'étape précédente.

  7. Si vous le souhaitez, vous pouvez personnaliser votre graphique. Par exemple, dans le champ Filter (Filtre), cliquez sur + Add a filter (Ajouter un filtre). Faites défiler la page vers le bas, puis sélectionnez une valeur ou une plage pour la métrique sur laquelle vous souhaitez filtrer le graphique.

  8. Cliquez sur Enregistrer.

Pour en savoir plus sur les graphiques Cloud Monitoring, consultez la page Travailler avec des graphiques.

Créer une règle d'alerte

Vous pouvez créer une règle d'alerte basée sur les métriques Firestore. Suivez les étapes ci-dessous pour créer une règle d'alerte qui vous envoie un e-mail lorsqu'une métrique Firestore spécifique atteint un certain seuil.

Avant de continuer, assurez-vous que votre projet fait partie d'un espace de travail Cloud Monitoring.

  1. Sur la page Cloud Monitoring, ouvrez votre espace de travail et accédez à la page Alertes.

    Accéder à la page "Créer une règle d'alerte"

  2. Cliquez sur Créer une stratégie.

  3. Saisissez un nom pour votre règle d'alerte.

  4. Ajoutez une condition d'alerte basée sur l'une des métriques Firestore. Cliquez sur Ajouter une condition.

  5. Sélectionnez une cible. Dans le champ Find resource type and metric (Rechercher un type de ressource et une métrique), saisissez Firestore. Dans la liste déroulante renseignée automatiquement, sélectionnez l'une des métriques Firestore.

  6. Dans la section Déclencheurs de règle, utilisez les champs de la liste déroulante pour définir votre condition d'alerte.

  7. Ajoutez un canal de notification à votre règle d'alerte. Dans la section Notifications, cliquez sur Ajouter un canal de notification. Sélectionnez E-mail dans le menu déroulant.

  8. Saisissez votre adresse e-mail dans le champ Email address. Cliquez sur Ajouter.

  9. Vous pouvez également renseigner le champ de documentation pour inclure des informations supplémentaires dans votre notification par e-mail.

  10. Cliquez sur Enregistrer.

Si votre utilisation de Firestore dépasse le seuil configuré, vous recevrez une alerte par e-mail : Exemple d'e-mail d'alerte Firestore.

Pour plus d'informations sur les règles d'alerte, consultez la page Présentation des alertes.

Étapes suivantes