Descripción general de las métricas definidas por el usuario

Las métricas definidas por el usuario son todas las métricas que no define Google Cloud. Estas incluyen métricas que tú podrías definir y métricas que define una aplicación de terceros. Las métricas definidas por el usuario te permiten capturar datos específicos de la aplicación o datos del sistema del lado del cliente. Las métricas integradas que recopila Cloud Monitoring pueden brindarte información sobre la latencia de backend o el uso del disco, pero no pueden decirte, por ejemplo, cuántas rutinas en segundo plano generó tu aplicación.

También puedes crear métricas basadas en el contenido de las entradas de registro. Las métricas basadas en registros son una clase de métrica definida por el usuario, pero debes crearlas desde Cloud Logging. Para obtener más información sobre las métricas basadas en registros, consulta Descripción general de las métricas basadas en registros.

Las métricas definidas por el usuario a veces se denominan métricas personalizadas o métricas específicas de la aplicación. Estas métricas te permiten a ti o a una aplicación de terceros definir y recopilar información que las métricas integradas de Cloud Monitoring no pueden. Para capturar esas métricas, debes usar una API proporcionada por una biblioteca para instrumentar tu código y, luego, enviar las métricas a una aplicación de backend como Cloud Monitoring.

Puedes crear métricas definidas por el usuario, excepto las métricas basadas en registros, mediante la API de Cloud Monitoring directamente. Sin embargo, te recomendamos que uses OpenTelemetry. Para obtener información sobre cómo crear métricas definidas por el usuario, consulta los siguientes documentos:

En lo que respecta a Cloud Monitoring, puedes usar métricas definidas por el usuario, como las métricas integradas. Puedes realizar gráficos y establecer alertas con ellas, leerlas y supervisarlas. Para obtener información sobre cómo leer datos de métricas, consulta los siguientes documentos:

  • En Cómo enumerar tipos de métricas y recursos, se explica cómo enumerar y examinar los tipos de métricas integradas y definidas por el usuario. Por ejemplo, puedes usar la información de ese documento para enumerar todos los descriptores de métricas definidos por el usuario en tu proyecto.
  • En Cómo recuperar datos de series temporales, se explica cómo recuperar datos de series temporales de las métricas con la API de Monitoring. Por ejemplo, en este documento, se describe cómo puedes usar la API para obtener el uso de la CPU de las instancias de máquina virtual (VM) en tu proyecto de Google Cloud.

La consola de Google Cloud proporciona una página exclusiva para ayudarte a ver el uso de las métricas definidas por el usuario. Para obtener información sobre el contenido de esta página, consulta Visualiza y administra el uso de métricas.

Descriptores de métricas para métricas definidas por el usuario

Cada tipo de métrica debe tener un descriptor de métrica que defina cómo se organizan los datos de la métrica. El descriptor de métrica también define las etiquetas y el nombre de la métrica. Por ejemplo, las listas de métricas muestran los descriptores de métricas para todos los tipos de métricas integradas.

Cloud Monitoring puede crear el descriptor de métrica por ti con los datos de métricas que escribes, o puedes crear el descriptor de métricas de forma explícita y, luego, escribir los datos de métricas. En cualquier caso, debes decidir cómo deseas organizar tus datos de métricas.

Ejemplo de diseño

Supongamos que tienes un programa que se ejecuta en una sola máquina y que este llama a los programas auxiliares A y B. Deseas contar la frecuencia con la que se llama a los programas A y B. También quieres saber cuándo se llama al programa A más de 10 veces por minuto y cuándo se llama al programa B más de 5 veces por minuto. Por último, supongamos que tienes un solo proyecto de Google Cloud y planeas escribir los datos en el recurso supervisado global.

En este ejemplo, se describen algunos diseños diferentes que podrías usar para tus métricas definidas por el usuario:

  • Debes usar dos métricas: Metric-type-A cuenta las llamadas al programa A y Metric-type-B al programa B. En este caso, Metric-type-A contiene 1 serie temporal y Metric-type-B contiene 1 serie temporal.

    Con este modo de datos, puedes crear una sola política de alertas con dos condiciones o puedes crear dos políticas de alertas con una condición. Una política de alertas puede admitir varias condiciones, pero tiene una sola configuración para los canales de notificaciones.

    Este modelo podría ser adecuado cuando no te interesan las similitudes de los datos entre las actividades que se supervisan. En este ejemplo, las actividades son la tasa de llamadas a los programas A y B.

  • Usas una sola métrica y una etiqueta para almacenar un identificador de programa. Por ejemplo, la etiqueta podría almacenar el valor A o B. La supervisión crea una serie temporal para cada combinación única de etiquetas. Por lo tanto, hay una serie temporal cuyo valor de etiqueta es A y otra serie temporal cuyo valor de etiqueta es B.

    Al igual que con el modelo anterior, puedes crear una sola política de alertas o dos políticas de alertas. Sin embargo, las condiciones de la política de alertas son más complicadas. Una condición que genere un incidente cuando la tasa de llamadas al programa A exceda un límite debe usar un filtro que incluya solo datos cuyo valor de etiqueta sea A.

    Una de las ventajas de este modelo es que es sencillo para calcular proporciones. Por ejemplo, puedes determinar qué cantidad del total se debe a las llamadas a A.

  • Usas una sola métrica para contar la cantidad de llamadas, pero no usas una etiqueta para registrar a qué programa se llamó. En este modelo, hay una sola serie temporal que combina los datos de los dos programas. Sin embargo, no puedes crear una política de alertas que cumpla con tus objetivos, ya que los datos de dos programas no se pueden separar.

Los dos primeros diseños te permiten cumplir con tus requisitos de análisis de datos. Sin embargo, el último no lo hace.

Para obtener más información, consulta Cómo crear una métrica definida por el usuario.

Nombres de las métricas definidas por el usuario

Cuando creas una métrica definida por el usuario, debes definir un identificador de cadena que represente el tipo de métrica. Esta cadena debe ser única entre las métricas definidas por el usuario de tu proyecto de Google Cloud y debe usar un prefijo que la marque como una métrica definida por el usuario. Para Monitoring, los prefijos permitidos son custom.googleapis.com/, workload.googleapis.com/, external.googleapis.com/user y external.googleapis.com/prometheus. Al prefijo le sigue un nombre que describe lo que recopilas. Para obtener más información sobre la forma recomendada de asignar un nombre a una métrica, consulta Convenciones de nombres de métricas. A continuación, se muestran ejemplos de los dos tipos de identificadores para los tipos de métricas:

    custom.googleapis.com/cpu_utilization
    custom.googleapis.com/instance/cpu/utilization

En el ejemplo anterior, el prefijo custom.googleapis.com indica que ambas métricas son métricas definidas por el usuario. Ambos ejemplos son de métricas que miden el uso de la CPU. Sin embargo, usan diferentes modelos de organización. Cuando anticipes tener una gran cantidad de métricas definidas por el usuario, te recomendamos que uses una estructura de nombres jerárquica como la que se usa en el segundo ejemplo.

Todos los tipos de métricas tienen identificadores únicos a nivel global llamados nombres de recursos. La estructura de un nombre de recurso para un tipo de métrica es la siguiente:

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

En el ejemplo anterior, METRIC_TYPE es el identificador de string del tipo de métrica. Si los ejemplos de métricas anteriores se crean en el proyecto my-project-id, los nombres de recursos de estas métricas serían los siguientes:

    projects/my-project-id/metricDescriptors/custom.googleapis.com/cpu_utilization
    projects/my-project-id/metricDescriptors/custom.googleapis.com/instance/cpu/utilization

¿Nombre o tipo? 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 string METRIC_TYPE.

Tipos de recursos supervisados para métricas definidas por el usuario

Cuando escribes tus datos en una serie temporal, debes indicar de dónde provienen. Para especificar la fuente de los datos, debes elegir un tipo de recurso supervisado que represente la procedencia de tus datos y, luego, usarlo para describir el origen específico. El recurso supervisado no forma parte del tipo de métrica. En su lugar, la serie temporal en la que escribes datos incluye una referencia al tipo de métrica y una referencia al recurso supervisado. El tipo de métrica describe los datos, mientras que el recurso supervisado describe dónde se originaron.

Ten en cuenta el recurso supervisado antes de crear tu descriptor de métrica. El tipo de recurso supervisado que uses afecta las etiquetas que debes incluir en el descriptor de métrica. Por ejemplo, el recurso de VM de Compute Engine contiene etiquetas para el ID del proyecto, el ID de la instancia y la zona de la instancia. Por lo tanto, si planeas escribir tu métrica en un recurso de VM de Compute Engine, las etiquetas de recursos incluyen el ID de la instancia para que no necesites una etiqueta para el ID de la instancia en el descriptor de métrica.

Cada uno de los datos de tu métrica debe estar asociado con un objeto de recurso supervisado. Los datos de diferentes objetos de recursos supervisados se mantienen en distintas series temporales.

Debes usar uno de los siguientes tipos de recurso supervisado con métricas definidas por el usuario:

Se suelen usar los objetos de recursos supervisados que representan los recursos físicos donde se ejecuta el código de tu aplicación. Este enfoque tiene varias ventajas:

  • Obtienes un mejor rendimiento en comparación con el uso de un solo tipo de recurso.
  • Evitas los datos fuera de orden causados por múltiples procesos que escriben en la misma serie temporal.
  • Puedes agrupar tus datos de métricas definidas por el usuario con otros datos de métricas de los mismos recursos.

global y recursos genéricos

Los tipos de recursos generic_task y generic_node son útiles en situaciones en las que ninguno de los tipos de recursos más específicos es apropiado. El tipo generic_task es útil para definir recursos similares a las tareas, como las aplicaciones. El tipo generic_node es útil para definir recursos similares a los nodos, como máquinas virtuales. Ambos tipos generic_* tienen varias etiquetas comunes que puedes usar a fin de definir objetos de recursos únicos, lo que facilita su uso en filtros de métricas para agregaciones y reducciones.

Por el contrario, el tipo de recurso global solo tiene la etiqueta project_id. Cuando tienes muchas fuentes de métricas dentro de un proyecto, usar el mismo objeto de recurso global puede provocar colisiones y reemplazos de los datos de métricas.

Métodos de la API que admiten métricas definidas por el usuario

En la siguiente tabla, se muestran qué métodos de la API de Monitoring admiten métricas definidas por el usuario y cuáles admiten métricas integradas:

Método de la API de Monitoring Permite el uso con
métricas definidas por el usuario		 Permite el uso con
métricas integradas
monitoredResourceDescriptors.get Sí sí
monitoredResourceDescriptors.list Sí sí
metricDescriptors.get Sí sí
metricDescriptors.list Sí sí
timeSeries.list Sí sí
timeSeries.create sí
metricDescriptors.create sí
metricDescriptors.delete Sí

Límites y latencias

Para conocer los límites relacionados con las métricas definidas por el usuario y la retención de datos, consulta Cuotas y límites.

Para mantener tus datos de métrica más allá del período de retención, debes copiarlos de forma manual en otra ubicación, como Cloud Storage o BigQuery.

Para obtener más información sobre las latencias asociadas con la escritura de datos en métricas definidas por el usuario, consulta Latencia de datos de métricas.

¿Qué sigue?