Notas sobre la terminología

Las palabras nombre, tipo :categoría, métrica y recurso aparecen en varias combinaciones y contextos relacionados con Cloud Monitoring, y los usos no siempre son coherentes. Por ejemplo, estos son algunos patrones comunes:

• El término métrica se puede usar, en diferentes contextos, para referirse a alguno de estos puntos:

  • Un "algo" general que se debe medir
  • Un tipo de métrica
  • Una serie temporal
  • Un conjunto de series temporales asociadas con un tipo de métrica
  • La estructura Metric incorporada en una estructura TimeSeries

• Una string como storage.googleapis.com/api/request_count podría referirse a cualquiera de las siguientes opciones:

  • Una métrica
  • Un nombre de métrica
  • Un tipo de métrica
  • Un nombre del tipo de métrica

• Una string como gcs_bucket podría referirse a cualquiera de las siguientes opciones:

  • Un nombre de recurso¹
  • Un recurso supervisado
  • Un tipo de recurso supervisado
  • Un nombre de recurso supervisado

¹ El material de referencia de la API de REST también usa con frecuencia el término nombre del recurso, que, por lo general, no tiene nada que ver con los recursos supervisados. Este término se describe con más detalle en Nombres de recursos.

En esta sección, se proporciona orientación sobre la posible terminología confusa.

Tipos y nombres

Los descriptores de tipos de métricas y recursos supervisados tienen nombres y tipos. Es común que el uso ocasional se utilicen los términos de forma indistinta.

Por ejemplo, la string storage.googleapis.com/api/request_count es un tipo de métrica, aunque también se conoce como nombre o tipo de nombre.

Si observas el descriptor de este tipo de métrica, verás estos dos pares clave-valor, name y type:

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

El type en un descriptor de métricas es una string que codifica información sobre el servicio que genera los datos (por ejemplo, storage.googleapis.com) y lo que se mide (api/request_count).

En un descriptor de métrica, el valor de name es la versión completamente calificada del tipo de métrica. El valor name es el valor del prefijo type con la siguiente string:

projects/[PROJECT_ID]/metricDescriptors/

Un patrón similar contiene los recursos supervisados. type es una etiqueta para alguna categoría de recurso, y name consiste en el valor del prefijo type con la siguiente string:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

En el siguiente ejemplo, se corresponde a la entrada api en la lista de recursos supervisados:

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

El valor de name dentro de un proyecto es completamente predecible respecto del valor de type, pero no son exactamente lo mismo. Sin embargo, los términos a menudo se usan de forma imprecisa en un debate informal.

Punto clave: En casi todos los casos, el uso de “tipo de métrica”, “nombre de la métrica” o “nombre del tipo de métrica” hace referencia al tipo de métrica, como se describe aquí. Por lo general, la palabra “métrica” significa la serie temporal asociada con un tipo de métrica. La frase “recurso supervisado”, por lo general, hace referencia al tipo o a una entidad física en particular descrita por un tipo.

Similares de métrica y tipo de valor

Existen otros dos términos que se pueden confundir con el “tipo de métrica”:

• Tipo de valor
• Categoría de métrica

Estos términos no son términos alternativos para "tipo de métrica".

En “Tipo de valor” y “tipo de métrica”, se describen los datos recopilados. Ambos están relacionados con el concepto “tipo de datos” de la programación.

• El tipo de valor describe los valores individuales.
• La categoría de métrica describe cómo se relacionan los valores entre sí.

Consulta Categorías de métricas y tipos de valores para obtener más información.

Nombres de recursos

El patrón de crear un valor name mediante el prefijo a una cadena a un valor type (o a otro) se extiende más allá de la métrica y los tipos de recursos supervisados. Aparece con casi todo lo que crea datos de identificación única. Por ejemplo, MetricDescriptor y AlertPolicy siguen este patrón.

El valor del campo name se suele describir en la documentación de referencia como un “nombre de recurso”:

Estos son algunos ejemplos de algunas estructuras que tienen nombres de recursos y cómo se derivan:

• Descriptores de métrica: une los valores del prefijo y del campo type:
  • Prefijo: projects/[PROJECT_ID]/metricDescriptors
  • type (muestra): storage.googleapis.com/api/request_count
  • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
• Descriptores de recursos supervisados: une los valores del prefijo y del campo type:
  • Prefijo: projects/[PROJECT_ID]/monitoredResourceDescriptors
  • type (muestra): api
  • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
• Políticas de alertas: une los valores del prefijo y de un ID generado.
  • Prefijo: projects/[PROJECT_ID]/alertPolicies
  • ID de política de alertas: un número generado cuando se creó la política
  • name: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

El término “nombre de recurso” hace referencia a un recurso en la jerarquía de la API de un servicio y no está relacionado con el concepto de recursos supervisados de cualquier manera. Para obtener más información sobre los nombres de recursos en el diseño de una API, consulta Nombres de recursos.

Punto clave: en la API de Cloud Monitoring, cuando un campo name se describe como un "nombre de recurso", el valor para ese campo es un identificador completo creado cuando se toma un valor type (u otro campo) y se agrega el prefijo con la string que identifica el tipo de recurso.