Una política de alertas se representa en la API de Cloud Monitoring
por un objeto AlertPolicy
que describe un conjunto de condiciones que indican
en mal estado en tu sistema.
En este documento, se describe lo siguiente:
- Cómo la API de Monitoring representa las políticas de alertas
- Los tipos de condiciones que proporciona la API de Monitoring para y las políticas de alertas.
- Cómo crear una política de alertas con Google Cloud CLI o bibliotecas cliente
Estructura de una política de alertas
La estructura AlertPolicy
define los componentes de una
política de alertas. Cuando creas una política, debes especificar valores para los siguientes campos AlertPolicy
:
displayName
: Es una etiqueta descriptiva para la política.documentation
: Te recomendamos que uses este campo. para proporcionar información que ayude a los servicios de respuesta ante incidentes. Para obtener más información, consulta Anota las notificaciones con la documentación definida por el usuario.userLabels
: Cualquier etiqueta definida por el usuario que se adjunta a la política. Información sobre el uso de etiquetas con alertas, consulta Anota incidentes con etiquetas.conditions[]
: Es un array de estructurasCondition
.combiner
: Un operador lógico que determina cómo manejar varias condiciones.notificationChannels[]
: Es un array de nombres de recursos, cada uno de los cuales identifica unaNotificationChannel
alertStrategy
: Especifica qué tan rápido Se cierra la supervisión de los incidentes de seguridad cuando los datos dejan de llegar. Este objeto también especifica si las notificaciones repetidas están habilitadas para las políticas de alertas basadas en métricas, y el intervalo entre esas notificaciones. Para obtener más información, consulta Configura notificaciones repetidas para políticas de alertas basadas en métricas.
También puedes especificar el campo severity
cuando usas la API de Cloud Monitoring
y la consola de Google Cloud. Este campo te permite definir el nivel de gravedad de los incidentes. Si no especificas una gravedad,
Luego, Cloud Monitoring establece la gravedad de la política de alertas en No Severity
.
Existen otros campos que podrías usar según las condiciones que crees.
Cuando una política de alertas contiene una condición, se envía una notificación se cumpla esa condición. Para obtener información sobre las notificaciones durante las alertas las políticas contienen varias condiciones, consulta Políticas con varias condiciones y Cantidad de notificaciones por política.
Cuando creas o modificas la política de alertas, Monitoring
otros campos también, incluido el campo name
. El valor de name
es el nombre del recurso para la política de alertas, que identifica el
política de la empresa. El nombre del recurso tiene el siguiente formato:
projects/PROJECT_ID/alertPolicies/POLICY_ID
Tipos de condiciones en la API
La API de Cloud Monitoring admite una variedad de tipos de condiciones en la
estructura Condition
. Hay varias condiciones
tipos para políticas de alertas basadas en métricas y uno para alertas basadas en registros
y políticas de seguridad. En las siguientes secciones, se describen los tipos de condiciones disponibles.
Condiciones para políticas de alertas basadas en métricas
Para crear una política de alertas que supervise los datos de las métricas, incluidas las métricas puedes usar los siguientes tipos de condiciones:
Condiciones de métricas basadas en filtros
Las condiciones MetricAbsence
y MetricThreshold
usan
Filtros de supervisión para seleccionar los datos de series temporales
para supervisar. Otros campos en la estructura de condición especifican cómo filtrar,
agrupar y agregar los datos. Para obtener más información sobre estos conceptos, consulta
Filtrado y agregación: manipulación de series temporales.
Si usas el tipo de condición MetricAbsence
, puedes crear una condición que se cumpla solo cuando no exista ninguna de las series temporales. Esta condición usa
el parámetro aggregations
para agregar varias series temporales en una sola
series temporales. Para obtener más información, consulta
La referencia de MetricAbsence
en la documentación de la API
Una política de alertas de ausencia de métricas requiere que se hayan escrito algunos datos previamente. Para obtener más información, consulta Crea políticas de alertas de ausencia de métricas.
Si quieres recibir notificaciones según un valor previsto, configura
tu política de alertas para usar
Tipo de condición MetricThreshold
y para establecer forecastOptions
. Cuando no se configura este campo, los datos medidos se comparan con un umbral.
Sin embargo, cuando se establece este campo, los datos predichos se comparan con un
umbral. Para obtener más información, consulta
Crea políticas de alertas sobre el valor de las métricas previstas.
Condiciones de las métricas basadas en MQL
La condición MonitoringQueryLanguageCondition
usa el lenguaje de consulta de Monitoring (MQL) para
seleccionar y manipular los datos
de series temporales que se supervisarán. Puedes crear políticas de alertas que comparen valores con un umbral o prueben la ausencia de valores con este tipo de condición.
Si usas una condición MonitoringQueryLanguageCondition
, debe ser la única
en tu política de alertas. Para obtener más información, consulta
Políticas de alertas con MQL.
Condiciones de métricas basadas en PromQL
La condición PrometheusQueryLanguageCondition
usa Prometheus Query Language (PromQL)
para seleccionar y manipular datos de series temporales para supervisar.
Tu condición puede calcular una proporción de métricas,
evaluar comparaciones de métricas y mucho más.
Si usas una condición PrometheusQueryLanguageCondition
, debe ser la única
en tu política de alertas. Para obtener más información, consulta
Políticas de alertas con PromQL.
Condiciones para generar alertas sobre proporciones
Puedes crear políticas de alertas sobre el umbral de métricas para supervisar
promedio de dos métricas. Puedes crear estas políticas con
El tipo de condición MetricThreshold
o MonitoringQueryLanguageCondition
.
También puedes usar MQL directamente en la consola de Google Cloud. No puedes crear
o administrar condiciones basadas en razones usando la interfaz gráfica para crear
de las condiciones de umbral.
Recomendamos usar MQL para crear políticas de alertas basadas en la proporción.
MQL te permite compilar consultas más potentes y flexibles de las que puedes
compilar con el tipo de condición MetricTheshold
Filtros de supervisión.
Por ejemplo, con una condición MonitoringQueryLanguageCondition
, puedes
calcular la proporción entre una métrica de indicador y una métrica delta. Para ver ejemplos, consulta
Ejemplos de política de alertas de MQL.
Si usas la condición MetricThreshold
, el numerador y el denominador
de la proporción debe tener el mismo MetricKind
.
Para obtener una lista de métricas y sus propiedades, consulta Listas de métricas.
En general, es mejor calcular las proporciones según las series temporales recopiladas para un solo tipo de métrica mediante el uso de valores de etiquetas. Una proporción calculada sobre dos los diferentes tipos de métricas están sujetos a anomalías debido a diversos los puntos y las ventanas de alineación.
Por ejemplo, supongamos que tienes dos tipos de métricas, un recuento total de RPC y un recuento de errores de RPC, y deseas calcular la proporción de las RPC del recuento de errores sobre el total de RPC. Las RPC con errores se cuentan en las series temporales de ambos tipos de métricas. Por lo tanto, existe la posibilidad de que, cuando alinees el tiempo, serie, una RPC fallida no aparece en el mismo intervalo de alineación para en ambas series temporales. Esta diferencia puede ocurrir por varias razones, incluidas las siguientes:
- Debido a que hay dos series temporales diferentes que graban el mismo evento, no hay dos valores de contador subyacentes que implementan la colección, no se actualizan de forma atómica.
- Las tasas de muestreo pueden variar. Cuando las series temporales se alinean con una política de entrada, los recuentos de un solo evento pueden aparecer en la alineación adyacente en las series temporales para las diferentes métricas.
La diferencia en la cantidad de valores en los intervalos de alineación correspondientes puede generar valores de proporción error/total
sin sentido, como 1/0 o 2/1.
Las proporciones de números más grandes tienen menos probabilidades de generar valores sin sentido. Puedes obtener números más grandes mediante la agregación, ya sea con una ventana de alineación es decir, más largo que el período de muestreo, o bien agrupando los datos de determinados con etiquetas de recursos. Estas técnicas minimizan el efecto de las pequeñas diferencias en el la cantidad de puntos en un intervalo determinado. Es decir, una disparidad de dos puntos es más significativo cuando la cantidad esperada de puntos en un intervalo es 3 que cuando el número esperado es 300.
Si usas tipos de métricas integradas, es posible que no tengas más opción que calcular las proporciones entre los tipos de métricas para obtener el valor que necesitas.
Si diseñas métricas personalizadas que pueden contar lo mismo, como las RPC que muestran el estado del error, en dos métricas diferentes, considera una sola métrica, que incluye cada recuento solo una vez. Por ejemplo, supongamos que estás contando RPC y deseas realizar un seguimiento de la proporción de RPC fallidas en todas las RPC. Para resolver este problema, crear un solo tipo de métrica para contar RPC y usar una etiqueta para registrar estado de la invocación, incluido "OK" estado. Luego, cada valor de estado, error o “Correcto” se registra mediante la actualización de un solo contador para ese caso.
Condición para políticas de alertas basadas en registros
Para crear una política de alertas basada en registros, que te notifique cuando un mensaje
que coinciden con tu filtro aparece en tus entradas de registro, usa el
Tipo de condición LogMatch
. Si usas una condición LogMatch
, esta debe ser la única condición en tu política de alertas.
No intentes usar el tipo de condición LogMatch
junto con las variables
métricas. Las políticas de alertas que supervisan las métricas basadas en registros se basan en
y políticas de seguridad. Para obtener más información sobre cómo elegir entre políticas de alertas
supervisar métricas basadas en registros o entradas de registro, consulta
Supervisa tus registros.
Las políticas de alertas usadas en los ejemplos en la El documento Administrar políticas de alertas por API se basa en métricas. alertas políticas, aunque los principios son los mismos para las políticas de alertas basadas en registros. Para obtener información específica de las políticas de alertas basadas en registros, consulta Crea una política de alertas basada en registros con la API de Monitoring en la documentación de Cloud Logging.
Antes de comenzar
Antes de escribir el código en la API, debes cumplir con lo siguiente:
- Estar familiarizado con los conceptos generales y la terminología que se usa con las alertas policies; consulta Descripción general de las alertas para obtener más información información.
- Asegúrate de que la API de Cloud Monitoring esté habilitada para su uso. ver Cómo habilitar la API para obtener más información.
- Si planeas usar bibliotecas cliente, instálalas para el los idiomas que quieres usar; ver Consulta las bibliotecas cliente para obtener más información. Actualmente, la asistencia de la API para alertas está disponible solo para C#, Go, Java, Node.js y Python.
Si planeas usar Google Cloud CLI, instálalo. Sin embargo, si usas Cloud Shell, Google Cloud CLI ya está instalada.
También se proporcionan aquí los ejemplos que usan la interfaz de
gcloud
. Ten en cuenta que en los ejemplos degcloud
se da por sentado que el proyecto actual ya se estableció como el objetivo (gcloud config set project [PROJECT_ID]
), por lo que las invocaciones omiten la marca--project
explícita. El ID del proyecto actual en los ejemplos esa-gcp-project
.
-
A fin de obtener los permisos que necesitas para crear y modificar las políticas de alertas con la API de Cloud Monitoring, solicita a tu administrador que te otorgue el Rol de IAM de Editor de políticas de alertas de Monitoring (
roles/monitoring.alertPolicyEditor
) en tu proyecto. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.
Para obtener información detallada sobre los roles de IAM Monitoring, consulta Controla el acceso con Identity and Access Management.
Diseña tu aplicación para llamadas a la API de Cloud Monitoring de un solo subproceso que modificar el estado de una política de alertas proyecto de Google Cloud. Por ejemplo, las llamadas a la API de un solo subproceso que crean, actualizan, o borrar una política de alertas.
Crea una política de alertas
Para crear una política de alertas en un proyecto, usa el
alertPolicies.create
. Para obtener información sobre cómo invocar este método, sus parámetros y los datos de respuesta, consulta la página de referencia alertPolicies.create
.
Puedes crear políticas desde archivos JSON o YAML.
Google Cloud CLI acepta estos archivos como argumentos.
puedes leer archivos JSON de manera programática y convertirlos en AlertPolicy
objetos y crearás políticas a partir de ellos
Mediante el método alertPolicies.create
Si
tienes un archivo de configuración JSON o YAML de Prometheus con una regla de alerta,
gcloud CLI puede migrarla a una alerta de Cloud Monitoring
política con una condición PromQL. Para obtener más información, consulta
Migra las reglas de alerta y los receptores de Prometheus.
Cada política de alertas pertenece a un proyecto de permisos de un permiso de métricas. Cada proyecto puede contener hasta 500 políticas.
Para las llamadas a la API, debes proporcionar un “ID del proyecto”. usa el
Es el ID del proyecto de permisos de un permiso de métricas como el valor. En estos ejemplos,
el ID del proyecto de permisos de un permiso de métricas es a-gcp-project
.
Los siguientes ejemplos ilustran la creación de políticas de alertas, pero no describen cómo crear un archivo JSON o YAML que describa una política de alertas. En cambio, los ejemplos suponen que un archivo con formato JSON y muestran cómo emitir la llamada a la API. Por ejemplo, archivos JSON, consulta Ejemplos de políticas. Para obtener información general sobre la supervisión de proporciones de métricas, consulta Razones de métricas.
gcloud
Para crear una política de alertas en un proyecto, usa el comando gcloud alpha monitoring
policies create
. En el siguiente ejemplo, se crea una política de alertas en a-gcp-project
del archivo rising-cpu-usage.json
:
gcloud alpha monitoring policies create --policy-from-file="rising-cpu-usage.json"
Si funciona, este comando muestra el nombre de la política nueva, por ejemplo:
Created alert policy [projects/a-gcp-project/alertPolicies/12669073143329903307].
El archivo rising-cpu-usage.json
contiene el JSON de una política con el nombre visible “Tasa de cambio de CPU alta”. Para obtener más información sobre esta política, consulta Política de tasa de cambio.
Consulta la referencia de gcloud alpha monitoring policies create
para obtener más información.
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.
El objeto AlertPolicy
creado tendrá campos adicionales.
La política en sí tendrá los campos name
, creationRecord
y mutationRecord
. Además, cada condición en la política también recibe un name
.
Estos campos no pueden modificarse de forma externa, por lo que no es necesario configurarlos cuando creas una política. Ninguno de los ejemplos de JSON usados para crear políticas los incluye, pero si las políticas creadas a partir de ellas se recuperan después de la creación, los campos estarán presentes.
Configura notificaciones repetidas para políticas de alertas basadas en métricas
De forma predeterminada, una política de alertas basada en métricas envía una notificación a cada canal de notificación cuando se abre un incidente. Sin embargo, puedes cambiar la configuración y configurar una política de alertas para volver a enviar algunos de los canales de notificación para tu política de alertas. Estas notificaciones repetidas se envían para los incidentes con el estado Abierto o Confirmado. El intervalo entre estas notificaciones debe ser de 30 minutos como mínimo y no más de 24 horas, expresada en segundos.
Para configurar las notificaciones repetidas, agrega elementos a la configuración de la política de alertas
un objeto AlertStrategy
que contiene al menos un
NotificationChannelStrategy
.
Un objeto NotificationChannelStrategy
tiene dos campos:
renotifyInterval
: El intervalo, en segundos, entre notificaciones.Si cambias el valor del campo
renotifyInterval
cuando cuando se abre un incidente para la política de alertas, sucede lo siguiente:- La política de alertas envía otra notificación por el incidente.
- La política de alertas reinicia el período del intervalo.
notificationChannelNames
: Es un array de nombres de recursos del canal de notificaciones. que son cadenas en el formato deprojects/PROJECT_ID/notificationChannels/CHANNEL_ID
, donde CHANNEL_ID es un valor numérico. Para obtener información sobre cómo recuperar el ID del canal, consulta Cómo enumerar los canales de notificación en un proyecto.
En la siguiente muestra de JSON, se muestra una estrategia de alerta configurada para enviar notificaciones repetidas cada 1,800 segundos (30 minutos) a un canal de notificaciones:
"alertStrategy": { "notificationChannelStrategy": [ { "notificationChannelNames": [ "projects/PROJECT_ID/notificationChannels/CHANNEL_ID" ], "renotifyInterval": "1800s" } ] }
Para detener temporalmente las notificaciones repetidas, crea una pospuesta. Para evitar notificaciones repetidas, edita la política de alertas con la API y quita el objeto NotificationChannelStrategy
.
¿Qué sigue?
- Administra las políticas de alertas según la API
- Cómo crear y administrar canales de notificaciones por API