Puedes usar PromQL para realizar consultas y gráficos con los datos de Cloud Monitoring de las siguientes fuentes:
- Servicios deGoogle Cloud , como Google Kubernetes Engine o Compute Engine, que escriben métricas descritas en las listas de métricas del sistema de Cloud Monitoring.
- Las métricas definidas por el usuario, como las métricas basadas en registros y las métricas definidas por el usuario de Cloud Monitoring.
- Google Cloud Managed Service para Prometheus, la solución completamente administrada y de múltiples nubes para Prometheus deGoogle Cloud. Si deseas obtener más información sobre el servicio administrado, incluida la asistencia de PromQL, consulta Google Cloud Managed Service para Prometheus.
También puedes usar herramientas como Grafana para hacer gráficos con los datos de métricas transferidos a Cloud Monitoring. Las métricas disponibles incluyen las métricas del Servicio administrado para Prometheus y las métricas de Cloud Monitoring documentadas en las listas de métricas. Si deseas obtener información para configurar Grafana y otras herramientas basadas en la API de Prometheus, consulta la documentación de Managed Service para Prometheus sobre Grafana.
También puedes importar tus paneles de Grafana a Cloud Monitoring.
Consulta las métricas de Cloud Monitoring con PromQL
Las métricas de Cloud Monitoring se pueden consultar con la especificación UTF-8 para PromQL. Los nombres de métricas en UTF-8 deben estar entre comillas y moverse dentro de los corchetes. Los nombres de las etiquetas también deben estar entre comillas si contienen caracteres incompatibles con versiones anteriores. Para la métrica de Cloud Monitoring kubernetes.io/container/cpu/limit_utilization, las siguientes consultas son equivalentes:
{"kubernetes.io/container/cpu/limit_utilization", pod_name="foo"}{__name__="kubernetes.io/container/cpu/limit_utilization", pod_name="foo"}{"__name__"="kubernetes.io/container/cpu/limit_utilization", "pod_name"="foo"}
Las métricas con valor de distribución de Cloud Monitoring se pueden consultar como histogramas de Prometheus, con el sufijo _count, _sum o _bucket agregado al nombre de la métrica.
Puedes usar etiquetas de metadatos en PromQL como cualquier otra etiqueta, aunque, al igual que los nombres de métricas, las etiquetas de metadatos también deben ser compatibles con PromQL. La sintaxis para referirse a una etiqueta del sistema de metadatos version es metadata_system_version y la sintaxis para la etiqueta de usuario de metadatos version es metadata_user_version. Las consultas de PromQL bien formadas que usan etiquetas de metadatos podrían tener el siguiente aspecto:
{"compute.googleapis.com/instance/cpu/utilization", monitored_resource="gce_instance",metadata_user_env="prod"}sum("compute.googleapis.com/instance/cpu/utilization") by (metadata_system_region)sum("compute.googleapis.com/instance/cpu/utilization") by (metadata_user_env){"compute.googleapis.com/instance/uptime_total", "metadata_user_i-love.special/chars"="yes"}sum("compute.googleapis.com/instance/uptime_total") by ("metadata_user_i-love.special/chars")
Si la clave de la etiqueta de metadatos contiene caracteres especiales que no sean el carácter _, debes incluir la clave de la etiqueta entre comillas dobles (") según la especificación UTF-8 de PromQL.
Aún debes agregar el prefijo metadata_user_ a la etiqueta de metadatos.
Los gráficos y los paneles creados antes de la compatibilidad con UTF-8 consultan las métricas de Cloud Monitoring convirtiendo sus nombres en equivalentes heredados compatibles con PromQL. Para obtener más información sobre las reglas de conversión de PromQL heredado, consulta Asigna métricas de Cloud Monitoring a PromQL heredado.
Accede a PromQL en Cloud Monitoring
Puedes usar PromQL desde la pestaña Código en las siguientes páginas de la consola de Google Cloud :
- Explorador de métricas
- Agregar gráfico cuando se crean paneles personalizados
Para obtener información sobre cómo acceder al editor y usarlo, consulta Usa el editor de PromQL.
Reglas y alertas de PromQL
Puedes usar PromQL para crear políticas de alertas para cualquier métrica en Cloud Monitoring. Para obtener más información, consulta Políticas de alertas basadas en PromQL.
También puedes usar PromQL para crear reglas de grabación y alertas en cualquier métrica de Cloud Monitoring con alertas en el clúster de estilo Prometheus en Cloud Monitoring. Para obtener más información, consulta Evaluación y alertas de reglas administradas o Evaluación y alertas de reglas implementadas de forma automática.
Aprende acerca de PromQL
Para aprender los conceptos básicos del uso de PromQL, te recomendamos consultar la documentación de código abierto. Los siguientes recursos pueden ayudarte a comenzar:
Especifica un tipo de recurso supervisado
Cuando una métrica de Cloud Monitoring se asocia a un solo tipo de recurso supervisado de Cloud Monitoring, las consultas de PromQL funcionarán sin especificar un tipo de recurso de forma manual. Sin embargo, algunas métricas dentro de Cloud Monitoring, incluidas algunas métricas del sistema y muchas de las que generan las métricas basadas en registros, se asignan a más de un tipo de recurso. Si usas una de estas métricas, en especial las métricas basadas en registros, debes especificar de forma explícita el tipo de recurso.Puedes ver qué tipos de recursos supervisados se asignan a una métrica si realizas una de las siguientes acciones:
- Para las métricas seleccionadas por Google, puedes consultar las listas de métricas disponibles, incluidas las métricas deGoogle Cloud y las métricas de Kubernetes. Cada entrada en la documentación enumera los tipos de recursos supervisados asociados en la primera columna de cada entrada debajo del tipo. Si no se enumeran tipos de recursos supervisados, la métrica se puede asociar con cualquier tipo.
En el Explorador de métricas, puedes hacer lo siguiente:
- Ingresa el nombre de tu métrica en el campo Seleccionar una métrica y, luego, navega por los menús para seleccionarla. En el menú de recursos, se enumeran los tipos de recursos válidos para esa métrica, por ejemplo, “Instancia de VM”.
En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre es < > PromQL.
La consulta de PromQL que se muestra indica el tipo de recurso como el valor del campo
monitored_resource. En particular, este método es útil para las métricas que se pueden asociar con muchos tipos de recurso supervisado, por ejemplo, métricas basadas en registros, métricas personalizadas o cualquier métrica definida por el usuario.
Si una métrica está asociada con más de un tipo de recurso, debes especificar el tipo de recurso en tu consulta de PromQL. Existe una etiqueta especial, monitored_resource, que puedes usar para seleccionar el tipo de recurso.
Los tipos de recursos supervisados en la mayoría de los casos son una string corta, como gce_instance, pero a veces aparecen como URI completos, como monitoring.googleapis.com/MetricIngestionAttribution. Las consultas de PromQL bien formadas podrían tener el siguiente aspecto:
logging_googleapis_com:byte_count{monitored_resource="k8s_container"}custom_googleapis_com:opencensus_opencensus_io_http_server_request_count_by_method{monitored_resource="global"}loadbalancing_googleapis_com:l3_external_egress_bytes_count{monitored_resource="loadbalancing.googleapis.com/ExternalNetworkLoadBalancerRule"}
El valor de "" para la etiqueta monitored_resource es especial y se refiere al tipo de recurso predeterminado prometheus_target que se usa para las métricas de Cloud Monitoring.
Si no usas la etiqueta monitored_resource cuando es necesario, verás el siguiente error:
metric is configured to be used with more than one monitored resource type;
series selector must specify a label matcher on monitored resource name
Resuelve conflictos de etiquetas
En Cloud Monitoring, las etiquetas pueden pertenecer a la métrica o al recurso.
Si una etiqueta de métrica tiene el mismo nombre de clave que una etiqueta de recurso, puedes consultar la etiqueta de métrica de forma específica si agregas el prefijo metric_ al nombre de la clave de la etiqueta en tu consulta.
Por ejemplo, supongamos que tienes una etiqueta de recurso y una etiqueta de métrica llamadas pod_name en la métrica example.googleapis.com/user/widget_count.
Para filtrar el valor de la etiqueta de recurso, usa
example_googleapis_com:user_widget_count{pod_name="RESOURCE_LABEL_VALUE"}Para filtrar el valor de la etiqueta de métrica, usa
example_googleapis_com:user_widget_count{metric_pod_name="METRIC_LABEL_VALUE"}
Asigna nombres de métricas de Cloud Monitoring a PromQL heredado
Los nombres de las métricas de Cloud Monitoring incluyen dos componentes, un dominio (como compute.googleapis.com/) y una ruta de acceso (como instance/disk/max_read_ops_count). Debido a que PromQL heredado solo admite los caracteres especiales : y _, debes aplicar las siguientes reglas para que los nombres de métricas de Monitoring sean compatibles con PromQL heredado:
- Reemplaza el primer
/por:. - Reemplaza todos los demás caracteres especiales (incluidos
.y otros caracteres/) por_.
En la siguiente tabla, se enumeran algunos nombres de métricas y sus equivalentes de PromQL heredado:
| Nombre de la métrica de Cloud Monitoring | Nombre de la métrica de PromQL heredada |
|---|---|
kubernetes.io/container/cpu/limit_cores |
kubernetes_io:container_cpu_limit_cores |
compute.googleapis.com/instance/cpu/utilization |
compute_googleapis_com:instance_cpu_utilization |
logging.googleapis.com/log_entry_count |
logging_googleapis_com:log_entry_count |
custom.googleapis.com/opencensus/opencensus.io/ |
custom_googleapis_com:opencensus_opencensus_io_ |
agent.googleapis.com/disk/io_time |
agent_googleapis_com:disk_io_time |
Las métricas con valor de distribución de Cloud Monitoring se pueden consultar como histogramas de Prometheus, con el sufijo _count, _sum o _bucket agregado al nombre de la métrica:
| Nombre de la métrica de Cloud Monitoring | Nombres de métricas de PromQL heredadas |
|---|---|
networking.googleapis.com/vm_flow/rtt |
networking_googleapis_com:vm_flow_rtt_sumnetworking_googleapis_com:vm_flow_rtt_countnetworking_googleapis_com:vm_flow_rtt_bucket
|
Compatibilidad con PromQL
PromQL para Cloud Monitoring podría funcionar de manera un poco diferente que PromQL ascendente.
Las consultas de PromQL en Cloud Monitoring se evalúan de forma parcial en el backend de Monarch con un lenguaje de consultas interno, y existen algunas diferencias conocidas en los resultados de la consulta. Aparte de las diferencias que se mencionan en esta sección, PromQL en Cloud Monitoring está a la par de PromQL disponible en la versión 2.44 de Prometheus.Es posible que las funciones de PromQL agregadas después de la versión 2.44 de Prometheus no sean compatibles.
Compatibilidad con UTF-8
PromQL para Cloud Monitoring admite consultas en UTF-8.
Si el nombre de tu métrica de Prometheus solo consta de caracteres alfanuméricos más los caracteres _ o :, y si las claves de tus etiquetas solo constan de caracteres alfanuméricos más el carácter _, puedes realizar consultas con la sintaxis tradicional de PromQL.
Por ejemplo, una consulta válida podría verse así: job:my_metric:sum{label_key="label_value"}.
Sin embargo, si el nombre de la métrica de Prometheus usa caracteres especiales, excepto _ o :, o si las claves de etiquetas usan caracteres especiales, excepto _, debes crear la consulta según la especificación UTF-8 para PromQL.
Los nombres de métricas en UTF-8 deben estar entre comillas y dentro de los corchetes. Los nombres de etiquetas también deben estar entre comillas si contienen caracteres incompatibles con versiones anteriores. Los siguientes ejemplos de consultas válidas son todos equivalentes:
{"my.domain.com/metric/name_bucket", "label.key"="label.value"}{__name__="my.domain.com/metric/name_bucket", "label.key"="label.value"}{"__name__"="my.domain.com/metric/name_bucket", "label.key"="label.value"}
Coincidencias en nombres de métricas
Solo se admite la coincidencia exacta en los nombres de métricas. Debes incluir una coincidencia exacta del nombre de la métrica en tu consulta.
Recomendamos las siguientes soluciones alternativas para situaciones comunes que usan un comparador de expresiones regulares en la etiqueta __name__:
- Las configuraciones del adaptador de Prometheus suelen usar el operador
=~para hacer coincidir varios nombres de métricas. Para corregir este uso, expande la configuración para usar una política separada para cada métrica y nombra cada métrica de forma explícita. Esto también evita que se realice un ajuste de escala automático accidental en métricas inesperadas. - Las expresiones regulares se suelen usar para representar varias métricas no dimensionales en el mismo gráfico. Por ejemplo, si tienes una métrica como
cpu_servicename_usage, puedes usar un comodín para generar un gráfico de todos tus servicios juntos. Usar métricas no dimensionales como esta es una práctica explícitamente incorrecta en Cloud Monitoring, y esta práctica genera un rendimiento extremadamente bajo de las consultas. Para corregir este uso, traslada toda la dimensionalidad a las etiquetas de métricas en lugar de incorporar dimensiones en el nombre de la métrica. - Las consultas sobre varias métricas se suelen usar para ver qué métricas están disponibles para la consulta. En su lugar, te recomendamos que uses la llamada
/labels/__name__/valuespara descubrir métricas. También puedes descubrir métricas con la IU de Cloud Monitoring. - La correlación de varias métricas es útil para ver cuántas muestras se recuperaron, transfirieron y cobraron por métrica. Cloud Monitoring te proporciona esta información en la página Administración de métricas. También puedes acceder a esta información como datos de métricas con la métrica Samples Ingested o la métrica Samples Written by Attribution ID.
Inactivo
La inactividad no es compatible con el backend de Monarch.
Cálculo de irate
Cuando el período de visualización de la función irate es menor que el tamaño del paso, aumentamos la ventana al tamaño del paso.
Monarch requiere este cambio para garantizar que ninguno de los datos de entrada se ignore por completo en el resultado. Esta diferencia también se aplica a los cálculos de rate.
Cálculo de rate y increase
Cuando el período de visualización de la función rate es menor que el tamaño del paso, aumentamos la ventana al tamaño del paso.
Monarch requiere este cambio para garantizar que ninguno de los datos de entrada se ignore por completo en el resultado. Esta diferencia también se aplica a los cálculos de irate.
Existen diferencias en los cálculos de interpolación y extrapolación. Monarch usa un algoritmo de interpolación diferente al de Prometheus, y esta diferencia puede generar resultados un poco diferentes. Por ejemplo, los ejemplos de contador Monarch se almacenan con un intervalo de tiempo en lugar de la marca de tiempo única que usa Prometheus. Por lo tanto, las muestras de contadores en Monarc se pueden incluir en un cálculo de frecuencia aunque la marca de tiempo de Prometheus las excluya. Por lo general, esto da como resultado resultados más precisos, en especial cuando se consulta el principio o el final de las series temporales subyacentes.
Cálculo de histogram_quantile
Un cálculo de histogram_quantile de PromQL en un histograma sin muestras produce un valor de NaN. El cálculo del lenguaje de consulta interno no produce ningún valor, sino que se descarta el punto en la marca de tiempo.
Las diferencias de cálculo de frecuencia también pueden afectar la entrada a las consultas histogram_quantile.
Funciones de tipo específico en métricas de tipado diferente
Aunque Prometheus upstream es de tipado débil, Monarch es de tipado fuerte. Esto significa que la ejecución de funciones específicas de un solo tipo en una métrica de tipado diferente (por ejemplo, ejecutar rate() en una métrica GAUGE o histogram_quantile() en una métrica COUNTER o sin tipado) no funciona en Cloud Monitoring, aunque estas funciones funcionan en Prometheus upstream.