En este documento, se explica cómo usar la API de Cloud Monitoring para obtener listas o descripciones de lo siguiente:
- Tipos de métricas definidas por el usuario y definidas en tu proyecto.
- Tipos de métricas de terceros con datos de series temporales en tu proyecto.
Métricas generadas por BindPlane
son ejemplos de métricas de terceros. Las métricas de BindPlane tienen un prefijo de
workload.googleapis.com/3rd-party-app-name/
. Para obtener una lista completa de las métricas de aplicaciones de terceros admitidas, consulta la Fuentes de BindPlane. - Tipos de métricas integradas que proporciona Google Cloud. Estos tipos de métricas pueden ayudarte a diseñar tus métricas definidas por el usuario. También puedes encontrar información sobre estas métricas en la documentación; consulta la Lista de métricas.
- Tipos de recursos supervisados disponibles para tu proyecto. También puedes encontrar información sobre estos recursos en la documentación; consulta la Lista de recursos supervisados.
Para ejecutar los métodos sin escribir ningún código, en los ejemplos de las pestañas Protocolo de esta página se usa el Explorador de API basado en formularios. (Consulta Explorador de APIs para obtener más información sobre esta herramienta).
Para aprender a usar los métodos de los lenguajes de programación seleccionados, consulta las muestras de códigos ejecutables en esta página.
Antes de comenzar
- Para obtener una introducción a las métricas y los recursos supervisados, consulta Métricas, series temporales y recursos.
Enumerar descriptores de métrica
Los descriptores de métricas son los esquemas que definen las métricas. Para obtener detalles sobre las métricas que te interesan, explora los descriptores de métricas disponibles:- Métricas integradas: puedes emitir solicitudes a la API de cualquier proyecto existente o puedes usar la documentación de las listas de métricas.
- Métricas externas y definidas por el usuario: Debes emitir la solicitud a la API de un proyecto en el que se defina la métrica definida por el usuario o donde existan datos de series temporales para la métrica.
Para obtener más información sobre el nombre de los tipos de métricas, consulta Convenciones de nombres.
Enumerar tipos de métricas
Para obtener una lista actual de descriptores de métricas, usa el método metricDescriptors.list
.
Para limitar el conjunto de tipos de métricas que se muestran, usa un filtro.
Para obtener ayuda con la elección de los tipos de métricas que se deben buscar, consulta Tipos de valores y clases de métricas.
Protocolo
Abre la página de referencia de
metricDescriptors.list
.En el panel etiquetado Probar este método, ingresa lo siguiente:
- name:
projects/PROJECT_ID
. ReemplazaPROJECT_ID
por el ID del proyecto de Google Cloud. - filter:
metric.type = starts_with("compute.googleapis.com")
- name:
Haz clic en Ejecutar.
En la siguiente respuesta de ejemplo, se muestran algunos de los descriptores de métricas recuperados:
"metricDescriptors": [ { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_bytes_count", "labels": [{...}], ... "description": "Count of incoming bytes dropped by the firewall.", "displayName": "Dropped bytes", "type": "compute.googleapis.com/firewall/dropped_bytes_count", ... }, { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [{...}], ... "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }, ... ]
El valor type
en cada descriptor identifica el descriptor de métrica, por
ejemplo, compute.googleapis.com/firewall/dropped_packets_count
. A veces, este valor también se denomina “tipo de métrica” o “nombre de tipo de métrica”.
Para ver la solicitud como un comando curl
, como una solicitud HTTP o en JavaScript, haz clic en fullscreen Pantalla completa en el Explorador de API.
C#
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Go
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
PHP
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Ruby
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Si tienes dificultades, consulta Solución de problemas de llamadas a la API.
Obtener descriptores de métricas
Para obtener información sobre un solo tipo de métrica, usa el método metricDescriptors.get
.
Este método muestra un descriptor de métrica.
Para recuperar un descriptor de métrica específico, debes proporcionar el nombre completo de la métrica a la API. El nombre completo se construye a partir de dos componentes:
- Un prefijo que consta de
projects/PROJECT_ID/metricDescriptors
- El valor
type
que identifica el descriptor de métrica, por ejemplo,compute.googleapis.com/firewall/dropped_packets_count
. Consulta la pestaña Protocolo en Tipos de métricas de lista para obtener más información sobre el valortype
.
A continuación, se muestra un ejemplo del nombre completo de una métrica:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Protocolo
Para obtener el descriptor de /firewall/dropped_packets_count
de Compute Engine
de registro, haz lo siguiente:
Abre la página de referencia de
metricDescriptors.list
.En el panel Prueba este método, ingresa lo siguiente:
name:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Reemplaza
PROJECT_ID
por el ID del proyecto de Google Cloud.
Haz clic en Ejecutar.
La siguiente respuesta de ejemplo muestra el descriptor de la métrica:
{ "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [ { "key": "instance_name", "description": "The name of the VM instance." } ], "metricKind": "DELTA", "valueType": "INT64", "unit": "1", "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }
Para ver la solicitud como un comando curl
, como un
Solicitud HTTP o, en JavaScript, haz clic en fullscreen Pantalla completa.
del Explorador de APIs.
C#
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Go
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
PHP
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Ruby
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Si tienes dificultades, consulta Solución de problemas de llamadas a la API.
Enumerar recursos supervisados
Los recursos supervisados son entidades de la nube que se pueden supervisar. Para encontrar los tipos de entidades que tienen métricas, explora la lista de tipos de recursos supervisados.
Para obtener información sobre los recursos supervisados, puedes emitir solicitudes a la API de cualquier proyecto existente o puedes usar la documentación de la Lista de recursos supervisados.
Enumera los tipos de recursos
Para obtener una lista actualizada de los tipos de recursos supervisados de la API de Monitoring, usa el método monitoredResourceDescriptors.list
y proporciona tu ID del proyecto.
Protocolo
Abre la página de referencia de
monitoredResourceDescriptors.list
.En el panel etiquetado Probar este método, ingresa lo siguiente:
- name:
projects/PROJECT_ID
. ReemplazaPROJECT_ID
por el ID de tu proyecto de Google Cloud.
- name:
Haz clic en Ejecutar.
En la siguiente respuesta de muestra, se presentan algunos de los tipos de recursos supervisados mostrados:
{ "resourceDescriptors": [ { "type": "aiplatform.googleapis.com/Endpoint", "displayName": "AI Platform Endpoint", "description": "A Cloud AI Platform API Endpoint where Models are deployed into it.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Endpoint", }, { "type": "aiplatform.googleapis.com/Featurestore", "displayName": "AI Platform Feature Store", "description": "A Cloud AI Platform Feature Store.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Featurestore", },
Para ver la solicitud como un comando curl
, como un
Solicitud HTTP o, en JavaScript, haz clic en fullscreen Pantalla completa.
del Explorador de APIs.
C#
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Go
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
PHP
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Ruby
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Si tienes dificultades, consulta Solución de problemas de llamadas a la API.
Obtén descriptores de recursos
Para obtener un descriptor de recursos supervisados específico, usa el método monitoredResourceDescriptors.get
.
Para recuperar un descriptor de recursos supervisado específico, necesitas el nombre completo del descriptor de la API. El nombre completo se construye a partir de dos componentes:
- Un prefijo que consta de
projects/PROJECT_ID/monitoredResourceDescriptors
- El valor
type
que identifica el descriptor de recursos supervisados, por ejemplo,gce_instance
. Consulta la pestaña Protocolo en Tipos de recursos de lista para obtener más información sobre el valortype
.
A continuación, se muestra un ejemplo del nombre completo de un recurso supervisado:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Protocolo
Para obtener el descriptor del tipo de recurso gce_instance
, haz lo siguiente:
Abre el
monitoredResourceDescriptors.get
. página de referencia.En el panel etiquetado Probar este método, ingresa lo siguiente:
name:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Reemplaza
PROJECT_ID
por el ID del proyecto de Google Cloud.
Haz clic en Ejecutar.
En la siguiente respuesta de ejemplo, se muestra el descriptor de este recurso supervisado:
{ "type": "gce_instance", "displayName": "VM Instance", "description": "A virtual machine instance hosted in Compute Engine.", "labels": [ { "key": "project_id", "description": "The identifier of the Google Cloud project associated with this resource, such as \"my-project\"." }, { "key": "instance_id", "description": "The numeric VM instance identifier assigned by Compute Engine." }, { "key": "zone", "description": "The Compute Engine zone in which the VM is running." } ], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance" }
Para ver la solicitud como un comando curl
, como una solicitud HTTP o en JavaScript, haz clic en fullscreen Pantalla completa en el Explorador de API.
C#
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Go
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
PHP
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Ruby
Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Si tienes dificultades, consulta Solución de problemas de llamadas a la API.
¿Qué sigue?
- Si deseas obtener información sobre cómo usar la API de Cloud Monitoring para leer datos de series temporales, consulta Cómo recuperar datos de series temporales.
- Si deseas obtener una lista de los tipos de recursos supervisados disponibles para que uses con de métricas definidas por el usuario, consulta Elige un tipo de recurso supervisado.