Ce document explique comment utiliser l'API Cloud Monitoring pour obtenir des listes ou des descriptions des éléments suivants :
- Types de métriques définies par l'utilisateur et définies dans votre projet.
- Types de métriques tierces avec des données de séries temporelles dans votre projet.
Métriques générées par BindPlane
sont des exemples de métriques tierces. Métriques BindPlane
comportent le préfixe
workload.googleapis.com/3rd-party-app-name/
Pour obtenir la liste complète des métriques d'application tierces compatibles, consultez la documentation sur les sources de BindPlane. - Types de métriques intégrées fournis par Google Cloud. Ces types de métriques peuvent vous aider vous concevez vos métriques définies par l'utilisateur. Vous trouverez également des informations sur ces métriques dans la documentation, consultez la liste des métriques.
- Types de ressources surveillées disponibles pour votre projet. Vous pouvez également trouver des informations sur ces ressources dans la documentation (consultez la page Liste des ressources surveillées).
Pour exécuter les méthodes sans écrire de code, les exemples présentés dans les onglets PROTOCOLE de cette page utilisent l'explorateur d'API basé sur des formulaires. Pour en savoir plus sur cet outil, consultez la page APIs Explorer.
Pour apprendre à utiliser les méthodes des langages de programmation sélectionnés, consultez les exemples de code exécutable décrits sur cette page.
Avant de commencer
- Pour obtenir une présentation des métriques et des ressources surveillées, consultez la page Métriques, séries temporelles et ressources.
Répertorier les descripteurs de statistiques
Les descripteurs de métriques sont des schémas qui définissent les métriques. Pour trouver le détail des métriques qui vous intéressent, parcourez les descripteurs de métriques disponibles:- Métriques intégrées: vous pouvez émettre des requêtes API vers n'importe quel projet existant ou utiliser la documentation Listes de métriques.
- Métriques externes et définies par l'utilisateur: vous devez émettre la requête API à un projet dans lequel la métrique définie par l'utilisateur est définie de séries temporelles existent pour la métrique.
Pour plus d'informations sur le nommage des types de métriques, consultez la page Conventions de nommage.
Répertorier les types de métriques
Pour obtenir la liste actuelle des descripteurs de métriques, utilisez la méthode metricDescriptors.list
.
Utilisez un filtre pour limiter les types de métrique présents dans la réponse.
Pour déterminer les types de métriques à rechercher, consultez la section Types de valeurs et genres de métriques.
Protocole
Ouvrez la page de référence
metricDescriptors.list
.Dans le volet Essayer cette méthode, saisissez ce qui suit :
- name (nom) :
projects/PROJECT_ID
. RemplacezPROJECT_ID
par le ID de votre projet Google Cloud. - filter :
metric.type = starts_with("compute.googleapis.com")
- name (nom) :
Cliquez sur Exécuter.
L'exemple de réponse suivant montre certains des descripteurs de métrique récupérés:
"metricDescriptors": [ { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_bytes_count", "labels": [{...}], ... "description": "Count of incoming bytes dropped by the firewall.", "displayName": "Dropped bytes", "type": "compute.googleapis.com/firewall/dropped_bytes_count", ... }, { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [{...}], ... "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }, ... ]
La valeur type
de chaque descripteur identifie le descripteur de la métrique, par exemple
Exemple : compute.googleapis.com/firewall/dropped_packets_count
. Cette valeur est parfois aussi appelée "type de métrique" ou "nom du type de métrique".
Pour afficher la requête en tant que commande curl
, en tant que requête HTTP ou en JavaScript, cliquez sur fullscreen Plein écran dans APIs Explorer.
C#
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Si vous rencontrez des difficultés, consultez la section Dépanner les appels d'API.
Obtenir des descripteurs de métriques
Pour obtenir des informations sur un seul type de métrique, utilisez la méthode metricDescriptors.get
.
Cette méthode renvoie un descripteur de la métrique.
Pour récupérer un descripteur de métrique spécifique, vous devez fournir le nom complet de la métrique à l'API. Le nom complet est construit à partir de deux composants:
- Un préfixe composé de
projects/PROJECT_ID/metricDescriptors
. - La valeur
type
qui identifie le descripteur de la métrique, par exemplecompute.googleapis.com/firewall/dropped_packets_count
. Pour en savoir plus sur la valeurtype
, consultez l'onglet Protocole dans la section Répertorier les types de métriques.
Voici un exemple de nom complet d'une métrique:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Protocole
Pour obtenir le descripteur de l'instance /firewall/dropped_packets_count
Compute Engine,
, procédez comme suit:
Ouvrez la page de référence
metricDescriptors.list
.Dans le volet Essayer cette méthode, saisissez ce qui suit :
name :
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Remplacez
PROJECT_ID
par l'ID de votre projet Google Cloud.
Cliquez sur Exécuter.
L'exemple de réponse ci-dessous affiche le descripteur de la métrique :
{ "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [ { "key": "instance_name", "description": "The name of the VM instance." } ], "metricKind": "DELTA", "valueType": "INT64", "unit": "1", "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }
Pour afficher la requête sous la forme d'une commande curl
,
ou en JavaScript, cliquez sur fullscreen Plein écran
dans APIs Explorer.
C#
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Si vous rencontrez des difficultés, consultez la section Dépanner les appels d'API.
Répertorier les ressources surveillées
Les ressources surveillées sont des entités cloud pouvant être surveillées. Pour rechercher les genres d'entités disposant de métriques, parcourez la liste des types de ressources surveillées.
Pour obtenir des informations sur les ressources surveillées, vous pouvez envoyer des requêtes API à un projet existant ou utiliser la documentation sur la liste des ressources surveillées.
Répertorier les types de ressources
Pour obtenir la liste actuelle des types de ressources surveillées à partir de l'API Monitoring, utilisez la méthode monitoredResourceDescriptors.list
et indiquez l'ID de votre projet.
Protocole
Ouvrez le
monitoredResourceDescriptors.list
la page de référence.Dans le volet intitulé Try this method (Essayer cette méthode), saisissez la commande suivante:
- name (nom) :
projects/PROJECT_ID
. RemplacezPROJECT_ID
par l'ID de votre projet Google Cloud.
- name (nom) :
Cliquez sur Exécuter.
L'exemple de réponse ci-dessous répertorie certains types de ressources surveillées :
{ "resourceDescriptors": [ { "type": "aiplatform.googleapis.com/Endpoint", "displayName": "AI Platform Endpoint", "description": "A Cloud AI Platform API Endpoint where Models are deployed into it.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Endpoint", }, { "type": "aiplatform.googleapis.com/Featurestore", "displayName": "AI Platform Feature Store", "description": "A Cloud AI Platform Feature Store.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Featurestore", },
Pour afficher la requête sous la forme d'une commande curl
,
ou en JavaScript, cliquez sur fullscreen Plein écran
dans APIs Explorer.
C#
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Si vous rencontrez des difficultés, consultez la section Dépanner les appels d'API.
Obtenir des descripteurs de ressources
Pour obtenir un descripteur de ressource surveillée spécifique, utilisez la fonction
monitoredResourceDescriptors.get
.
Pour récupérer un descripteur de ressource surveillée spécifique, vous devez fournir le nom complet du descripteur à l'API. Le nom complet est construit à partir de deux composants:
- Un préfixe composé de
projects/PROJECT_ID/monitoredResourceDescriptors
. - La valeur
type
qui identifie le descripteur de la ressource surveillée, par exemplegce_instance
. Pour en savoir plus sur la valeurtype
, consultez l'onglet Protocole dans la section Répertorier les types de ressources.
Voici un exemple de nom complet d'une ressource surveillée:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Protocole
Pour obtenir le descripteur du type de ressource gce_instance
, procédez comme suit:
Ouvrez le
monitoredResourceDescriptors.get
la page de référence.Dans le volet intitulé Try this method (Essayer cette méthode), saisissez la commande suivante:
name :
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Remplacez
PROJECT_ID
par l'ID de votre projet Google Cloud.
Cliquez sur Exécuter.
L'exemple de réponse suivant affiche le descripteur de cette ressource surveillée :
{ "type": "gce_instance", "displayName": "VM Instance", "description": "A virtual machine instance hosted in Compute Engine.", "labels": [ { "key": "project_id", "description": "The identifier of the Google Cloud project associated with this resource, such as \"my-project\"." }, { "key": "instance_id", "description": "The numeric VM instance identifier assigned by Compute Engine." }, { "key": "zone", "description": "The Compute Engine zone in which the VM is running." } ], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance" }
Pour afficher la requête sous la forme d'une commande curl
,
ou en JavaScript, cliquez sur fullscreen Plein écran
dans APIs Explorer.
C#
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Pour vous authentifier auprès de Monitoring, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Si vous rencontrez des difficultés, consultez la section Dépanner les appels d'API.
Étape suivante
- Pour en savoir plus sur l'utilisation de l'API Cloud Monitoring pour lire des séries temporelles consultez la page Récupérer des données de séries temporelles.
- Pour obtenir la liste des types de ressources surveillées disponibles avec définies par l'utilisateur, consultez Choisir un type de ressource surveillée.