Introducción a la API de Cloud Monitoring

La API de Cloud Monitoring v3 te permite consultar y escribir datos de métricas de manera programática, organizar los recursos supervisados en grupos y administrar paneles, políticas de alertas, objetivos de nivel de servicio (SLO) y canales de notificaciones. Para conocer las especificaciones de métodos y recursos, consulta la API de Cloud Monitoring (REST) y la API de Cloud Monitoring (gRPC).

Nombres de proyectos en la API de Monitoring

Todos los métodos de la API de Monitoring tienen un parámetro name obligatorio. Por lo general, este parámetro tiene una descripción como la siguiente:

Obligatorio. Es el proyecto en el que se ejecutará la solicitud. El formato es el siguiente:
projects/[PROJECT_ID_OR_NUMBER]

En la API de Monitoring, el valor de PROJECT_ID_OR_NUMBER identifica uno de los siguientes elementos:

Algunos métodos de la API de Monitoring requieren que el proyecto sea un proyecto de alcance de un alcance de las métricas, mientras que otros no. Una pequeña cantidad de métodos puede mostrar resultados diferentes, según el tipo de proyecto.

Para describir estas clases de métodos, en este análisis, se usa el término API de Metrics para hacer referencia a los siguientes recursos en la API de Monitoring:

Se requiere el proyecto de alcance de las métricas

Todos los métodos de la API de Monitoring que no forman parte de la API de Metrics requieren que el parámetro name haga referencia a un proyecto de alcance de un alcance de las métricas.

No se requiere el proyecto de alcance de las métricas

Ninguno de los métodos de la API de Metrics requiere que el parámetro name haga referencia a un proyecto de alcance de las métricas, pero algunos métodos se comportan de manera diferente cuando lo hace:

  • Los siguientes métodos de la API de Metrics operan en el proyecto Google Cloud con nombre. Estos métodos solo afectan los datos del proyecto nombrado, sin importar si el proyecto también es un proyecto de alcance de las métricas.

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • Los métodos restantes de la API de Metrics se comportan de la siguiente manera:

    • Si el proyecto con nombre no es un proyecto de alcance de las métricas, los métodos recuperan datos solo del proyecto con nombre.
    • Si el proyecto nombrado también es un proyecto de alcance de un alcance de las métricas, los métodos recuperan datos del proyecto nombrado y de cualquier proyecto que supervise.

    Los métodos de este grupo son los siguientes:

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

Para obtener información sobre cómo configurar un proyecto de Google Cloud como un proyecto de alcance de un alcance de las métricas, consulta Descripción general de los alcances de las métricas.

Recursos de la API

Métricas

La API de Monitoring te brinda acceso a aproximadamente 6,500 métricas de Cloud Monitoring de Google Cloud y Amazon Web Services. Puedes crear tus propias métricas personalizadas y organizar tus recursos de la nube con grupos.

Para obtener una introducción a los conceptos de las métricas y las estructuras de datos que los representan, consulta Métricas, series temporales y recursos.

Para aprender a administrar tus métricas personalizadas y las integradas, consulta Descripción general de las métricas definidas por el usuario.

Para obtener una lista completa de las métricas disponibles, consulta la Lista de las métricas.

Recursos supervisados

Un recurso supervisado trata sobre que métricas se recopilan. Por ejemplo, es posible que te interese la actividad de una instancia de VM o de un fragmento de hardware.

Para obtener una lista de los recursos supervisados disponibles, consulta la Lista de recursos supervisados.

Grupos de recursos supervisados

Un grupo es una colección dinámica de recursos supervisados. Siempre pudiste crear grupos de forma manual en la consola de Google Cloud , y también puedes usar la API de Cloud Monitoring para escribir código que cree y use grupos.

Para obtener más información, consulta la referencia de la API de Group.

Políticas de alertas

Una política de alertas es un recurso de configuración que describe los criterios para generar alertas y cómo notificarte cuando se crean esas alertas. En la descripción general de las alertas, se explican los conceptos básicos de las políticas de alertas. Para obtener más información, consulta la referencia de la API de AlertPolicy.

La API también te permite crear políticas de alertas basadas en una proporción de dos métricas. Por el momento, no se pueden crear proporciones con Monitoring en la consola de Google Cloud . Para obtener más información, consulta MetricThreshold en la referencia de AlertPolicy.

Canales de notificaciones

Un canal de notificaciones es un recurso de configuración que describe cómo notificarte cuando se producen alertas. Los canales de notificaciones pueden hacer referencia a una variedad de tipos de servicios de comunicación y extremos. Estos se especifican en los descriptores. Los descriptores determinan el conjunto de parámetros de configuración que se incluyen en un objeto del canal.

Para obtener más información, consulta la referencia de NotificationChannel y la referencia de NotificationChannelDescriptor.

Supervisión de servicios

Los recursos de supervisión de servicios se usan para configurar objetivos de nivel de servicio que se pueden usar a fin de supervisar el estado de tus servicios.

Service Monitoring agrega los siguientes recursos a la API de Monitoring:

Si deseas obtener más información sobre estos conceptos de supervisión de servicios y el uso de la API, consulta Supervisión de SLO.

Paneles

Puedes crear y manipular de manera programática los paneles y los gráficos mediante el extremo Dashboards. Para obtener información sobre cómo usar este extremo para administrar paneles y gráficos, consulta Crea y administra paneles con la API.

Lenguaje de consulta de Monitoring

El lenguaje de consulta de Monitoring (MQL) proporciona una interfaz basada en texto para consultar datos de series temporales de Cloud Monitoring. MQL usa un modelo de consulta canalizada y es más expresivo que los filtros de Monitoring. Puedes usar consultas de MQL desde la API de Monitoring o desde el editor de código.

Para obtener información general sobre MQL, consulta Descripción general del lenguaje de consulta de Monitoring.

Si deseas obtener información sobre el uso de MQL a fin de recuperar datos de series temporales mediante la API de Monitoring, consulta la referencia de la API para el método timeSeries.query.

Filtros

La API de Monitoring usa filtros para seleccionar métricas, recuperar datos de series temporales y recopilar recursos supervisados en grupos. Para obtener más información, consulta Filtros de Monitoring.

La API de Monitoring también usa filtros para restringir el conjunto de resultados de ciertas operaciones list. Consulta Referencia: Ordena y filtra para obtener detalles sobre cómo administrar los resultados de los métodos alertPolicies.list y notificationChannels.list.

Próximos pasos