Introducción a la API de Cloud Monitoring

En esta página, se describen algunas de las características de la API de Cloud Monitoring v3.

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

Nombres de proyectos en la API de Monitoring

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

Obligatoria. 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 una de las siguientes opciones:

  • Un proyecto de Google Cloud
  • Un proyecto de Google Cloud que también sea un proyecto de alcance de un alcance de métricas

Algunos métodos de la API de Monitoring requieren que el proyecto sea un proyecto de alcance de un alcance de métricas. otros métodos lo hacen. 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 debate, se usa el término API de métricas a fin de hacer referencia a los siguientes recursos en la API de Monitoring:

Se necesita establecer el alcance del proyecto de un alcance de métricas.

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

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

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

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

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get
  • Los métodos restantes en la API de Metrics se comportan de la siguiente manera:

    • Si el proyecto nombrado no es un proyecto de alcance de un alcance de métricas, los métodos solo recuperan datos del proyecto nombrado.
    • Si el proyecto nombrado también es un proyecto de alcance de un alcance de 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 la configuración de un proyecto de Cloud como un alcance de un alcance de métricas, consulta Configura tu proyecto para Monitoring.

Recursos de la API

Métricas

La API de Monitoring te brinda acceso a más de 1,500 métricas de Cloud Monitoring desde Google Cloud y Amazon Web Services. Puedes crear tus propias métricas personalizadas y organizar tus recursos en la nube mediante los 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 obtener información sobre cómo administrar tus métricas personalizadas y las métricas integradas, consulta Usa métricas personalizadas.

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 manualmente en la consola de Monitoring y también puedes usar la API de Cloud Monitoring para escribir código mediante el cual se creen y usen 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 de generación de incidentes y cómo notificarte cuando se crean. En los conceptos de alerta, 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 mediante Monitoring en Google Cloud Console. 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 notificarte cuando ocurren incidentes. 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. Si deseas obtener información sobre cómo usar este extremo para administrar paneles y gráficos, consulta Administra paneles por 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 consultas.

Para obtener información general sobre MQL, consulta Usa el 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.

Si deseas obtener más información sobre cómo crear paneles con gráficos basados en MQL mediante la API de Monitoring, consulta la referencia de la API para el objeto TimeSeriesQuery. Este objeto proporciona el mecanismo de recuperación del conjunto de datos de un gráfico o un cuadro de evaluación.

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 Ordenamiento y filtrado para ver los detalles de la administración de los resultados de los métodos alertPolicies.list y notificationChannels.list.

Próximos pasos