Utiliser des métriques de quota d'API simplifiées dans Cloud Monitoring

Ce document explique comment utiliser les métriques de quota d'API Compute Engine simplifiées dans vos tableaux de bord, règles d'alerte et requêtes Cloud Monitoring.

Métriques de quota d'API simplifiées

Pour améliorer la visibilité et la gérabilité du quota d'API Compute Engine quota, Google Cloud a réduit le nombre de métriques de quota en les regroupant dans un nombre plus restreint de groupes de quotas. Ces métriques de quota simplifiées offrent également des limites plus élevées pour chaque groupe de quotas.

Métriques de quota d'API héritées et simplifiées

Le tableau suivant répertorie les métriques de quota d'API héritées et leurs métriques équivalentes simplifiées :

Métriques de quota d'API héritées Métriques de quota d'API simplifiées
compute.googleapis.com/list_requests compute.googleapis.com/global_reads
Requêtes de lecture par minute
compute.googleapis.com/read_requests
compute.googleapis.com/heavy_weight_read_requests
compute.googleapis.com/default
Métrique de quota héritée pour les méthodes qui listent les ressources Compute Engine.
compute.googleapis.com/get_macsec_config_requests
compute.googleapis.com/license_verification_requests
compute.googleapis.com/default
Métrique de quota héritée pour les méthodes globales qui créent, modifient ou suppriment des ressources Compute Engine.
compute.googleapis.com/global_writes
Requêtes de mutation par minute
compute.googleapis.com/global_resource_write_requests
compute.googleapis.com/heavy_weight_write_requests
compute.googleapis.com/regional_v2_public_advertised_prefixes_delete_requests
compute.googleapis.com/regional_v2_public_advertised_prefixes_create_requests
compute.googleapis.com/address_move_requests
compute.googleapis.com/project_set_common_instance_metadata_requests
compute.googleapis.com/regional_v2_public_advertised_prefixes_announce_requests
compute.googleapis.com/license_insert_requests
compute.googleapis.com/heavy_weight_read_requests_per_region compute.googleapis.com/reads_per_region
Requêtes de lecture par minute et par région
compute.googleapis.com/read_requests_per_region
compute.googleapis.com/list_requests_per_region
compute.googleapis.com/default_per_region
Métrique de quota héritée pour les méthodes régionales et zonales qui listent les ressources Compute Engine.
compute.googleapis.com/license_verification_requests_per_region
compute.googleapis.com/instance_list_referrers_requests_per_region
compute.googleapis.com/operation_read_requests_per_region
compute.googleapis.com/network_endpoint_list_requests_per_region
compute.googleapis.com/regional_network_endpoint_list_requests_per_region
compute.googleapis.com/get_serial_port_output_requests_per_region
compute.googleapis.com/read_requests
compute.googleapis.com/heavy_weight_write_requests_per_region compute.googleapis.com/writes_per_region
Requêtes de mutation par minute et par région
compute.googleapis.com/default_per_region
Métrique de quota héritée pour les méthodes régionales et zonales qui créent, modifient ou suppriment des ressources Compute Engine.
compute.googleapis.com/global_resource_write_requests_per_region
compute.googleapis.com/network_endpoint_write_requests_per_region
compute.googleapis.com/regional_network_endpoint_write_requests_per_region
compute.googleapis.com/regional_public_delegated_prefixes_create_requests_per_region
compute.googleapis.com/address_move_requests_per_region
compute.googleapis.com/simulate_maintenance_event_requests_per_region
compute.googleapis.com/regional_public_delegated_prefixes_delete_requests_per_region
compute.googleapis.com/regional_public_delegated_prefixes_announce_requests_per_region
compute.googleapis.com/recommend_locations_requests_per_region compute.googleapis.com/recommend_locations_per_region
Requêtes RegionInstances RecommendLocations par minute et par région
compute.googleapis.com/cache_invalidation_requests compute.googleapis.com/global_cache_invalidation_requests
Requêtes d'invalidation de cache par minute

Utiliser les métriques simplifiées dans les tableaux de bord Cloud Monitoring

Pour surveiller l'utilisation de l'API Compute Engine par rapport aux métriques d'API simplifiées, ajoutez des filtres pour ces métriques dans vos tableaux de bord, alertes et requêtes Cloud Monitoring.

Créer un tableau de bord qui utilise des métriques de quota d'API simplifiées

Pour créer un tableau de bord qui utilise des métriques simplifiées, procédez comme suit :

  1. Dans la Google Cloud console, accédez à Monitoring :

    Accéder à Monitoring

  2. Dans le volet de navigation, sélectionnez Tableaux de bord.

  3. Cliquez sur Créer un tableau de bord personnalisé.

  4. Dans la barre d'outils du tableau de bord, cliquez sur Ajouter un widget et sélectionnez un type de widget (par exemple, Graphique en courbes). La page Configurer le widget s'ouvre.

  5. Dans la section Sélectionner une métrique, procédez comme suit :

    1. Sélectionnez Quota du client pour la ressource.
    2. Sélectionnez Quota pour la catégorie de métriques.
    3. Sélectionnez Utilisation du quota de débit pour la métrique, puis cliquez sur Appliquer.
  6. Dans la section Ajouter un filtre, utilisez le filtre quota_metric et sélectionnez la métrique de quota d'API simplifiée correspondante. Pour trouver la métrique simplifiée, consultez Métriques de quota d'API héritées et simplifiées.

  7. Cliquez sur Appliquer pour ajouter le widget au tableau de bord.

  8. Dans la barre d'outils, cliquez sur Enregistrer pour enregistrer le tableau de bord.

Modifier un tableau de bord qui utilise une métrique de quota héritée

Pour mettre à jour un tableau de bord contenant une métrique héritée, procédez comme suit :

  1. Dans la Google Cloud console, accédez à Monitoring :

    Accéder à Monitoring

  2. Dans le volet de navigation, sélectionnez Tableaux de bord.

  3. Ouvrez le tableau de bord contenant le graphique à mettre à jour.

  4. Cliquez sur Modifier.

  5. Recherchez le widget que vous souhaitez modifier, puis modifiez-le.

  6. Dans la section Sélectionner une métrique, mettez à jour le filtre contenant la métrique héritée :

    1. Dans le champ Filtre, sélectionnez quota_metric.
    2. Dans le champ Valeur, remplacez la valeur actuelle par la métrique de quota d'API simplifiée correspondante. Pour trouver le remplacement de votre métrique héritée, consultez Métriques de quota d'API héritées et simplifiées. Par exemple, remplacez compute.googleapis.com/read_requests par compute.googleapis.com/global_reads.
  7. Pour appliquer vos modifications, cliquez sur Appliquer.

Utiliser les métriques de quota d'API simplifiées dans les règles d'alerte Cloud Monitoring

Pour surveiller l'utilisation de l'API Compute Engine par rapport aux métriques d'API simplifiées, ajoutez des filtres pour ces métriques dans vos règles d'alerte Cloud Monitoring.

Créer une règle d'alerte qui utilise des métriques de quota d'API simplifiées

Pour créer une règle d'alerte qui utilise des métriques simplifiées, procédez comme suit :

  1. Dans la Google Cloud console, accédez à Monitoring :

    Accéder à Monitoring

  2. Dans le volet de navigation, sélectionnez Alertes.

  3. Cliquez sur Créer une règle.

  4. Dans la section Sélectionner une métrique, procédez comme suit :

    1. Sélectionnez Quota du client pour la ressource.
    2. Sélectionnez Quota pour la catégorie de métriques.
    3. Sélectionnez Utilisation du quota de débit pour la métrique, puis cliquez sur Appliquer.
  5. Dans la section Ajouter un filtre, utilisez le filtre quota_metric et sélectionnez la métrique de quota d'API simplifiée correspondante. Pour trouver la métrique simplifiée, consultez Métriques de quota d'API héritées et simplifiées.

  6. Configurez la condition, les canaux de notification et la documentation selon vos besoins.

  7. Cliquez sur Enregistrer la règle.

Vous pouvez également utiliser le Google Cloud fournisseur Terraform pour créer des règles d'alerte dans votre Google Cloud projet. Pour en savoir plus, consultez Créer des règles d'alerte avec Terraform.

Modifier une règle d'alerte qui utilise une métrique de quota héritée

Pour mettre à jour une règle d'alerte existante qui utilise une métrique de quota héritée, procédez comme suit :

  1. Dans la Google Cloud console, accédez à Monitoring :

    Accéder à Monitoring

  2. Dans le volet de navigation, sélectionnez Alertes. La page "Alertes" affiche des volets répertoriant les informations récapitulatives, les incidents et les règles d'alerte.

  3. Pour modifier une règle existante, cliquez sur son nom sous Règles.

  4. Dans la section Sélectionner une métrique, mettez à jour le filtre contenant la métrique héritée :

    1. Dans le champ Filtre, sélectionnez quota_metric.
    2. Dans le champ Valeur, remplacez la valeur par la métrique de quota d'API simplifiée correspondante. Pour trouver le remplacement de votre métrique héritée, consultez Métriques de quota d'API héritées et simplifiées. Par exemple, remplacez compute.googleapis.com/read_requests par compute.googleapis.com/global_reads.
  5. Cliquez sur OK pour enregistrer les modifications apportées au filtre.

  6. Cliquez sur Enregistrer la règle.

Utiliser des métriques de quota simplifiées dans les requêtes Cloud Monitoring

Pour mettre à jour une règle d'alerte basée sur PromQL ou un graphique dans un tableau de bord, utilisez l'éditeur de requête et modifiez le filtre de requête. Pour en savoir plus, consultez Utiliser l'éditeur de code pour PromQL.

Pour mettre à jour votre requête, remplacez le nom de la métrique héritée dans le filtre quota_metric par le nom de la métrique simplifiée correspondante.

Exemple 1 :

Requête qui utilise une métrique héritée :

rate(serviceruntime_googleapis_com:quota_rate_net_usage{monitored_resource="consumer_quota", \
quota_metric=~"compute.googleapis.com/read_requests"}[1m])

Requête modifiée à l'aide d'une métrique simplifiée :

rate(serviceruntime_googleapis_com:quota_rate_net_usage{monitored_resource="consumer_quota", \
quota_metric=~"compute.googleapis.com/global_reads"}[1m])

Exemple 2 :

Requête qui utilise une métrique héritée :

rate(serviceruntime_googleapis_com:quota_rate_net_usage{monitored_resource="consumer_quota", \
quota_metric=~"compute.googleapis.com/heavy_weight_write_requests_per_region"}[1m])

Requête modifiée à l'aide d'une métrique simplifiée :

rate(serviceruntime_googleapis_com:quota_rate_net_usage{monitored_resource="consumer_quota", \
quota_metric=~"compute.googleapis.com/writes_per_region"}[1m])