Présentation de l'API Cloud Monitoring

Cette page décrit certaines des fonctionnalités de l'API Cloud Monitoring v3.

Pour obtenir la documentation de référence de l'API, consultez l'une des pages suivantes :

Noms de projets dans l'API Monitoring

Toutes les méthodes de l'API Monitoring ont un paramètre name obligatoire. Ce paramètre a généralement une description semblable à celle-ci :

Obligatoire. Projet sur lequel exécuter la requête. Il a le format suivant :
.projects/[PROJECT_ID_OR_NUMBER]

Dans l'API Monitoring, la valeur de PROJECT_ID_OR_NUMBER identifie l'un des éléments suivants:

Certaines méthodes d'API Monitoring nécessitent que le projet soit un projet de définition de champ d'application de métriques, ce qui n'est pas le cas des autres méthodes. Un petit nombre de méthodes peut renvoyer différents résultats, en fonction du type de projet.

Pour décrire ces classes de méthodes, cette discussion utilise le terme API de métriques pour faire référence aux ressources suivantes de l'API Monitoring :

projet de champ d'application d'un champ d'application des métriques requis

Toutes les méthodes d'API Monitoring qui ne font pas partie d'API Metrics nécessitent que le paramètre name fasse référence à un projet de définition de champ d'application de métriques.

projet de champ d'application d'un champ d'application des métriques non requis

Aucune des méthodes de l'API Metrics ne nécessite que le paramètre name fasse référence à un projet de champ d'application de champ d'application des métriques, mais certaines méthodes se comportent différemment lorsque c'est le cas:

  • Les méthodes suivantes de l'API de métriques fonctionnent sur le projet Google Cloud nommé. Ces méthodes n'affectent que les données du projet nommé, indépendamment du fait que le projet soit également un projet de définition de champ d'application de métriques.

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • Les méthodes restantes dans l'API de métriques se comportent comme suit :

    • Si le projet nommé n'est pas un projet de définition de champ d'application de métriques, les méthodes ne récupèrent que les données du projet nommé.
    • Si le projet nommé est également un projet de définition de champ d'application de métriques, les méthodes récupèrent les données du projet nommé et de tous les projets qu'il surveille.

    Les méthodes de ce groupe sont les suivantes :

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

Pour en savoir plus sur la configuration d'un projet Google Cloud en tant que projet effectuant une surveillance d'un champ d'application des métriques, consultez la page Présentation des champs d'application des métriques.

Ressources de l'API

Métriques

L'API Monitoring vous donne accès à environ 6 500 métriques Cloud Monitoring à partir de Google Cloud et d'Amazon Web Services. Vous pouvez créer vos propres métriques personnalisées et organiser vos ressources cloud à l'aide de groupes.

Pour un aperçu des concepts de métriques et des structures de données qui les représentent, consultez la section Métriques, séries temporelles et ressources.

Pour savoir comment gérer vos métriques personnalisées et les métriques intégrées, consultez la section Présentation des métriques définies par l'utilisateur.

Pour obtenir la liste complète des métriques disponibles, consultez la section Liste des métriques.

Ressources surveillées

Une ressource surveillée est un élément sur lequel des métriques sont collectées. Par exemple, il se peut que vous soyez intéressé par l'activité d'une instance de VM ou d'un élément de matériel.

Pour obtenir la liste des ressources surveillées disponibles, consultez la liste des ressources surveillées.

Groupes de ressources surveillées

Un groupe est une collection dynamique de ressources surveillées. Vous avez toujours pu créer des groupes manuellement dans la console Google Cloud. Vous pouvez également utiliser l'API Cloud Monitoring pour écrire du code qui crée et utilise des groupes.

Pour en savoir plus, consultez la documentation de référence de l'API pour Group.

Règles d'alerte

Une règle d'alerte est une ressource de configuration qui décrit les critères de génération des incidents et la manière dont vous êtes averti lorsqu'un incident est créé. La section Concepts d'alerte décrit les concepts de base des règles d'alerte. Pour plus d'informations, consultez la documentation de référence de l'API pour AlertPolicy.

L'API vous permet également de créer des règles d'alerte basées sur un ratio de deux métriques. Actuellement, les ratios ne peuvent pas être créés à l'aide de Monitoring dans la console Google Cloud. Pour plus d'informations, consultez MetricThreshold dans la documentation de référence sur AlertPolicy.

Canaux de notification

Un canal de notification est une ressource de configuration qui décrit la manière dont vous êtes averti lorsque des incidents se produisent. Les canaux de notification peuvent référencer différents types de services de communication et de points de terminaison. Ils sont spécifiées dans les descriptors. Les descripteurs déterminent l'ensemble des paramètres de configuration inclus dans un objet de canal.

Pour plus d'informations, consultez la documentation de référence de NotificationChannel et la documentation de référence de NotificationChannelDescriptor.

Service Monitoring

Les ressources de surveillance des services permettent de définir des objectifs de niveau de service pouvant servir à surveiller l'état de vos services.

Service Monitoring ajoute les ressources suivantes à l'API Monitoring :

Pour en savoir plus sur ces concepts de surveillance des services et sur l'utilisation de l'API, consultez la page Surveillance SLO.

Tableaux de bord

Vous pouvez créer et manipuler de manière automatisée à la fois des tableaux de bord et des graphiques à l'aide du point de terminaison Dashboards. Pour plus d'informations sur l'utilisation de ce point de terminaison pour gérer les tableaux de bord et les graphiques, consultez la page Gérer les tableaux de bord à l'aide d'API.

Langage MQL

Le langage MQL (Monitoring Query Language) fournit une interface textuelle pour l'interrogation des données de séries temporelles Cloud Monitoring. Il utilise un modèle de requête redirigée et est plus expressif que les filtres Monitoring. Vous pouvez utiliser les requêtes MQL à partir de l'API Monitoring ou de l'éditeur de code.

Pour obtenir des informations générales sur le langage MQL, consultez la page Utiliser le langage MQL.

Pour plus d'informations sur l'utilisation de MQL pour récupérer des données de séries temporelles à l'aide de l'API Monitoring, consultez la documentation de référence de l'API pour la méthode timeSeries.query.

Filtres

L'API Monitoring utilise des filtres pour sélectionner des métriques, extraire des données de séries temporelles et collecter des ressources surveillées dans des groupes. Pour en savoir plus, consultez la section Filtres de surveillance.

L'API Monitoring utilise également des filtres pour limiter l'ensemble de résultats de certaines opérations list. Pour en savoir plus sur la gestion des résultats des méthodes alertPolicies.list et notificationChannels.list, consultez la section Trier et filtrer.

Étapes suivantes