Después de recopilar métricas de tus cargas de trabajo implementadas en Google Distributed Cloud (GDC) aislado, puedes comenzar a analizarlas. Para analizar las métricas, puedes visualizarlas y filtrarlas en paneles informativos de Grafana, o bien acceder a ellas directamente desde Cortex con la herramienta curl para crear secuencias de comandos y automatizar procesos de forma flexible.
En esta página, se proporcionan instrucciones detalladas para consultar y visualizar tus métricas con la interfaz de usuario de Grafana y la herramienta curl para el extremo de Cortex, de modo que puedas obtener estadísticas sobre el rendimiento de tu carga de trabajo.
Puedes acceder a tus métricas de una de las siguientes dos maneras:
- Paneles de Grafana: Explora tendencias e identifica anomalías con visualizaciones intuitivas de métricas clave, como la utilización de la CPU, el consumo de almacenamiento y la actividad de la red. Grafana proporciona una interfaz fácil de usar para filtrar y analizar los datos de tu carga de trabajo en los paneles.
- Extremo de Cortex: Para casos de uso más avanzados, consulta directamente la instancia de Cortex de tu proyecto con la herramienta
curlen una línea de comandos. Cortex almacena las métricas de Prometheus de tu proyecto y proporciona un extremo HTTP para el acceso programático. Este acceso te permite exportar datos, automatizar tareas y crear integraciones personalizadas.
Antes de comenzar
Para obtener los permisos que necesitas para consultar y visualizar métricas en los paneles de Grafana, pídele a tu administrador de IAM de la organización o del proyecto que te otorgue uno de los roles predefinidos de visualizador de Grafana de la organización o del proyecto. Según el nivel de acceso y los permisos que necesites, es posible que obtengas roles de Grafana en una organización o un proyecto.
Como alternativa, para obtener los permisos que necesitas para consultar las métricas del extremo de Cortex, pídele al administrador de IAM del proyecto que te otorgue el rol de visualizador de Prometheus de Project Cortex en el espacio de nombres de tu proyecto.
En la siguiente tabla, se resumen los requisitos de Role para PA persona.
| Arquetipo | Objeto | Clúster | Rol | Espacio de nombres | Grupo/usuario | Configuración |
|---|---|---|---|---|---|---|
| PA | grafana | org-admin | project-grafana-viewer |
platform-obs | Grupo | 1 |
| PA | cortex | org-admin | project-cortex-prometheus-viewer |
platform-obs | Grupo | 2 |
| PA | grafana | org-admin | project-grafana-viewer |
platform-obs | Usuario | 3 |
| PA | cortex | org-admin | project-cortex-prometheus-viewer |
platform-obs | Usuario | 4 |
Reemplaza las siguientes variables según corresponda:
| Variable | Descripción |
|---|---|
KUBECONFIG |
Necesitarás el archivo kubeconfig del clúster específico que contiene el NAMESPACE en el que se aplicará este RoleBinding. |
RULE_NAME |
Nombre único de este recurso RoleBinding dentro del espacio de nombres. Por ejemplo, io-root-cortex-prometheus-viewer |
NAMESPACE |
Es el espacio de nombres de Kubernetes en el que se creará y aplicará este RoleBinding. Busca la columna Namespace en la tabla anterior. |
EMAIL_ADDRESS |
Es el identificador del usuario al que se le otorga el rol. A menudo, se trata de una dirección de correo electrónico. Por ejemplo, infrastructure-operator@example.com. |
ROLE |
Nombre del Role que contiene los permisos que deseas otorgar al usuario. Busca los roles disponibles en la tabla anterior. |
GROUP_NAME |
Nombre del Role que contiene los permisos que deseas otorgar al usuario. Por ejemplo, io-group |
ZONE |
Nombre de la zona |
Config. 1
Esta configuración es para el arquetipo PA, y tiene como objetivo el objeto grafana en el clúster org-admin.
Otorga el rol project-grafana-viewer dentro del espacio de nombres platform-obs a un Group.
Comando de Kubectl
Este es el formato genérico del comando:
kubectl --kubeconfig `KUBECONFIG` create rolebinding `RULE_NAME` -n platform-obs --group=`GROUP_NAME` --role=project-grafana-viewerEjemplo:
kubectl --kubeconfig <path-to-kubeconfig> create rolebinding project-grafana-viewers-binding --role=project-grafana-viewer --group=my-team --namespace=platform-obsRuta de acceso del archivo IAC
/infrastructure/zonal/zones/`ZONE`/org-admin/rolebindings/`GROUP_NAME`/<YAML_FILE>Archivo YAML
apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: name: RULE_NAME namespace: platform-obs subjects: - kind: Group name: GROUP_NAME apiGroup: rbac.authorization.k8s.io roleRef: kind: Role name: project-grafana-viewer apiGroup: rbac.authorization.k8s.io
Config. 2
Esta configuración es para el arquetipo PA, y tiene como objetivo el objeto cortex en el clúster org-admin.
Otorga el rol project-cortex-prometheus-viewer dentro del espacio de nombres platform-obs a un Group.
Comando de Kubectl
Este es el formato genérico del comando:
kubectl --kubeconfig `KUBECONFIG` create rolebinding `RULE_NAME` -n platform-obs --group=`GROUP_NAME` --role=project-cortex-prometheus-viewerEjemplo:
kubectl --kubeconfig <path-to-kubeconfig> create rolebinding project-cortex-prometheus-viewer-binding --role=project-cortex-prometheus-viewer --group=my-team --namespace=platform-obsRuta de acceso del archivo IAC
/infrastructure/zonal/zones/`ZONE`/org-admin/rolebindings/`GROUP_NAME`/<YAML_FILE>Archivo YAML
apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: name: RULE_NAME namespace: platform-obs subjects: - kind: Group name: GROUP_NAME apiGroup: rbac.authorization.k8s.io roleRef: kind: Role name: project-cortex-prometheus-viewer apiGroup: rbac.authorization.k8s.io
Config. 3
Esta configuración es para el arquetipo PA, y tiene como objetivo el objeto grafana en el clúster org-admin.
Otorga el rol project-grafana-viewer dentro del espacio de nombres platform-obs a un User.
Comando de Kubectl
Este es el formato genérico del comando:
kubectl --kubeconfig `KUBECONFIG` create rolebinding `RULE_NAME` -n platform-obs --user=`EMAIL_ADDRESS` --role=project-grafana-viewerEjemplo:
kubectl --kubeconfig <path-to-kubeconfig> create rolebinding project-grafana-viewers-binding --role=project-grafana-viewer --user=my-email@example.com --namespace=platform-obsRuta de acceso del archivo IAC
/infrastructure/zonal/zones/`ZONE`/org-admin/rolebindings/`EMAIL_ADDRESS`/<YAML_FILE>Archivo YAML
apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: name: RULE_NAME namespace: platform-obs subjects: - kind: User name: EMAIL_ADDRESS apiGroup: rbac.authorization.k8s.io roleRef: kind: Role name: project-grafana-viewer apiGroup: rbac.authorization.k8s.io
Config. 4
Esta configuración es para el arquetipo PA, y tiene como objetivo el objeto cortex en el clúster org-admin.
Otorga el rol project-cortex-prometheus-viewer dentro del espacio de nombres platform-obs a un User.
Comando de Kubectl
Este es el formato genérico del comando:
kubectl --kubeconfig `KUBECONFIG` create rolebinding `RULE_NAME` -n platform-obs --user=`EMAIL_ADDRESS` --role=project-cortex-prometheus-viewerEjemplo:
kubectl --kubeconfig <path-to-kubeconfig> create rolebinding project-cortex-prometheus-viewer-binding --role=project-cortex-prometheus-viewer --user=my-email@example.com --namespace=platform-obsRuta de acceso del archivo IAC
/infrastructure/zonal/zones/`ZONE`/org-admin/rolebindings/`EMAIL_ADDRESS`/<YAML_FILE>Archivo YAML
apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: name: RULE_NAME namespace: platform-obs subjects: - kind: User name: EMAIL_ADDRESS apiGroup: rbac.authorization.k8s.io roleRef: kind: Role name: project-cortex-prometheus-viewer apiGroup: rbac.authorization.k8s.io
Para obtener más información sobre estos roles, consulta Prepara los permisos de IAM.
Cómo obtener y filtrar tus métricas
Selecciona uno de los siguientes métodos para crear consultas, visualizar tendencias y filtrar métricas de las cargas de trabajo de tu proyecto:
Paneles de Grafana
En esta sección, se describe cómo acceder a tus métricas con los paneles de Grafana.
Identifica tu extremo de Grafana
La siguiente URL es el extremo de la instancia de Grafana de tu proyecto:
https://GDC_URL/PROJECT_NAMESPACE/grafana
Reemplaza lo siguiente:
GDC_URL: Es la URL de tu organización en GDC.PROJECT_NAMESPACE: Es el espacio de nombres de tu proyecto.Por ejemplo, el extremo de Grafana para el proyecto
platform-obsen la organizaciónorg-1eshttps://org-1/platform-obs/grafana.
Cómo ver las métricas en la interfaz de usuario de Grafana
Recupera métricas en la interfaz de usuario de Grafana:
- En la consola de GDC, selecciona tu proyecto.
- En el menú de navegación, selecciona Operaciones > Supervisión.
Haz clic en Ver todo en Grafana.
Se abrirá una nueva página con tu extremo de Grafana y se mostrará la interfaz de usuario.
En la interfaz de usuario, haz clic en Explorar Explorar en el menú de navegación para abrir la página Explorar.
En el menú de la barra Explorar, selecciona una fuente de datos para recuperar métricas según el tipo de universo:
Universos de una sola zona: Selecciona prometheus para mostrar las métricas de la única zona de tu universo.
Universos multizona: Grafana puede conectarse a diferentes zonas y mostrar datos entre zonas. Selecciona Métricas ZONE_NAME para mostrar las métricas de cualquier zona de tu universo, independientemente de la zona en la que hayas accedido.
Además, para tener visualizaciones de datos entre zonas en un solo panel y agregar varias zonas a tu consulta, selecciona Mixta como fuente de datos.
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 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 interfaz de usuario 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.
Extremo de Cortex
En esta sección, se describe cómo acceder a tus métricas con Cortex.
Identifica tu extremo de Cortex
La siguiente URL es el extremo de la instancia de Cortex de tu proyecto:
https://GDC_URL/PROJECT_NAMESPACE/cortex/prometheus/
Reemplaza lo siguiente:
GDC_URL: Es la URL de tu organización en GDC.PROJECT_NAMESPACE: Es el espacio de nombres de tu proyecto.Por ejemplo, el extremo de Cortex para el proyecto
platform-obsen la organizaciónorg-1eshttps://org-1/platform-obs/cortex/prometheus/.
Autentica la solicitud de curl
- Descarga y, luego, instala la CLI de gdcloud.
Configura la propiedad
core/organization_console_urlde gdcloud:gdcloud config set core/organization_console_url https://GDC_URLAccede con el proveedor de identidad configurado:
gdcloud auth loginUsa tu nombre de usuario y contraseña para autenticarte y acceder.
Cuando el acceso sea exitoso, podrás usar el encabezado de autorización en tu solicitud de curl a través del comando
gdcloud auth print-identity-token. Para obtener más información, consulta gdcloud auth.
Llama al extremo de Cortex
Completa los siguientes pasos para acceder al extremo de Cortex con la herramienta curl:
- Autentica la solicitud de
curl. Usa
curlpara llamar al extremo de Cortex y extender la URL con el formato de la API de HTTP para consultas y consultar métricas.El siguiente es un ejemplo de una solicitud
curl:curl https://GDC_URL/PROJECT_NAME/cortex/prometheus/api/v1/query?query=my_metric{cluster="my-cluster"}&time=2015-07-01T20:10:51.781Z \ -H "Authorization: Bearer $(gdcloud auth print-identity-token \ --audiences=https://GDC_URL)"Obtendrás el resultado después de ejecutar el comando. La respuesta de la API está en formato JSON.
Ejemplos de búsquedas y etiquetas
Puedes consultar métricas con el nombre de la métrica y pares clave-valor para las etiquetas. 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.
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. Por lo tanto, 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"}
Consulta Nombres de métricas y etiquetas para obtener más información sobre las métricas y las etiquetas.
A continuación, se muestran algunas de las etiquetas predeterminadas que agrega el recurso personalizado MonitoringTarget. Puedes usar estas etiquetas predeterminadas para consultar métricas:
_gdch_service: Es el nombre corto del servicio.cluster: el nombre del clústercontainer_name: Es el 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 Prometheus agrega automáticamente:
| 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:obs-system/OBS_SHADOW_PROJECT_NAME/MONITORINGTARGET_NAME.MONITORINGTARGET_NAMESPACE/I/JI 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 pares clave-valor para las etiquetas con el objetivo de consultar diferentes métricas:
Para ver todos los flujos de métricas de las operaciones procesadas en tu proyecto, haz lo siguiente:
processed_ops_totalVisualiza las operaciones procesadas recopiladas en un clúster de Kubernetes:
processed_ops_total{cluster="CLUSTER_NAME"}Sigue estos pasos para ver el uso de CPU recopilado en un clúster de Kubernetes:
cpu_usage{cluster="CLUSTER_NAME"}
Usa la herramienta de reetiquetado de métricas para agregar etiquetas que no se expusieron inicialmente en los contenedores recuperados y cambiar el nombre de las métricas producidas. Debes configurar el recurso personalizado MonitoringTarget para agregar etiquetas a las métricas que recopila.
Especifica esas etiquetas en el campo metricsRelabelings del recurso personalizado.
Para obtener más información, consulta Métricas de etiquetas.
Consultas a la API de HTTP
Descripción general del formato
Las respuestas de la API tienen un formato coherente en JSON. Las solicitudes exitosas siempre recibirán un código de estado 2xx.
En el caso de las solicitudes no válidas, los controladores de la API devolverán un objeto de error JSON junto con uno de los siguientes códigos de estado HTTP:
- 400 Bad Request: Si faltan parámetros esenciales o se proporcionan de forma incorrecta.
- 503, Servicio no disponible: Si las búsquedas exceden su límite de tiempo o se anulan.
Todos los datos que se recopilaron correctamente se incluirán en el campo "data" de la respuesta.
El formato del sobre de respuesta JSON es el siguiente:
{
"status": "success" | "error",
"data": <data>,
// Only set if status is "error". The data field may still hold
// additional data.
"errorType": "<string>",
"error": "<string>",
// Only set if there were warnings while executing the request.
// There will still be data in the data field.
"warnings": ["<string>"],
// Only set if there were info-level annotations while executing the request.
"infos": ["<string>"]
}
Consultas instantáneas
El siguiente endpoint evalúa una búsqueda instantánea en un solo punto en el tiempo:
GET /api/v1/query
POST /api/v1/query
Los siguientes parámetros de consulta de URL están disponibles para las consultas de expresiones de Prometheus:
query=<string>: Es la cadena de consulta de la expresión de Prometheus.time=<rfc3339 | unix_timestamp>: Es una marca de tiempo de evaluación opcional, especificada como una cadena RFC 3339 o una marca de tiempo de Unix. Si se omite, se usa la hora actual del servidor.timeout=<duration>: Es un tiempo de espera opcional para la evaluación. El valor predeterminado es el valor de la marca query.timeout, y está limitado por este.limit=<number>: Es la cantidad máxima opcional de series que se pueden devolver. Esto trunca las series para las matrices y los vectores, pero no afecta los escalares ni las cadenas. Un valor de 0 inhabilita este límite.lookback_delta=<number>: Es un parámetro opcional para anular el período de observación específicamente para esta búsqueda.
Si se omite el parámetro de tiempo, se usa la hora actual del servidor.
Para las búsquedas más grandes que podrían exceder los límites de caracteres de la URL, puedes enviar estos parámetros con el método POST. Asegúrate de que el cuerpo de la solicitud esté codificado como URL y que el encabezado Content-Type esté configurado como application/x-www-form-urlencoded.
La sección de datos del resultado de la consulta tiene el siguiente formato:
{
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
}
<value> hace referencia a los datos del resultado de la consulta, que tienen formatos variables según el valor de resultType.
En el siguiente ejemplo, se evalúa la expresión en el momento 2015-07-01T20:10:51.781Z:
curl 'http://localhost:9090/api/v1/query?query=up&time=2015-07-01T20:10:51.781Z'
{
"status" : "success",
"data" : {
"resultType" : "vector",
"result" : [
{
"metric" : {
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
"value": [ 1435781451.781, "1" ]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9100"
},
"value" : [ 1435781451.781, "0" ]
}
]
}
}
Consultas de rango
El siguiente extremo evalúa una consulta de expresión en un período:
GET /api/v1/query_range
POST /api/v1/query_range
Los siguientes parámetros de consulta de URL están disponibles para las consultas de expresiones de Prometheus:
query=<string>: Es la cadena de consulta de la expresión de Prometheus.start=<rfc3339 | unix_timestamp>: Marca de tiempo de inicio, inclusive.end=<rfc3339 | unix_timestamp>: Marca de tiempo de finalización, inclusive.step=<duration | float>: Ancho del paso de resolución de la búsqueda en formato de duración o número de segundos flotante.timeout=<duration>: Es un tiempo de espera opcional para la evaluación. El valor predeterminado es el valor de la marca query.timeout, y está limitado por este.limit=<number>: Es la cantidad máxima opcional de series que se pueden devolver. Esto trunca las series para las matrices y los vectores, pero no afecta los escalares ni las cadenas. Un valor de 0 inhabilita este límite.lookback_delta=<number>: Es un parámetro opcional para anular el período de observación específicamente para esta búsqueda.
Para las búsquedas más grandes que podrían exceder los límites de caracteres de la URL, puedes enviar estos parámetros con el método POST. Asegúrate de que el cuerpo de la solicitud esté codificado como URL y que el encabezado Content-Type esté configurado como application/x-www-form-urlencoded.
La sección de datos del resultado de la consulta tiene el siguiente formato:
{
"resultType": "matrix",
"result": <value>
}
En el siguiente ejemplo, se evalúa la expresión up en un rango de 30 segundos con una resolución de consulta de 15 segundos.
curl 'http://localhost:9090/api/v1/query_range?query=up&start=2015-07-01T20:10:30.781Z&end=2015-07-01T20:11:00.781Z&step=15s'
{
"status" : "success",
"data" : {
"resultType" : "matrix",
"result" : [
{
"metric" : {
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
"values" : [
[ 1435781430.781, "1" ],
[ 1435781445.781, "1" ],
[ 1435781460.781, "1" ]
]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9091"
},
"values" : [
[ 1435781430.781, "0" ],
[ 1435781445.781, "0" ],
[ 1435781460.781, "1" ]
]
}
]
}
}
Nombres de métricas y etiquetas
Lineamientos para asignar nombres a las métricas
Cuando definas nombres de métricas, ten en cuenta los siguientes principios:
El nombre de una métrica DEBE incluir un prefijo de aplicación de una sola palabra, al que las bibliotecas cliente a veces se refieren como un "espacio de nombres". Este prefijo identifica el dominio al que pertenece la métrica. En el caso de las métricas específicas de la aplicación, el nombre de la aplicación se suele usar como prefijo.
Ejemplos:
- prometheus_notifications_total (específico del servidor de Prometheus)
- process_cpu_seconds_total (exportada por muchas bibliotecas cliente)
- http_request_duration_seconds (para todas las solicitudes HTTP)
El nombre de una métrica DEBE representar una sola unidad (p.ej., evita mezclar segundos con milisegundos o segundos con bytes).
El nombre de una métrica DEBE usar unidades base (p.ej., segundos, bytes, metros) en lugar de unidades derivadas (p.ej., milisegundos, megabytes, kilómetros).
El nombre de una métrica DEBE incluir un sufijo de unidad en plural. En el caso de los recuentos acumulativos, se debe usar el sufijo "total" además del sufijo de la unidad, si corresponde.
Ejemplos:
- http_request_duration_seconds
- node_memory_usage_bytes
- http_requests_total (para un recuento acumulativo sin unidades)
- process_cpu_seconds_total (para un recuento acumulativo con unidad)
- foobar_build_info (para una seudométrica que proporciona metadatos sobre el archivo binario en ejecución)
El nombre de una métrica PUEDE ordenar sus componentes para facilitar la agrupación conveniente cuando se ordena lexicográficamente, siempre que se sigan todas las demás reglas. Las métricas relacionadas suelen tener componentes de nombres comunes que se colocan primero para garantizar que se ordenen juntas.
Ejemplos:
- prometheus_tsdb_head_truncations_closed_total
- prometheus_tsdb_head_truncations_established_total
- prometheus_tsdb_head_truncations_failed_total
- prometheus_tsdb_head_truncations_total
El nombre de una métrica DEBE representar de manera coherente la misma "cosa que se mide" lógica en todas las dimensiones de la etiqueta.
Ejemplos:
- duración de la solicitud
- bytes de transferencia de datos
- Uso instantáneo de recursos como porcentaje
Lineamientos para asignar nombres a las etiquetas
Cuando midas algo, usa etiquetas para distinguir sus características. Por ejemplo:
- En el caso de las solicitudes HTTP totales a la API (
api_http_requests_total), diferencia por tipo de operación, por ejemplo,create,update,delete(tipos de solicitudes:operation="create|update|delete"). - Para la duración de la solicitud a la API en segundos (
api_request_duration_seconds), diferencia por etapa de la solicitud, por ejemplo,extract,transform,load(etapas de la solicitud:stage="extract|transform|load").
Evita incluir nombres de etiquetas en el nombre de la métrica, ya que esto crea redundancia y puede generar confusión si esas etiquetas se agregan más adelante.