Consulta y visualiza métricas

Después de recopilar métricas de las cargas de trabajo implementadas en tu proyecto de GDC, puedes consultar y ver métricas en los paneles desde la instancia de supervisión del sistema del proyectoo consultar métricas desde la API de HTTP del dispositivo aislado de GDC.

Consulta y visualiza métricas en paneles

La instancia de Grafana de tu proyecto, que también se denomina instancia de supervisión del sistema, incluye datos para supervisar los componentes a nivel del proyecto para la observabilidad de los datos, como el uso de la CPU, el consumo de almacenamiento, la supervisión de la red, la supervisión del servidor, los registros, las alertas y las métricas.

Para ver las métricas, usa los paneles en la página Explorar de la instancia de supervisión del sistema. Para ver métricas específicas, realiza consultas desde la página Explorar.

Antes de comenzar

Antes de consultar y ver las métricas en los paneles, debes obtener acceso a la instancia de supervisión. Para obtener más información, consulta Cómo obtener acceso a los paneles.

Crea consultas para tus métricas

Supervisa y consulta las métricas para fines de observabilidad de los datos en tus aplicaciones a través de la instancia de supervisión del sistema de tu proyecto. La interfaz de usuario (IU) integrada de la instancia contiene paneles predeterminados de componentes estándar y paneles personalizados que creas para las necesidades específicas de tu caso de uso. Si tu entorno está en funcionamiento, verás de inmediato algunos paneles de métricas en la página Available Dashboards.

Consulta las métricas desde la IU para recuperarlas visualmente de tu proyecto y obtener una vista integrada para supervisar tus aplicaciones. Para filtrar los resultados, busca métricas por etiquetas con expresiones del lenguaje de consulta.

Extremo de la instancia de supervisión del sistema

La siguiente URL es el extremo de la instancia de supervisión del proyecto platform-obs:

https://GDC_URL/PROJECT_NAMESPACE/grafana

Reemplaza lo siguiente:

• GDC_URL: La URL de tu organización en GDC
• PROJECT_NAMESPACE: Es el espacio de nombres de tu proyecto.

Métricas de consultas

Completa los siguientes pasos para consultar las métricas de tu proyecto:

Para recuperar las métricas, completa los siguientes pasos:

1. En la consola de GDC, selecciona un proyecto.
2. En el menú de navegación, haz clic en Operaciones > Monitoring.
3. Haz clic en Ver todo en Grafana.

Se abrirá una nueva página con la URL de la instancia de supervisión de tu proyecto.

1. En la IU de la instancia de supervisión, haz clic en Explorar Explorar en el menú de navegación para abrir la página Explorar.
2. En el menú desplegable de la barra Explorar, selecciona prometheus para recuperar métricas.

3. Ingresa una consulta para buscar métricas con expresiones de PromQL (lenguaje de consulta de Prometheus). Puedes realizar este paso de una de las siguientes maneras:

   • Selecciona una métrica y una etiqueta para tu búsqueda en los menús desplegables Métrica y Filtros de etiquetas. Haz clic en agregar Agregar para agregar más etiquetas a tu búsqueda. Luego, haz clic en Ejecutar consulta.
   • Ingresa tu consulta directamente en el campo de texto Métricas y presiona Mayúsculas + Intro para ejecutarla.

   En la página, se muestran las métricas que coinciden con tu búsqueda.

Figura 1. Opción de menú para consultar métricas desde la IU de Grafana.

En la figura 1, la opción prometheus muestra la interfaz que te permite crear consultas desde Grafana para recuperar métricas.

Para ver ejemplos de valores de etiquetas que puedes usar para consultar métricas, consulta Ejemplos de consultas y etiquetas.

Ejemplos de búsquedas y etiquetas

Puedes consultar las métricas recopiladas con el nombre de la métrica y las etiquetas de clave-valor. Por este motivo, una consulta de PromQL tiene la siguiente sintaxis:

metric_name{label_one="value", label_two="value"}

Las etiquetas te permiten diferenciar las características de una métrica. De esta manera, los autores de contenedores hacen que sus cargas de trabajo generen métricas y agreguen etiquetas para filtrar esas métricas según sus necesidades. Por ejemplo, puedes tener una métrica api_http_requests_total para contar la cantidad de solicitudes HTTP recibidas. Luego, puedes agregar una etiqueta request_method a esta métrica, que toma un valor POST, GET o PUT. En consecuencia, crearás tres flujos de métricas para cada tipo de solicitud que puedas recibir. En este caso, para encontrar la cantidad de solicitudes HTTP GET, ejecuta la siguiente consulta:

api_http_requests_total{request_method="GET"}

Nota: Consulta https://prometheus.io/docs/practices/naming/ para obtener más información sobre las métricas y las etiquetas.

Estas son algunas de las etiquetas predeterminadas que agrega el recurso personalizado MonitoringTarget y que puedes usar para consultar métricas:

• _gdch_service: Nombre corto del servicio
• cluster: el nombre del clúster
• container_name: Nombre del contenedor dentro de un pod
• namespace_name: Es el espacio de nombres de tu proyecto.
• pod_name: Es el prefijo del nombre del Pod.

En la siguiente tabla, se describen las etiquetas que el servicio de extracción agrega automáticamente:

Etiquetas predeterminadas del servicio de extracción

Etiqueta de métrica	Descripción
job	Es el nombre interno del trabajo de extracción que se usa para recopilar la métrica. Los trabajos creados por el recurso personalizado MonitoringTarget tienen un nombre con el siguiente patrón: PROJECT_NAME-obs-system/MONITORINGTARGET_NAME.MONITORINGTARGET_NAMESPACE/I/J PROJECT_NAME-obs-system/MONITORINGTARGET_NAME.MONITORINGTARGET_NAMESPACE/I/J I y J son números únicos que se determinan de forma interna para evitar conflictos de nombres.
instance	Es el $IP:$PORT del servicio recuperado. Si un recurso de carga de trabajo tiene varias réplicas, usa este campo para diferenciarlas.

En los siguientes ejemplos de código, se muestra el uso de etiquetas y valores para consultar diferentes métricas de observabilidad de los datos:

• Para ver todos los flujos de métricas de las operaciones procesadas en tu proyecto, haz lo siguiente:

  processed_ops_total
  

• Visualiza las operaciones procesadas recopiladas en un clúster:

  processed_ops_total{cluster="CLUSTER_NAME"}
  

• Sigue estos pasos para ver el uso de CPU recopilado en un clúster:

  cpu_usage{cluster="CLUSTER_NAME"}
  

Usa la herramienta de reetiquetado de métricas para agregar etiquetas que no se expusieron inicialmente en los contenedores analizados y cambiar el nombre de las métricas producidas. Debes configurar el CR MonitoringTarget para agregar etiquetas a las métricas que recopila. Especifica esas etiquetas en el campo metricsRelabelings de la CR. Para obtener más información, consulta Métricas de etiquetas.

Consulta métricas desde la API de Cortex

Cortex es el almacenamiento a largo plazo para las métricas de Prometheus en GDC. La plataforma de Observabilidad expone un extremo de API de HTTP de Cortex para consultar y leer métricas, alertas y otros datos de series temporales de Prometheus de tu proyecto.

Consulta las métricas directamente desde la API de HTTP para leer y exportar métricas y otros datos de series temporales a herramientas externas, configurar tareas automatizadas, adaptar respuestas y crear integraciones según tu caso de uso de supervisión del sistema. Por ejemplo, puedes insertar el resultado en otro comando, exportar detalles a formatos de archivo de texto o configurar un trabajo cron de Linux. Puedes llamar a la API desde la interfaz de línea de comandos (CLI) o un navegador web, y usar expresiones del lenguaje de consultas como parámetros de extremos para obtener el resultado en formato JSON.

En esta sección, se explica cómo llamar extremo de API de Cortex desde la CLI con la especificación de la API de Prometheus para consultar métricas de observabilidad de los datos.

Antes de comenzar

Debes obtener autorización para consultar métricas desde la CLI. Para obtener los permisos que necesitas para acceder extremo de API de Cortex, pídele al administrador de IAM del proyecto que te otorgue el rol de visualizador de Prometheus de Project Cortex (project-cortex-prometheus-viewer).

Crea las siguientes vinculaciones de roles con los comandos de kubectl para Cortex Prometheus para cada arquetipo:

1. Administrador raíz del operador de infraestructura (IO) - Project Cortex Prometheus Viewer:

   kubectl --kubeconfig $HOME/root-admin-kubeconfig create rolebinding 
   io-cortex-prometheus-viewer-binding -n infra-obs 
   --user=[e-mail] 
   --role=project-cortex-prometheus-viewer
   

2. Administrador raíz de Platform-Admin (PA) - Project Cortex Prometheus Viewer:

   kubectl --kubeconfig $HOME/root-admin-kubeconfig create rolebinding 
   pa-cortex-prometheus-viewer-binding -n platform-obs 
   --user=[e-mail] --role=project-cortex-prometheus-viewer
   

3. Administrador raíz del operador de aplicaciones (AO) - Project Cortex Prometheus Viewer :

   kubectl --kubeconfig $HOME/root-admin-kubeconfig create rolebinding 
   project-cortex-prometheus-viewer-binding -n PROJECT_NAME 
   --user=USER_NAME --role=project-cortex-prometheus-viewer
   

   Reemplaza lo siguiente:

   • PROJECT_NAME: el nombre del proyecto.
   • USER_NAME: Es el nombre de la cuenta del usuario que requiere la vinculación del rol.

Después de crear la vinculación del rol, puedes acceder a la API de Prometheus con tu nombre de usuario de acceso.

Extremo de API de HTTP

La siguiente URL es el extremo de API de HTTP para acceder a las métricas en el proyecto platform-obs:

https://GDC_URL/PROJECT_NAME/cortex/prometheus/

Reemplaza lo siguiente:

• GDC_URL: URL de tu organización en GDC.
• PROJECT_NAME: el nombre del proyecto.

Nota: Puedes abrir directamente la URL en un navegador web para consultar las métricas.

En las instrucciones de la siguiente sección, se usa el comando curl para llamar al extremo de la API, pero lo mismo se aplica a un navegador web.

Llama extremo de API

Sigue estos pasos para acceder extremo de API de Cortex desde la CLI y consultar métricas:

1. Asegúrate de cumplir con los requisitos.
2. Abre la CLI.

3. Usa la herramienta curl para llamar al extremo de Cortex y extender la URL con el estándar https://prometheus.io/docs/prometheus/latest/querying/api/ para consultar métricas. Por ejemplo:

   curl https://console.org-1.zone1.google.gdch.test/alice/cortex/prometheus/api/v1/query?query=my_metric{cluster="org-1-system"}&time=2015-07-01T20:10:51.781Z
   

Obtendrás el resultado en la CLI después del comando. El formato de respuesta de la API es JSON.

Nota: Agrega el extremo api/v1/query para consultar las métricas de la URL. Puedes incluir parámetros opcionales para tu llamada a la API después de un signo de interrogación (?) al final de la URL. Separa estos parámetros con símbolos de ampersand (&), como en el ejemplo de la consulta del último paso.