Remarques sur la terminologie

La distinction entre des termes qui se chevauchent, tels que nom, type, genre, métrique et ressource, vous aide à interpréter la documentation Cloud Monitoring et à fournir les champs appropriés dans les requêtes de l'API Cloud Monitoring. L'utilisation occasionnelle brouille souvent la distinction entre les types de métriques, les types de ressources surveillées, les types de valeurs, les genres de métriques et les noms de ressources d'API.

Termes courants qui se chevauchent

Les exemples suivants illustrent comment les termes et identifiants Monitoring sont souvent utilisés de manière interchangeable en fonction du contexte :

  • Le terme métrique peut être utilisé, dans différents contextes, pour faire référence à l'un des éléments suivants :

    • Un élément général à mesurer
    • Un type de métrique
    • Une série temporelle
    • Un ensemble de séries temporelles associé à un type de métrique
    • La structure Metric intégrée dans une structure TimeSeries

  • Une chaîne telle que storage.googleapis.com/api/request_count peut être désignée par l'une des valeurs suivantes :

    • Une métrique
    • Un nom de métrique
    • Un type de métrique
    • Un nom de type de métrique

  • Une chaîne telle que gcs_bucket peut être appelée de l'une des manières suivantes :

    • Un nom de ressource1
    • Une ressource surveillée
    • Un type de ressource surveillée
    • Un nom de ressource surveillée

1 La documentation de référence de l'API REST utilise également fréquemment le terme nom de ressource, qui n'a généralement aucun rapport avec les ressources surveillées. Ce terme est décrit plus en détail dans Noms de ressources.

Le reste de ce document fournit des conseils sur la terminologie qui peut prêter à confusion.

Types et noms

Les descripteurs des types de métriques et des ressources surveillées présentent des noms et des types. En usage courant, il est fréquent d'utiliser ces termes de manière interchangeable.

Par exemple, la chaîne storage.googleapis.com/api/request_count est un type de métrique, mais elle est également appelée nom ou nom de type.

Si vous regardez le descripteur pour ce type de métrique, vous voyez les deux paires valeur / clé suivantes: name et type :

{
  "name": "projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count",
  ...
  "type": "storage.googleapis.com/api/request_count",
}

Le champ type d'un descripteur de la métrique est une chaîne qui encode des informations sur le service générant les données (par exemple, storage.googleapis.com) et sur ce qui est mesuré (api/request_count).

Dans un descripteur de la métrique, la valeur du champ name est la version complète du type de métrique. La valeur name est la valeur type précédée de la chaîne suivante :

projects/[PROJECT_ID]/metricDescriptors/

Un schéma similaire se produit pour les ressources surveillées. L'élément type est un libellé pour un type de ressource, et name comprend la valeur type précédée de cette chaîne :

projects/[PROJECT_ID]/monitoredResourceDescriptors/

L'exemple suivant correspond à l'entrée api de la liste des ressources surveillées :

{
  "type": "api",
  ...
  "name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/api"
}

La valeur de name dans un projet est totalement prévisible à partir de la valeur de type, mais il ne s'agit pas exactement de la même chose. Toutefois, ces termes sont souvent employés de manière imprécise dans le contexte d'une discussion informelle.

Genre de métrique et type de valeur

Il existe deux autres termes qui peuvent être confondus avec le "type de métrique" :

  • Type de valeur
  • Type de métrique

Ces termes ne sont pas des synonymes de "type de métrique".

Les termes "type de valeur" et "genre de métrique" décrivent les données collectées. Ils sont tous deux liés au concept de programmation "type de données".

  • Le type de valeur décrit les valeurs individuelles.
  • Le genre de métrique décrit la relation entre ces valeurs.

Pour en savoir plus, consultez Types de valeurs et genres de métriques.

Noms de ressources

Le modèle de création d'une valeur name en préfixant une chaîne à une valeur type (ou autre) s'étend bien au-delà des types de métriques et de ressources surveillées. Il s'utilise avec presque tous les éléments qui créent des données identifiables de manière unique.

La valeur du champ name est souvent décrite dans la documentation de référence comme un "nom de ressource" :

Nom de la ressource dans la documentation de référence de l'API

Voici quelques exemples de structures comportant des noms de ressources et leur dérivation :

  • Descripteurs de métriques : joignez les valeurs du préfixe et du champ type :
    • Préfixe : projects/[PROJECT_ID]/metricDescriptors
    • type (échantillon) : storage.googleapis.com/api/request_count
    • name : projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
  • Descripteurs de ressources surveillées : associez les valeurs du préfixe et du champ type :
    • Préfixe : projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type (échantillon) : api
    • name : projects/[PROJECT_ID]/monitoredResourceDescriptors/api

Le terme "nom de ressource" fait référence à une ressource dans la hiérarchie de l'API d'un service et n'est en aucun cas lié au concept de ressources surveillées. Pour en savoir plus sur les noms de ressources dans la conception d'une API, consultez la page Noms de ressources.