Notas sobre a terminologia

As palavras name, type, kind, metric e resource aparecem em várias combinações e contextos relacionados com o Cloud Monitoring, e as utilizações nem sempre são consistentes. Por exemplo, seguem-se alguns padrões comuns:

  • O termo métrica pode ser usado, em diferentes contextos, para se referir a qualquer um dos seguintes elementos:

    • Um "algo" geral a ser medido
    • Um tipo de métrica
    • Uma série cronológica
    • Um conjunto de séries cronológicas associadas a um tipo de métrica
    • A estrutura Metric incorporada numa estrutura TimeSeries

  • Uma string como storage.googleapis.com/api/request_count pode ser referida como 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 referida como qualquer uma das seguintes opções:

    • Um nome do recurso1
    • Um recurso monitorizado
    • Um tipo de recurso monitorizado
    • Um nome de recurso monitorizado

1 O material de referência da API REST também usa frequentemente o termo nome do recurso, que normalmente não tem nada a ver com os recursos monitorizados. Este termo é descrito mais detalhadamente em Nomes de recursos.

Esta secção fornece algumas orientações sobre terminologia que pode ser confusa.

Tipos e nomes

Os descritores para tipos de métricas e recursos monitorizados têm nomes e tipos. É comum usar os termos de forma intercambiável em contextos informais.

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

Se analisar o descritor deste tipo de métrica, vê 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 num descritor de métricas é uma string que codifica informações sobre o serviço que gera os dados (por exemplo, storage.googleapis.com) e o que está a ser medido (api/request_count).

Num descritor de métricas, o valor de name é a versão totalmente qualificada do tipo de métrica; o valor de name é o valor de type com este prefixo:

projects/[PROJECT_ID]/metricDescriptors/

Um padrão semelhante aplica-se aos recursos monitorizados. O type é uma etiqueta para algum tipo de recurso e o name consiste no valor type com este prefixo de string:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

O exemplo seguinte corresponde à entrada api na lista de recursos monitorizados:

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

O valor de name num projeto é totalmente previsível a partir do valor de type, mas não são exatamente a mesma coisa. No entanto, os termos são frequentemente usados de forma imprecisa em conversas informais.

Tipo de valor e tipo de métrica

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

  • Tipo de valor
  • Tipo de métrica

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

O "tipo de valor" e o "tipo de métrica" descrevem os dados recolhidos. Ambos estão relacionados com o conceito de programação "tipo de dados".

  • O tipo de valor descreve os valores individuais.
  • O tipo de métrica descreve a relação entre os valores.

Consulte Tipos e géneros de métricas para ver detalhes.

Nomes de recursos

O padrão de criação de um valor name ao prefixar uma string a um valor type (ou outro) estende-se muito além dos tipos de métricas e recursos monitorizados. Aparece com quase tudo o que cria dados individualmente identificáveis. Por exemplo, MetricDescriptor e AlertPolicy seguem este padrão.

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

Nome do recurso na referência da API

Seguem-se alguns exemplos de estruturas que têm nomes de recursos e como são derivados:

  • Descritores de métricas: juntam os valores do prefixo e do 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 monitorizados: junte os valores do prefixo e do campo type:
    • Prefixo: projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type (amostra): api
    • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
  • Políticas de alerta: junte os valores do prefixo e um ID gerado
    • Prefixo: projects/[PROJECT_ID]/alertPolicies
    • ID da política de alerta: 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 com o conceito de recursos monitorizados de forma alguma. Para mais informações sobre os nomes de recursos na conceção de uma API, consulte o artigo Nomes de recursos.