Integración de Notificaciones de Alertas con Sistemas de Mensajería Instantánea (IM)

Introducción

En el entorno empresarial digitalizado de hoy, la monitorización y las alertas desempeñan roles cruciales. No solo ayudan a las empresas a detectar anomalías en el sistema de manera oportuna, sino que también reducen efectivamente las pérdidas comerciales causadas por fallos. API7 Enterprise ofrece diversas reglas de alerta, permitiendo a los usuarios configurar estrategias de alerta flexibles. A través del método de notificación de plantillas Webhook, la información de alerta se envía a nuestros sistemas de mensajería instantánea (IM) más utilizados. Esto nos ayuda a monitorear el estado operativo del sistema de manera rápida y efectiva, permitiendo una respuesta oportuna y garantizando la continuidad y estabilidad del negocio.

Ahora, profundicemos en cómo usar API7 Enterprise para configurar reglas de alerta y enviar información de alerta a sistemas IM existentes a través de Webhook, ayudándote a dominar fácilmente el proceso de configuración para este escenario.

Reglas de Alerta y Notificaciones

1. Estrategias de Alerta

API7 Enterprise actualmente admite múltiples estrategias de alerta, permitiendo a los usuarios configurarlas de manera flexible según las necesidades del negocio. Las estrategias de alerta comunes incluyen:

• Activar una alerta cuando un certificado está a punto de expirar.
• Activar una alerta cuando una instancia de la puerta de enlace está fuera de línea.
• Activar una alerta basada en la cantidad de códigos de estado 4xx y 5xx.
• Activar una alerta basada en la proporción de códigos de estado 4xx y 5xx.

En la aplicación práctica, se pueden combinar múltiples estrategias para satisfacer diversas necesidades de alerta, asegurando que las alertas se activen automáticamente y notifiquen al personal relevante, mejorando así la velocidad de respuesta y la eficiencia en la resolución de fallos.

2. Definición y Gestión de Niveles de Alerta

Los niveles de alerta clasifican e identifican diferentes situaciones de alerta, permitiendo a los usuarios reconocer claramente la importancia de las alertas. Los niveles de alerta comunes incluyen alto, medio y bajo. Los administradores configuran diferentes niveles de alerta para asegurar que las alertas importantes reciban atención y manejo oportuno. API7 Enterprise permite a los usuarios configurar y gestionar fácilmente los niveles de alerta para satisfacer las necesidades de monitorización en diferentes escenarios.

3. Mecanismo de Notificaciones de Alerta

Podemos crear plantillas Webhook en API7 Enterprise. Cuando el sistema detecta anomalías y activa una alerta, API7 Enterprise llama automáticamente a la dirección Webhook preconfigurada. Envía la información de alerta en forma de una solicitud HTTP POST a la dirección de destino especificada. Webhook es una tecnología comúnmente utilizada para la comunicación entre aplicaciones, permitiendo a los usuarios enviar automáticamente datos a una URL especificada cuando ocurren eventos específicos.

Sistemas IM populares como Slack, Microsoft Teams, Lark, DingTalk y WeCom proporcionan robots Webhook para enviar y recibir mensajes. A continuación, usamos Lark como ejemplo para detallar cómo integrar las notificaciones de alerta con API7 Enterprise.

Integración con Robots Webhook de Sistemas IM

Los robots Webhook en sistemas IM son cuentas especiales utilizadas para enviar mensajes automáticamente, notificar eventos o realizar operaciones específicas. Al configurar las notificaciones de plantillas Webhook de API7 Enterprise para integrarse con la dirección del robot Webhook en el sistema IM, se logra el envío automático de información de alerta, mejorando enormemente la precisión y la inmediatez de las notificaciones de alerta.

Configuración del Robot Webhook de Lark

1. Primero, necesitamos crear y configurar un robot Webhook en Lark. En el grupo correspondiente, encuentra la opción para agregar un robot de grupo. Luego, podemos ver la opción para Custom Bot.

2. Después de agregar un avatar y una descripción relevante para el robot, haz clic en Siguiente y verás la dirección Webhook. Esta dirección se utiliza para recibir información de alerta.

3. Dependiendo de tus necesidades, puedes configurar algunas reglas de política de seguridad para tu robot, como palabras clave, lista blanca de IP, y más.

Configuración de Reglas de Alerta en API7 Enterprise

1. En API7 Enterprise, agrega una estrategia de alerta y especifica las condiciones de activación.

2. Configura la plantilla de notificación Webhook:

{ "msg_type": "text", "content": { "text": "API7 EE Alarm: 4xx error" } }

3. Para facilitar pruebas futuras, cambiamos el intervalo de verificación de alerta a 1 minuto.

4. Activa la estrategia de alerta y la notificación Webhook correspondiente.

5. Envía una solicitud con un código de estado 401 para activar la alerta:

curl -i http://127.0.0.1:9080/get

HTTP/1.1 401 Unauthorized
...
{"message":"Missing API key found in request"}

6. A continuación, deberías ver el mensaje de alerta correspondiente enviado por el robot Webhook en el grupo de Lark.

Uso Avanzado

API7 Enterprise admite pasar variables de contexto de alerta a través de Webhook. Las variables comunes incluyen:

• Título: {{ .Title }} Título de la alerta
• Gravedad: {{ .Severity }} Gravedad de la alerta
• Detalle: {{ .Detail }} Descripción de la alerta
• AlertEvents: {{ .AlertEvents.XXX }} Eventos de alerta correspondientes según diferentes configuraciones de políticas.

Conclusión

API7 Enterprise ofrece muchas funciones poderosas, proporcionando conveniencia y soporte para la monitorización y la gestión de API empresarial. Al utilizar el mecanismo de notificación de alertas Webhook integrado con sistemas IM, la información de alerta se puede transmitir de manera rápida y precisa al personal relevante, mejorando la velocidad y la calidad de la respuesta a fallos. Esto brinda una experiencia de monitorización y gestión más eficiente y confiable para las empresas.