Convenciones de nomenclatura de métricas

Los nombres de recursos estandarizados, los prefijos de dominio y las claves de etiqueta en Cloud Monitoring te permiten identificar las fuentes de las métricas y definir métricas personalizadas. Puedes aplicar estas reglas de formato para crear tipos de métricas y claves de LabelDescriptor válidas para la API de Cloud Monitoring.

Nombre del recurso de la métrica

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

  • Es un identificador de un proyecto específico.
  • Un marcador, que siempre se establece en metricDescriptors, para indicar que la cadena representa un descriptor de métrica.
  • Es el tipo de métrica.

Los nombres de recursos para 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. Se presenta en una variedad de formatos. Por ejemplo:

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 substrings METRIC_TYPE que contiene un nombre de recurso:

Estructuras posibles Descripción
SERVICE_NAME 1.googleapis.com/PATH 2 Métricas de productos y servicios de Google Cloud Para obtener una lista completa de estas métricas, consulta Métricas deGoogle Cloud .
agent.googleapis.com/SERVICE_NAME 1/PATH 2 Son métricas de los agentes de Monitoring y Logging que se ejecutan en instancias de VM en Google Cloud o AWS. Para obtener una lista completa de estas métricas, consulta Métricas del agente.
kubernetes.io/anthos/PATH 2 Métricas de GKE Enterprise, un servicio de Google Cloud que te permite ejecutar clústeres de Kubernetes de forma local y en la nube. Para obtener 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 obtener una lista completa de estas métricas, consulta Métricas de AWS.
istio.io/PATH 2 Métricas de Istio para Google Cloud. Para obtener una lista completa de estas métricas, consulta Métricas de Istio.
kubernetes.io/PATH 2 Métricas de Google Kubernetes Engine. Para obtener una lista completa de estas métricas, consulta Métricas de Kubernetes.
knative.dev/PATH 2 Métricas de Knative. Para obtener 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 supervisión de código abierto se suele usar con Kubernetes. Para obtener más información sobre estas métricas, consulta Métricas externas. Solo puedes usar estos tipos de métricas en los proyectos que las definen.
custom.googleapis.com/PATH 2
external.googleapis.com/user/PATH 2		 Métricas definidas por el usuario. Solo puedes usar estos tipos de métricas en los proyectos en los que los defines.
logging.googleapis.com/PATH 2 Métricas basadas en registros de Cloud Logging. Puedes usar métricas predefinidas o crear métricas personalizadas. Las métricas personalizadas solo se pueden usar en los proyectos en los que las definas.

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

Reglas para los tipos y las etiquetas de métricas

Esta lista contiene reglas que debes seguir cuando creas tipos de métricas personalizadas. Las etiquetas asociadas con un tipo de métrica se especifican como pares clave-valor del tipo LabelDescriptor. La clave actúa como el nombre de la etiqueta.

  • Tipos de métricas

    • Usa letras mayúsculas y minúsculas (A-Z, a-z), dígitos (0-9), puntos (.), guiones bajos (_), dos puntos (:) y guiones (-) en la cadena.
    • Usa barras diagonales (/) para separar los elementos de la ruta de acceso.
    • Debes comenzar cada elemento de la ruta con una letra o un dígito.
    • La longitud máxima de una string de tipo de métrica es de 200 caracteres.

  • Claves de etiquetas

    • Usa letras minúsculas (a-z), dígitos (0-9), guiones bajos (_) y puntos (.) en una clave de etiqueta.
    • Debes comenzar las claves de etiqueta con una letra.
    • La longitud máxima de una clave de etiqueta es de 100 caracteres.
    • Cada clave debe ser única dentro del tipo de métrica.
    • No puedes tener más de 30 etiquetas por tipo de métrica.