Convenções de nomenclatura de métricas

Este documento descreve as convenções de nomenclatura que o Cloud Monitoring aplica às métricas.

Nome do recurso da métrica

O nome do recurso para um tipo de métrica consiste numa string com três subestruturas principais:

• Um identificador de um projeto específico.
• Um marcador, que é sempre definido como metricDescriptors, para indicar que a string representa um descritor de métrica.
• O tipo de métrica.

Os nomes dos recursos para tipos de métricas seguem este padrão:

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

A subcadeia de carateres METRIC_TYPE é um identificador que representa o tipo de métrica. Está disponível numa variedade de formatos, por exemplo:

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

No descritor de métricas, o campo name armazena o nome do recurso do tipo de métrica e o campo type armazena a subcadeia de carateres METRIC_TYPE.

A tabela seguinte mostra como analisar as subcadeias METRIC_TYPE contidas num nome de recurso:

Estruturas possíveis	Descrição
SERVICE_NAME^1.googleapis.com/PATH^2	As métricas de Google Cloud produtos e serviços. Para ver uma lista completa destas métricas, consulte as Google Cloud métricas.
agent.googleapis.com/SERVICE_NAME^1/PATH^2	Métricas dos agentes de monitorização e registo em execução em instâncias de VM no Google Cloud ou na AWS. Para ver uma lista completa destas métricas, consulte Métricas do agente.
kubernetes.io/anthos/PATH^2	As métricas do GKE Enterprise, um serviço que lhe permite executar clusters do Kubernetes no local e na nuvem. Google CloudPara ver uma lista completa destas métricas, consulte o artigo Métricas do Anthos.
aws.googleapis.com/SERVICE_NAME^1/PATH^2	Métricas do Amazon Web Services. Para ver uma lista completa destas métricas, consulte Métricas da AWS.
istio.io/PATH^2	Métricas do Istio para Google Cloud. Para ver uma lista completa destas métricas, consulte o artigo Métricas do Istio.
kubernetes.io/PATH^2	Métricas do Google Kubernetes Engine. Para ver uma lista completa destas métricas, consulte o artigo Métricas do Kubernetes.
knative.dev/PATH^2	Métricas do Knative. Para ver uma lista completa destas métricas, consulte o artigo Métricas do Knative.
external.googleapis.com/EXT_SERVICE/PATH^2 external.googleapis.com/prometheus/PATH^2	Métricas personalizadas de terceiros, como o Prometheus. Esta ferramenta de monitorização de código aberto é frequentemente usada com o Kubernetes. Para mais informações sobre estas métricas, consulte o artigo Métricas externas. Só pode usar estes tipos de métricas nos projetos que os definem.
custom.googleapis.com/PATH^2 external.googleapis.com/user/PATH^2	Métricas definidas pelo utilizador. Só pode usar estes tipos de métricas nos projetos onde os define.
logging.googleapis.com/PATH^2	Métricas baseadas em registos do Cloud Logging. Pode usar métricas predefinidas ou criar métricas personalizadas. As métricas personalizadas só podem ser usadas em projetos onde as define.

¹ SERVICE_NAME identifica um Google Cloud produto, como compute para o Compute Engine.
² PATH identifica a métrica no produto, como instance/cpu/utilization.

Regras para tipos de métricas e etiquetas

Esta lista contém regras a seguir quando cria tipos de métricas personalizadas. As etiquetas associadas a um tipo de métrica são especificadas como pares de chave-valor do tipo LabelDescriptor. A chave funciona como o nome da etiqueta.

• Tipos de métricas

  • Use letras maiúsculas e minúsculas (A-Z, a-z), dígitos (0-9), pontos (.) e sublinhados (_) na string.
  • Use barras invertidas (/) para separar os elementos do caminho.
  • Tem de começar cada elemento do caminho com uma letra ou um dígito.
  • O comprimento máximo de uma string do tipo métrica é de 200 carateres.

• Etiquete as teclas

  • Use letras minúsculas (a-z), dígitos (0-9) e sublinhados (_) numa chave de etiqueta.
  • Tem de começar as chaves de etiquetas com uma letra.
  • O comprimento máximo de uma chave de etiqueta é de 100 carateres.
  • Cada chave tem de ser única no tipo de métrica.
  • Não pode ter mais de 30 etiquetas por tipo de métrica.