Intégration des notifications d'alerte avec les systèmes IM

Introduction

Dans l'environnement commercial numérisé d'aujourd'hui, la surveillance et les alertes jouent un rôle crucial. Elles aident non seulement les entreprises à détecter les anomalies du système en temps opportun, mais réduisent également efficacement les pertes commerciales causées par les pannes. API7 Enterprise propose diverses règles d'alerte, permettant aux utilisateurs de définir des stratégies d'alerte flexibles. Grâce à la méthode de notification des modèles Webhook, les informations d'alerte sont envoyées à nos systèmes de messagerie instantanée (IM) couramment utilisés. Cela nous aide à surveiller l'état opérationnel du système de manière rapide et efficace, permettant une réponse rapide et assurant la continuité et la stabilité des activités.

Maintenant, approfondissons comment utiliser API7 Enterprise pour configurer des règles d'alerte et envoyer des informations d'alerte aux systèmes IM existants via Webhook, vous aidant ainsi à maîtriser facilement le processus de configuration pour ce scénario.

Règles d'alerte et notifications

1. Stratégies d'alerte

API7 Enterprise prend actuellement en charge plusieurs stratégies d'alerte, permettant aux utilisateurs de configurer de manière flexible en fonction des besoins commerciaux. Les stratégies d'alerte courantes incluent :

• Déclencher une alerte lorsqu'un certificat est sur le point d'expirer.
• Déclencher une alerte lorsqu'une instance de passerelle est hors ligne.
• Déclencher une alerte en fonction de la quantité de codes d'état 4xx et 5xx.
• Déclencher une alerte en fonction du ratio de codes d'état 4xx et 5xx.

Dans une application pratique, plusieurs stratégies peuvent être combinées pour répondre à divers besoins d'alerte, assurant un déclenchement automatique des alertes et notifiant le personnel concerné, améliorant ainsi la vitesse de réponse et l'efficacité de la résolution des pannes.

2. Définition et gestion des niveaux d'alerte

Les niveaux d'alerte classifient et identifient différentes situations d'alerte, permettant aux utilisateurs de reconnaître clairement l'importance des alertes. Les niveaux d'alerte courants incluent élevé, moyen et faible. Les administrateurs définissent différents niveaux d'alerte pour s'assurer que les alertes importantes reçoivent une attention et un traitement rapides. API7 Enterprise permet aux utilisateurs de configurer et de gérer facilement les niveaux d'alerte pour répondre aux besoins de surveillance dans différents scénarios.

3. Mécanisme des notifications d'alerte

Nous pouvons créer des modèles Webhook dans API7 Enterprise. Lorsque le système détecte des anomalies et déclenche une alerte, API7 Enterprise appelle automatiquement l'adresse Webhook préconfigurée. Il envoie les informations d'alerte sous la forme d'une requête HTTP POST à l'adresse de destination spécifiée. Webhook est une technologie couramment utilisée pour la communication entre les applications, permettant aux utilisateurs d'envoyer automatiquement des données à une URL spécifiée lorsque des événements spécifiques se produisent.

Les systèmes IM populaires comme Slack, Microsoft Teams, Lark, DingTalk et WeCom fournissent des robots Webhook pour envoyer et recevoir des messages. Ci-dessous, nous utilisons Lark comme exemple pour détailler comment intégrer les notifications d'alerte avec API7 Enterprise.

Intégration avec les robots Webhook des systèmes IM

Les robots Webhook dans les systèmes IM sont des comptes spéciaux utilisés pour envoyer automatiquement des messages, notifier des événements ou effectuer des opérations spécifiques. En configurant les notifications de modèle Webhook d'API7 Enterprise pour s'intégrer à l'adresse du robot Webhook dans le système IM, la diffusion automatique des informations d'alerte est réalisée, améliorant grandement la rapidité et la précision des notifications d'alerte.

Configuration du robot Webhook de Lark

1. Tout d'abord, nous devons créer et configurer un robot Webhook sur Lark. Dans le groupe correspondant, trouvez l'option pour ajouter un robot de groupe. Ensuite, nous pouvons voir l'option pour Custom Bot.

2. Après avoir ajouté un avatar et une description pertinente pour le robot, cliquez sur Suivant, et vous verrez l'adresse Webhook. Cette adresse est utilisée pour recevoir les informations d'alerte.

3. En fonction de vos besoins, vous pouvez définir certaines règles de politique de sécurité pour votre robot, telles que des mots-clés, une liste blanche d'IP, et plus encore.

Configuration des règles d'alerte dans API7 Enterprise

1. Dans API7 Enterprise, ajoutez une stratégie d'alerte et spécifiez les conditions de déclenchement.

2. Configurez le modèle de notification Webhook :

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

3. Pour faciliter les tests futurs, nous changeons l'intervalle de vérification des alertes à 1 minute.

4. Activez la stratégie d'alerte et la notification Webhook correspondante.

5. Envoyez une requête avec un code d'état 401 pour déclencher l'alerte :

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

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

6. Ensuite, vous devriez voir le message d'alerte correspondant envoyé par le robot Webhook dans le groupe Lark.

Utilisation avancée

API7 Enterprise prend en charge la transmission de variables de contexte d'alerte via Webhook. Les variables courantes incluent :

• Titre : {{ .Title }} Titre de l'alerte
• Gravité : {{ .Severity }} Gravité de l'alerte
• Détail : {{ .Detail }} Description de l'alerte
• AlertEvents : {{ .AlertEvents.XXX }} Événements d'alerte correspondants basés sur différents paramètres de politique.

Conclusion

API7 Enterprise offre de nombreuses fonctionnalités puissantes, fournissant une commodité et un soutien pour la surveillance et la gestion des API des entreprises. En utilisant le mécanisme de notification d'alerte Webhook intégré aux systèmes IM, les informations d'alerte peuvent être rapidement et précisément transmises au personnel concerné, améliorant la vitesse et la qualité de la réponse aux pannes. Cela apporte une expérience de surveillance et de gestion plus efficace et fiable aux entreprises.