Convenções de nomenclatura de métricas

Neste documento, descrevemos as convenções de nomenclatura que o Cloud Monitoring aplica às métricas.

Nome do recurso de métrica

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

  • 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 de recursos para tipos de métricas seguem este padrão:

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

A substring METRIC_TYPE é um identificador que representa o tipo de métrica. Ele apresenta diversos formatos, como, 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étrica, o campo name armazena o nome do recurso do tipo de métrica, e o campo type armazena a substring METRIC_TYPE.

A tabela a seguir mostra como analisar as substrings METRIC_TYPE contidas em um nome de recurso:

Possíveis estruturas Descrição
SERVICE_NAME 1.googleapis.com/PATH 2 Métricas de produtos e serviços do Google Cloud. Para uma lista completa dessas métricas, consulte métricas do Google Cloud.
agent.googleapis.com/SERVICE_NAME 1/PATH 2 Métricas dos agentes do Monitoring e do Logging em execução em instâncias de VM no Google Cloud ou na AWS. Para uma lista completa dessas métricas, consulte Métricas do agente.
kubernetes.io/anthos/PATH 2 Métricas do GKE Enterprise, um serviço do Google Cloud que permite executar clusters do Kubernetes no local e na nuvem. Para uma lista completa dessas métricas, consulte Métricas do Anthos.
aws.googleapis.com/SERVICE_NAME 1/PATH 2 Métricas do Amazon Web Services Para uma lista completa dessas métricas, consulte Métricas do AWS.
istio.io/PATH 2 Métricas do Istio para o Google Cloud. Para uma lista completa dessas métricas, consulte Métricas do Istio.
kubernetes.io/PATH 2 Métricas do Google Kubernetes Engine. Para uma lista completa dessas métricas, consulte Métricas do Kubernetes.
knative.dev/PATH 2 Métricas do Knative. Para uma lista completa dessas métricas, consulte Métricas do Knative.
external.googleapis.com/EXT_SERVICE/PATH 2
external.googleapis.com/prometheus/PATH 2		 Métricas personalizadas de terceiros, como Prometheus. Essa ferramenta de monitoramento de código aberto é frequentemente usada com o Kubernetes. Para mais informações sobre essas métricas, consulte Métricas externas. É possível usar esses tipos de métricas somente nos projetos que os definem.
custom.googleapis.com/PATH 2
external.googleapis.com/user/PATH 2		 Métricas definidas pelo usuário. Só é possível usar esses tipos de métricas nos projetos em que são definidos.
logging.googleapis.com/PATH 2 Métricas com base em registros do Cloud Logging. É possível usar métricas predefinidas ou criar métricas personalizadas. As métricas personalizadas só podem ser usadas em projetos em que você as define.

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

Regras para rótulos e tipos de métricas

Esta lista contém regras a serem seguidas quando você cria tipos de métrica personalizada. Os rótulos associados a um tipo de métrica são especificados como pares de chave-valor do tipo LabelDescriptor. A chave atua como o nome do rótulo.

  • 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 (/) para separar elementos de caminho.
    • É preciso iniciar cada elemento do caminho com uma letra ou um dígito.
    • O tamanho máximo de uma string do tipo métrica é 200 caracteres.

  • Chaves de rótulo

    • Use letras minúsculas (a-z), dígitos (0-9) e sublinhados (_) em uma chave de rótulo.
    • As chaves de rótulo precisam começar com uma letra.
    • O tamanho máximo de uma chave de rótulo é 100 caracteres.
    • Cada chave precisa ser exclusiva no tipo de métrica.
    • É possível ter no máximo 30 rótulos por tipo de métrica.