Convenciones de nomenclatura de métricas

En este documento se describen las convenciones de nomenclatura que aplica Cloud Monitoring a las métricas.

Nombre del recurso de métrica

El nombre de recurso de un tipo de métrica consta de una cadena con tres subestructuras principales:

  • Identificador de un proyecto específico.
  • Un marcador, que siempre se define como metricDescriptors, para indicar que la cadena representa un descriptor de métrica.
  • El tipo de métrica.

Los nombres de recursos de los tipos de métricas siguen este patrón:

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

La subcadena METRIC_TYPE es un identificador que representa el tipo de métrica. Está disponible en varios formatos, como los siguientes:

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

En el descriptor de métrica, el campo name almacena el nombre del recurso del tipo de métrica y el campo type almacena la subcadena METRIC_TYPE.

En la siguiente tabla se muestra cómo analizar las subcadenas METRIC_TYPE contenidas en un nombre de recurso:

Estructuras posibles Descripción
SERVICE_NAME 1.googleapis.com/PATH 2 Métricas de Google Cloud productos y servicios. Para ver una lista completa de estas métricas, consulte las métricas deGoogle Cloud .
agent.googleapis.com/SERVICE_NAME 1/PATH 2 Métricas de los agentes de Monitoring y Logging que se ejecutan en instancias de VM en Google Cloud o AWS. Para ver una lista completa de estas métricas, consulta Métricas de agente.
kubernetes.io/anthos/PATH 2 Métricas de GKE Enterprise, un servicio que te permite ejecutar clústeres de Kubernetes tanto on-premise como en la nube. Google CloudPara ver una lista completa de estas métricas, consulta Métricas de Anthos.
aws.googleapis.com/SERVICE_NAME 1/PATH 2 Métricas de Amazon Web Services. Para ver una lista completa de estas métricas, consulta Métricas de AWS.
istio.io/PATH 2 Métricas de Istio para Google Cloud. Para ver una lista completa de estas métricas, consulta Métricas de Istio.
kubernetes.io/PATH 2 Métricas de Google Kubernetes Engine. Para ver una lista completa de estas métricas, consulta Métricas de Kubernetes.
knative.dev/PATH 2 Métricas de Knative. Para ver una lista completa de estas métricas, consulta Métricas de Knative.
external.googleapis.com/EXT_SERVICE/PATH 2
external.googleapis.com/prometheus/PATH 2		 Métricas personalizadas de terceros, como Prometheus. Esta herramienta de monitorización de código abierto se usa a menudo con Kubernetes. Para obtener más información sobre estas métricas, consulta el artículo Métricas externas. Solo puede usar estos tipos de métricas en los proyectos que los definan.
custom.googleapis.com/PATH 2
external.googleapis.com/user/PATH 2		 Métricas definidas por el usuario. Solo puede usar estos tipos de métricas en los proyectos en los que los defina.
logging.googleapis.com/PATH 2 Métricas basadas en registros de Cloud Logging. Puede usar métricas predefinidas o crear métricas personalizadas. Las métricas personalizadas solo se pueden usar en los proyectos en los que las defina.

1 SERVICE_NAME identifica un Google Cloud producto, como compute para Compute Engine.
2 PATH identifica la métrica en el producto, como instance/cpu/utilization.

Reglas para tipos de métricas y etiquetas

Esta lista contiene las reglas que debe seguir al crear tipos de métricas personalizadas. Las etiquetas asociadas a un tipo de métrica se especifican como pares clave-valor de tipo LabelDescriptor. La clave actúa como nombre de la etiqueta.

  • Tipos de métricas

    • Usa letras mayúsculas y minúsculas (A-Z, a-z), dígitos (0-9), puntos (.) y guiones bajos (_) en la cadena.
    • Usa barras inclinadas (/) para separar los elementos de la ruta.
    • Cada elemento de la ruta debe empezar por una letra o un dígito.
    • La longitud máxima de una cadena de tipo métrica es de 200 caracteres.

  • Claves de etiquetas

    • Usa letras minúsculas (a-z), dígitos (0-9) y guiones bajos (_) en una clave de etiqueta.
    • Las claves de etiqueta deben empezar por una letra.
    • La longitud máxima de una clave de etiqueta es de 100 caracteres.
    • Cada clave debe ser única en el tipo de métrica.
    • Puedes tener un máximo de 30 etiquetas por tipo de métrica.