Observações sobre a terminologia

As palavras name, type, kind, metric e resource aparecem em várias combinações e contextos relacionados ao Cloud Monitoring, e os usos nem sempre são consistentes. Por exemplo, veja alguns padrões comuns:

• O termo metric pode ser usado em diferentes contextos para se referir a qualquer um dos seguintes itens:

  • "Algo" geral a ser medido
  • Um tipo de métrica
  • Uma série temporal
  • Um conjunto de séries temporais associadas a um tipo de métrica
  • A estrutura Metric incorporada em uma estrutura TimeSeries

• Uma string como storage.googleapis.com/api/request_count pode ser chamada de qualquer uma das seguintes opções:

  • Uma métrica
  • Um nome de métrica
  • Um tipo de métrica
  • Um nome de tipo de métrica

• A string como gcs_bucket pode ser chamada de qualquer uma das seguintes opções:

  • Um nome de recurso ¹
  • Um recurso monitorado
  • Um tipo de recurso monitorado
  • Um nome de recurso monitorado

¹ O material de referência da API REST também faz uso frequente do termo nome do recurso, que geralmente não tem nada a ver com recursos monitorados. Esse termo é descrito em mais detalhes em Nomes de recursos.

Esta seção fornece algumas orientações sobre terminologia possivelmente confusa.

Tipos e nomes

Descritores para tipos de métricas e recursos monitorados têm nomes e tipos. É comum usar termos alternadamente.

Por exemplo, a string storage.googleapis.com/api/request_count é um tipo de métrica, embora também seja chamada de nome ou tipo.

Se você observar o descritor desse tipo de métrica, verá estes dois pares de chave-valor, name e type:

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

O type em um descritor de métrica é uma string que codifica informações sobre o serviço que gera os dados (por exemplo, storage.googleapis.com) e o que está sendo medido (api/request_count).

Em um descritor de métrica, o valor de name é a versão totalmente qualificada do tipo de métrica. o valor name é o valor type prefixado com esta string:

projects/[PROJECT_ID]/metricDescriptors/

Um padrão semelhante é válido para recursos monitorados. O type é um rótulo para algum tipo de recurso, e o name consiste no valor type prefixado com esta string:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

O exemplo a seguir corresponde à entrada api na lista de recursos monitorados:

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

O valor de name em um projeto é totalmente previsível a partir do valor de type, mas não é exatamente a mesma coisa. No entanto, os termos geralmente são usados de maneira imprecisa em discussões casuais.

Ponto-chave: em quase todos os casos, o uso de "tipo de métrica", "nome da métrica" ou "nome do tipo de métrica" refere-se ao tipo de métrica conforme descrito aqui. A palavra "métrica" normalmente significa a série temporal associada a um tipo de métrica. A frase "recurso monitorado" geralmente significa o tipo ou uma entidade física específica descrita por um tipo.

Tipo de métrica e tipo de valor

Há dois outros termos que podem ser confundidos com "tipo de métrica":

• Tipo de valor
• Classe da métrica

Esses termos não são termos alternativos para "tipo de métrica".

"Tipo de valor" e "tipo de métrica" descrevem os dados coletados. Ambos estão relacionados ao conceito de programação "datatype".

• O tipo de valor descreve os valores individuais.
• O tipo de métrica descreve como os valores estão relacionados entre si.

Consulte Tipos de métricas para ver mais detalhes.

Nomes de recursos

O padrão de criação de um valor name prefixando uma string para um valor type (ou outro) se estende muito além dos tipos de métrica e recurso monitorado. Ele aparece com quase tudo que cria dados de identificação exclusiva. Por exemplo, MetricDescriptor e AlertPolicy seguem esse padrão.

O valor do campo name é geralmente descrito na documentação de referência como um "nome de recurso":

Veja alguns exemplos de algumas estruturas que têm nomes de recursos e como elas são derivadas:

• Descritores de métrica: junte os valores do prefixo e o campo type:
  • Prefixo: projects/[PROJECT_ID]/metricDescriptors
  • type (amostra): storage.googleapis.com/api/request_count
  • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
• Descritores de recursos monitorados: junte os valores do prefixo e o campo type:
  • Prefixo: projects/[PROJECT_ID]/monitoredResourceDescriptors
  • type (amostra): api
  • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
• Políticas de alertas: junte os valores do prefixo e um ID gerado
  • Prefixo: projects/[PROJECT_ID]/alertPolicies
  • Código da política de alertas: um número gerado quando a política foi criada
  • name: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

O termo "nome do recurso" refere-se a um recurso na hierarquia da API de um serviço e não está relacionado ao conceito de recursos monitorados. Para mais informações sobre nomes de recursos no design de uma API, consulte Nomes de recursos.

Importante: na API Cloud Monitoring, quando um campo name é descrito como um "nome de recurso", o valor desse campo é um identificador totalmente qualificado criado usando um valor type (ou outro campo) e prefixando-o com a string que identifica o tipo de recurso.