Puede configurar MongoDB Ops Manager para enviar notificaciones de alerta a un punto de conexión de webhook como solicitudes HTTP POST para su procesamiento programático. Los webhooks le permiten integrar alertas de MongoDB Ops Manager con sistemas de supervisión personalizados, plataformas de gestión de incidentes o flujos de trabajo de automatización.
Acceso requerido
Para integrar MongoDB Ops Manager con webhooks, se debe tener acceso Project Monitoring Admin al proyecto.
Autenticar solicitudes de webhook
Puedes autenticar las solicitud de webhook con los siguientes métodos:
Secreto de webhook: MongoDB Ops Manager utiliza el secreto para generar el encabezado
X-MMS-Signature. MongoDB Ops Manager no envía el secreto en sí como un encabezado de autenticación o Bearer token. Para aprender a verificar la firma, consulte Verificar solicitudes de webhook.Credenciales de cliente de OAuth 2.0 : MongoDB Ops Manager obtiene un token de acceso de portador del punto final de token de OAuth 2.0 y lo envía en el encabezado
Authorization. Para configurar este método, consulte Configurar una integración de webhook.
Puede utilizar un método, ambos o ninguno. Si configura ambos, MongoDB Ops Manager incluye los encabezados Authorization y X-MMS-Signature en la misma solicitud.
MongoDB Ops Manager almacena en caché el token de acceso OAuth 2.0 y lo actualiza cuando el token caduca. Si su endpoint de webhook devuelve una respuesta 401, MongoDB Ops Manager actualiza el token y vuelve a intentar la solicitud una vez.
Comportamiento de la plantilla de encabezados personalizados
Si configura una plantilla de encabezados personalizados, esta reemplaza los encabezados por defecto en la solicitud. MongoDB Ops Manager no añade los encabezados X-MMS-Signature o Authorization por usted. Para incluir cualquiera de los encabezados, añádalo a su plantilla:
"X-MMS-Signature": "${signature}""Authorization": "Bearer ${oauthToken}"
Para aprender más sobre las plantillas de webhooks, consulta Configurar plantilla de webhook.
Otros métodos de autenticación
Si el secreto del webhook y las credenciales de cliente de OAuth 2.0 no satisfacen sus necesidades, puede gestionar la autenticación de una de las siguientes maneras:
Parámetros de query: incluya las credenciales de autenticación en el Webhook URL como parámetros de query. Por ejemplo:
https://example.com/webhook?token=your-auth-tokenLista de acceso IP: Configure el extremo de su webhook para aceptar solicitudes solo de las direcciones IP de la instancia de MongoDB Ops Manager.
Proxy inverso o puerta de enlace API: Utilice un proxy inverso o una puerta de enlace API que gestione la autenticación antes de reenviar las solicitudes a su punto final de webhook.
Verificar solicitudes de webhook
Para verificar que una solicitud de webhook se originó en MongoDB Ops Manager, valide el encabezado X-MMS-Signature:
Configurar una integración de Webhook
Navega a la página Project Integrations.
Si aún no se muestra, se debe seleccionar la organización que contiene el proyecto deseado en el menú Organizations de la barra de navegación.
Si aún no se muestra, se debe seleccionar el proyecto deseado en el menú Projects de la barra de navegación.
Haz clic en Integrations en el panel de navegación izquierdo debajo del encabezado Settings.
Configura la autenticación.
Introduce al menos una de las siguientes opciones de autenticación:
Webhook Secret: Introduzca una clave secreta. MongoDB Ops Manager utiliza este secreto para generar el encabezado
X-MMS-Signaturepara la verificación de la solicitud.OAuth2 Token URL, OAuth2 Client ID y OAuth2 Client Secret: Introduzca el punto de conexión del token que llama MongoDB Ops Manager para obtener un token de acceso y las credenciales de la aplicación que registró con su proveedor de OAuth 2.0. Establezca los tres valores juntos o deje los tres vacíos.
Puede utilizar ambas opciones juntas. Para obtener más información, consulte Autenticar solicitud de webhook.
Para enviar alertas a su webhook, configure las notificaciones de alerta. Para obtener más información, consulte Configurar ajustes de alerta en MongoDB Ops Manager.
Encabezados de solicitud
MongoDB Ops Manager incluye los siguientes encabezados HTTP con cada solicitud de webhook:
Ops Manager agrega un encabezado de solicitud llamado X-MMS-Event para distinguir entre varios estados de alerta. Los valores posibles para este encabezado son:
| La alerta se acaba de abrir. |
| La alerta se resolvió. |
| Una alerta previamente abierta aún está abierta. |
| La alerta fue reconocida. |
| La alerta se volvió inválida y fue cancelada. |
| Representa una alerta informativa, que es un evento de punto en el tiempo, como "Primario Elegido." |
Si especifica una clave en el campo Webhook Secret, MongoDB Ops Manager añade el encabezado de solicitud X-MMS-Signature. Este encabezado contiene la firma HMAC-SHA-1 codificada en base64del cuerpo de la solicitud. MongoDB Ops Manager crea la firma utilizando el secreto proporcionado.
Si configura las credenciales de cliente de OAuth 2.0, MongoDB Ops Manager añade el encabezado de solicitud Authorization. Este encabezado contiene el token de acceso de portador que MongoDB Ops Manager obtiene de su punto final de token de OAuth 2.0.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene un documento JSON que utiliza el mismo formato que el recurso de alertas de la API de MongoDB Ops Manager. La carga útil incluye campos clave como:
id: Identificador único para la alerta.eventTypeName: Tipo de evento que activó la alerta.created: Marca de tiempo en que se creó la alerta.status: Estado actual de la alerta (por ejemplo,OPEN,CLOSED).humanReadable: descripción legible por personas de la alerta.
Para obtener una lista completa de los campos, consulte la documentación del endpoint Get One Alerta.
Carga útil de webhook de ejemplo
El siguiente ejemplo muestra una carga útil de webhook de muestra para una alerta de umbral de métricas:
{ "id": "5d1b6f8e8c2e4e2d3c4a5b6c", "groupId": "5d1b6f8e8c2e4e2d3c4a5b6d", "eventTypeName": "OUTSIDE_METRIC_THRESHOLD", "status": "OPEN", "created": "2024-01-15T10:30:00Z", "updated": "2024-01-15T10:30:00Z", "lastNotified": "2024-01-15T10:30:00Z", "humanReadable": "Disk space used on data partition is 95.2%.", "metricName": "DISK_PARTITION_SPACE_USED_DATA", "currentValue": { "number": 95.2, "units": "RAW" }}Personalizar plantillas de Webhook
Puede personalizar los encabezados de la solicitud y el contenido del cuerpo utilizando plantillas FreeMarker. Para obtener información detallada acerca de la creación de plantillas de webhooks, incluidas las variables de plantilla disponibles, los asistentes regex y ejemplos, consulte Configurar plantillas de webhook.
Limitaciones
Cuando utilice integraciones de webhook, considere las siguientes limitaciones:
Gravedad de la alerta no incluida
La carga útil del webhook no incluye el nivel de gravedad de la alerta que configura en Ops Manager. Para recuperar la gravedad configurada, haga una llamada adicional al punto de conexión Get One alerta Configuration utilizando el alertConfigId de la carga útil del webhook.
Sin alertas de prueba manual
MongoDB Ops Manager no ofrece una forma de trigger alertas de prueba manualmente. Para probar su endpoint de webhook, puede configurar temporalmente una alerta con condiciones que pueda trigger, como:
Un umbral bajo de espacio en disco en una implementación de prueba.
Un umbral de recuento de conexiones que puede activar abriendo varias conexiones.
Un umbral de atraso de la replicación en un set de réplicas de prueba.
Después de confirmar que su webhook recibe las alertas correctamente, puede borrar la configuración de alerta de prueba.
Configuración del Firewall
Dado que MongoDB Ops Manager está auto-host, asegúrese de que su red permite solicitudes HTTP salientes desde el servidor de MongoDB Ops Manager a su punto final de webhook. Si su punto final de webhook está detrás de un firewall, agregue la dirección IP del servidor de Ops Manager a la lista de acceso IP del punto final.
Solucionar problemas de entrega de webhooks
Si su webhook no recibe alertas: