Notas sobre la terminología

Las palabras name, type, kind, metric y resource aparecen en varias combinaciones y contextos relacionados con Cloud Monitoring, y sus usos no siempre son coherentes. Por ejemplo, estos son algunos patrones habituales:

• El término métrica puede usarse, en diferentes contextos, para referirse a cualquiera de los siguientes elementos:

  • Un "algo" general que se va a medir
  • Un tipo de métrica
  • Una serie temporal
  • Conjunto de series temporales asociadas a un tipo de métrica.
  • La estructura Metric insertada en una estructura TimeSeries

• Una cadena como storage.googleapis.com/api/request_count puede denominarse de las siguientes formas:

  • Una métrica
  • Nombre de la métrica
  • Un tipo de métrica
  • Nombre de tipo de métrica

• La cadena como gcs_bucket puede denominarse de las siguientes formas:

  • Nombre de un recurso¹
  • Un recurso monitorizado
  • Un tipo de recurso monitorizado
  • Nombre de recurso monitorizado

¹ En el material de referencia de la API REST también se usa con frecuencia el término nombre de recurso, que normalmente no tiene nada que ver con los recursos monitorizados. Este término se describe con más detalle en la sección Nombres de recursos.

En esta sección se ofrecen algunas aclaraciones sobre terminología que puede resultar confusa.

Tipos y nombres

Los descriptores de los tipos de métricas y de los recursos monitorizados tienen nombres y tipos. En el uso informal, es habitual usar los términos indistintamente.

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

Si consulta el descriptor de este tipo de métrica, verá 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 de un descriptor de métrica es una cadena 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 completa del tipo de métrica. El valor de name es el valor de type con el prefijo de esta cadena:

projects/[PROJECT_ID]/metricDescriptors/

Se aplica un patrón similar a los recursos monitorizados. type es una etiqueta de algún tipo de recurso y name consta del valor de type con el prefijo de esta cadena:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

El siguiente ejemplo corresponde a la entrada api de la lista de recursos monitorizados:

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

El valor de name en un proyecto se puede predecir por completo a partir del valor de type, pero no son exactamente lo mismo. Sin embargo, los términos se suelen usar de forma imprecisa en conversaciones informales.

Importante: En casi todos los casos, el uso de "tipo de métrica", "nombre de métrica" o "nombre de tipo de métrica" hace referencia al tipo de métrica tal como se describe aquí. La palabra "métrica" suele hacer referencia a la serie temporal asociada a un tipo de métrica. La frase "recurso monitorizado" suele hacer referencia al tipo o a una entidad física concreta descrita por un tipo.

Tipo de métrica y tipo de valor

Hay otros dos términos que se pueden confundir con "tipo de métrica":

• Tipo de valor
• Tipo de métrica

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

"Tipo de valor" y "tipo de métrica" describen los datos recogidos. Ambos están relacionados con el concepto de programación "tipo de datos".

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

Consulta la sección Tipos y clases de métricas para obtener más información.

Nombres de recursos

El patrón de crear un valor de name añadiendo un prefijo a una cadena de type (u otro) valor va mucho más allá de los tipos de métricas y de recursos monitorizados. Aparece con casi cualquier elemento que cree datos identificables únicos. Por ejemplo, tanto MetricDescriptor como AlertPolicy siguen este patrón.

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

A continuación, se muestran algunos ejemplos de estructuras que tienen nombres de recursos y cómo se derivan:

• Descriptores de métricas: combina los valores del prefijo y del campo type:
  • Prefijo: projects/[PROJECT_ID]/metricDescriptors
  • type (ejemplo): storage.googleapis.com/api/request_count
  • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
• Descriptores de recursos monitorizados: combina los valores del prefijo y del campo type:
  • Prefijo: projects/[PROJECT_ID]/monitoredResourceDescriptors
  • type (ejemplo): api
  • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
• Políticas de alertas: combina los valores del prefijo y un ID generado
  • Prefijo: projects/[PROJECT_ID]/alertPolicies
  • ID de la política de alertas: 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 de la jerarquía de la API de un servicio y no está relacionado con el concepto de recursos monitorizados. Para obtener más información sobre los nombres de recursos en el diseño de una API, consulta Nombres de recursos.

Importante: En la API Cloud Monitoring, cuando un campo name se describe como "nombre de recurso", el valor de ese campo es un identificador completo que se crea tomando un valor de type (u otro campo) y añadiéndole como prefijo la cadena que identifica el tipo de recurso.