Conventions de nommage

Le nom de la ressource d'un type de métrique se compose d'une chaîne avec trois sous-structures principales :

  • L'identifiant d'un projet spécifique
  • Un repère indiquant que la chaîne représente un descripteur de la métrique
  • Type de métrique

Les noms de ressources pour les types de métriques suivent ce modèle :

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

La sous-chaîne METRIC_TYPE est un identifiant qui représente le type de métrique. Il existe différents formats, par exemple :

agent.googleapis.com/agent/api_request_count
compute.googleapis.com/firewall/dropped_bytes_count
istio.io/service/client/received_bytes_count
kubernetes.io/antho/APIServiceOpenAPIAggregationControllerQueue1_adds

Dans le descripteur de métrique, le champ name stocke le nom de ressource du type de métrique et le champ type stocke la sous-chaîne METRIC_TYPE.

Le tableau suivant montre comment analyser les sous-chaînes METRIC_TYPE contenues dans un nom de ressource :

Structures possibles Description
SERVICE 1.googleapis.com/PATH 2 Métriques provenant des produits et services Google Cloud. Pour obtenir la liste complète de ces métriques, consultez la page Métriques Google Cloud.
agent.googleapis.com/SERVICE 1/PATH 2 Métriques des agents Monitoring et Logging s'exécutant sur des instances de VM dans Google Cloud ou AWS. Pour obtenir la liste complète de ces métriques, consultez la page Métriques d'agent.
kubernetes.io/anthos/PATH 2 Les métriques d'Anthos, un service Google Cloud qui vous permet d'exécuter des clusters Kubernetes sur site et dans le cloud. Pour obtenir la liste complète de ces métriques, consultez la page Métriques Anthos.
aws.googleapis.com/SERVICE 1/PATH 2 Métriques d'Amazon Web Services. Pour obtenir la liste complète de ces métriques, consultez la page Métriques AWS.
istio.io/PATH 2 Métriques d'Istio pour Google Cloud. Pour obtenir la liste complète de ces métriques, consultez la page Métriques Istio.
kubernetes.io/PATH 2 Métriques de Google Kubernetes Engine. Pour obtenir la liste complète de ces métriques, consultez la page Métriques Kubernetes.
knative.dev/PATH 2 Métriques de Knative. Pour obtenir la liste complète de ces métriques, consultez la page Métriques Knative.
external.googleapis.com/EXT_SERVICE/PATH 2
external.googleapis.com/prometheus/PATH 2
Métriques personnalisées tierces, telles que Prometheus. Cet outil de surveillance Open Source est souvent utilisé avec Kubernetes. Pour en savoir plus sur ces métriques, consultez la page Métriques externes. Vous ne pouvez utiliser ces types de métriques que dans les projets qui les définissent.
custom.googleapis.com/PATH 2 Métriques personnalisées définies par l'utilisateur. Vous ne pouvez utiliser ces types de métriques que dans les projets où vous les définissez.
logging.googleapis.com/PATH 2 Métriques basées sur les journaux de Cloud Logging. Vous pouvez utiliser des métriques prédéfinies ou créer des métriques personnalisées. Les métriques personnalisées ne peuvent être utilisées que dans les projets où vous les définissez.

1 SERVICE identifie un produit Google Cloud, tel que compute pour Compute Engine.
2 PATH identifie la métrique au sein du produit, par exemple instance/cpu/utilization.

Attribuer un nom aux types de métriques et aux libellés

Si vous créez des types de métriques personnalisées, vous devez respecter les règles suivantes pour nommer ces types de métriques et de libellés. Lors de la définition d'un type de métrique, les libellés sont spécifiés en tant que paires clé/valeur de type LabelDescriptor. La clé agit comme nom du libellé.

  • Types de métriques
    • Vous pouvez utiliser des lettres majuscules et minuscules (A-Z, a-z), des chiffres (0-9) et des traits de soulignement (_) dans la chaîne.
    • Vous ne pouvez utiliser des points (.) uniquement dans la partie "domaine" de la chaîne, par exemple, custom.googleapis.com.
    • Vous pouvez utiliser des barres obliques (/) pour séparer les éléments de chemin d'accès.
    • Chaque élément du chemin doit commencer par une lettre ou un chiffre.
    • La longueur maximale d'une chaîne de type de métrique est de 200 caractères.
  • Clés de libellés
    • Vous pouvez utiliser des lettres minuscules (a-z), des chiffres (0-9) et des traits de soulignement (_) dans une clé d'étiquette.
    • Vous devez commencer par une lettre ou un trait de soulignement.
    • La longueur maximale d'une clé de libellé est de 100 caractères.
    • Chaque clé doit être unique dans le type de métrique.
    • Vous ne pouvez pas définir plus de 10 libellés par type de métrique.