Introducción a la API de Cloud Monitoring

En esta página se describen algunas de las características de la versión 3 de la API de Cloud Monitoring.

Para consultar la documentación de referencia de la API, visita cualquiera de las siguientes páginas:

Nombres de proyectos en la API Monitoring

Todos los métodos de la API Monitoring tienen un parámetro name obligatorio. Este parámetro suele tener una descripción como la siguiente:

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

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

Algunos métodos de la API Monitoring requieren que el proyecto sea un proyecto de ámbito de un ámbito de métricas, mientras que otros métodos no. Un pequeño número de métodos puede devolver resultados diferentes en función del tipo de proyecto.

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

Se requiere el proyecto de ámbito de un ámbito de métricas

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

No es necesario definir el proyecto de ámbito de un ámbito de métricas

Ninguno de los métodos de la API Metrics requiere el parámetro name para hacer referencia a un proyecto de ámbito de métricas, pero algunos métodos se comportan de forma diferente cuando se utiliza:

  • Los siguientes métodos de la API Metrics operan en elGoogle Cloud proyecto con nombre. Estos métodos solo afectan a los datos del proyecto con el nombre indicado, independientemente de si el proyecto también es un proyecto de ámbito de un ámbito de métricas.

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

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

    • Si el proyecto con nombre no es un proyecto de ámbito de un ámbito de métricas, los métodos solo recuperan datos del proyecto con nombre.
    • Si el proyecto con nombre también es un proyecto de ámbito de un ámbito de métricas, los métodos recuperan datos tanto del proyecto con nombre como de los proyectos que monitoriza.

    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 como proyecto de ámbito de un ámbito de métricas, consulta el artículo Información general sobre los ámbitos de métricas. Google Cloud

Recursos de la API

Métricas

La API Monitoring te da acceso a aproximadamente 6500 métricas de Cloud Monitoring de Google Cloud y Amazon Web Services. Puedes crear tus propias métricas personalizadas y organizar tus recursos en la nube mediante grupos.

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

Para saber cómo gestionar sus métricas personalizadas y las métricas integradas, consulte el artículo Descripción general de las métricas definidas por el usuario.

Para ver una lista completa de las métricas disponibles, consulta el artículo Lista de métricas.

Recursos monitorizados

Un recurso monitorizado es un elemento sobre el que se recogen métricas. Por ejemplo, puede que te interese la actividad de una instancia de VM o de un hardware.

Para ver una lista de los recursos monitorizados disponibles, consulta la lista de recursos monitorizados.

Grupos de recursos monitorizados

Un grupo es una colección dinámica de recursos monitorizados. Siempre has podido crear grupos manualmente en la consola y también puedes usar la API Cloud Monitoring para escribir código que cree y use grupos. Google Cloud

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 incidentes y cómo notificarte cuando se creen esos incidentes. En Conceptos de 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 la proporción de dos métricas. Por el momento, no se pueden crear ratios mediante la monitorización en la consola de Google Cloud . Para obtener más información, consulta MetricThreshold en la referencia de AlertPolicy.

Canales de notificación

Un canal de notificaciones es un recurso de configuración que describe cómo avisarte cuando se produzcan incidentes. Los canales de notificaciones pueden hacer referencia a una gran variedad de servicios y endpoints de comunicación diferentes, que se especifican en descriptores. Los descriptores determinan el conjunto de parámetros de configuración que se incluyen en un objeto de canal.

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

Service Monitoring

Los recursos de monitorización de servicios se usan para configurar objetivos de nivel de servicio que se pueden usar para monitorizar el estado de tus servicios.

Service Monitoring añade los siguientes recursos a la API Monitoring:

Para obtener más información sobre estos conceptos de monitorización de servicios y sobre el uso de la API, consulta Monitorización de SLOs.

Paneles de control

Puedes crear y manipular de forma programática tanto paneles de control como gráficos mediante el endpoint Dashboards. Para obtener información sobre cómo usar este endpoint para gestionar paneles de control y gráficos, consulta Gestionar paneles de control por API.

Monitoring Query Language

Monitoring Query Language (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 MQL desde la API Monitoring o desde el editor de código.

Para obtener información general sobre MQL, consulta Usar Monitoring Query Language.

Para obtener información sobre cómo usar MQL para recuperar datos de series temporales mediante la API Monitoring, consulta la referencia de la API del método timeSeries.query.

Filtros

La API Monitoring usa filtros para seleccionar métricas, obtener datos de series temporales y agrupar recursos monitorizados. Para obtener más información, consulta Filtros de monitorización.

La API Monitoring también usa filtros para restringir el conjunto de resultados de determinadas operaciones list. Consulta Ordenar y filtrar para obtener más información sobre cómo gestionar los resultados de los métodos alertPolicies.list y notificationChannels.list.

Pasos siguientes