Integração de Notificações de Alerta com Sistemas de IM

Introdução

No ambiente de negócios digitalizado de hoje, o monitoramento e o alerta desempenham papéis cruciais. Eles não apenas ajudam as empresas a detectar anomalias no sistema de maneira oportuna, mas também reduzem efetivamente as perdas de negócios causadas por falhas. O API7 Enterprise oferece várias regras de alerta, permitindo que os usuários configurem estratégias de alerta flexíveis. Através do método de notificação de modelos Webhook, as informações de alerta são enviadas para nossos sistemas de Mensagens Instantâneas (IM) comumente usados. Isso nos ajuda a monitorar o status operacional do sistema de forma rápida e eficaz, permitindo uma resposta oportuna e garantindo a continuidade e estabilidade dos negócios.

Agora, vamos nos aprofundar em como usar o API7 Enterprise para configurar regras de alerta e enviar informações de alerta para sistemas IM existentes via Webhook, ajudando você a dominar facilmente o processo de configuração para esse cenário.

Regras de Alerta e Notificações

1. Estratégias de Alerta

O API7 Enterprise atualmente suporta várias estratégias de alerta, permitindo que os usuários configurem de forma flexível com base nas necessidades do negócio. Estratégias comuns de alerta incluem:

• Acionar um alerta quando um certificado estiver prestes a expirar.
• Acionar um alerta quando uma instância do gateway estiver offline.
• Acionar um alerta com base na quantidade de códigos de status 4xx e 5xx.
• Acionar um alerta com base na proporção de códigos de status 4xx e 5xx.

Na aplicação prática, várias estratégias podem ser combinadas para atender a diversas necessidades de alerta, garantindo o acionamento automático de alertas e notificando os responsáveis, melhorando assim a velocidade de resposta e a eficiência na resolução de falhas.

2. Definição e Gerenciamento de Níveis de Alerta

Os níveis de alerta classificam e identificam diferentes situações de alerta, permitindo que os usuários reconheçam claramente a importância dos alertas. Níveis comuns de alerta incluem alto, médio e baixo. Os administradores definem diferentes níveis de alerta para garantir que alertas importantes recebam atenção e tratamento oportuno. O API7 Enterprise suporta os usuários na configuração e gerenciamento fácil dos níveis de alerta para atender às necessidades de monitoramento em diferentes cenários.

3. Mecanismo de Notificações de Alerta

Podemos criar modelos de Webhook no API7 Enterprise. Quando o sistema detecta anomalias e aciona um alerta, o API7 Enterprise automaticamente chama o endereço Webhook pré-configurado. Ele envia as informações de alerta na forma de uma requisição HTTP POST para o endereço de destino especificado. Webhook é uma tecnologia comumente usada para comunicação entre aplicativos, permitindo que os usuários enviem automaticamente dados para um URL especificado quando eventos específicos ocorrem.

Sistemas IM populares como Slack, Microsoft Teams, Lark, DingTalk e WeCom fornecem robôs Webhook para enviar e receber mensagens. Abaixo, usamos o Lark como exemplo para detalhar como integrar notificações de alerta com o API7 Enterprise.

Integração com Robôs Webhook de Sistemas IM

Robôs Webhook em sistemas IM são contas especiais usadas para enviar mensagens automaticamente, notificar eventos ou realizar operações específicas. Ao configurar notificações de modelos Webhook do API7 Enterprise para integrar com o endereço do robô Webhook no sistema IM, a push automática de informações de alerta é alcançada, aumentando significativamente a real-time e a precisão das notificações de alerta.

Configurando o Robô Webhook do Lark

1. Primeiro, precisamos criar e configurar um robô Webhook no Lark. No grupo correspondente, encontre a opção para adicionar um robô de grupo. Então, podemos ver a opção para Custom Bot.

2. Após adicionar um avatar e uma descrição relevante para o robô, clique em Next, e você verá o endereço Webhook. Este endereço é usado para receber informações de alerta.

3. Dependendo das suas necessidades, você pode definir algumas regras de política de segurança para o seu robô, como palavras-chave, lista de IPs permitidos e mais.

Configurando Regras de Alerta no API7 Enterprise

1. No API7 Enterprise, adicione uma estratégia de alerta e especifique as condições de acionamento.

2. Configure o modelo de notificação Webhook:

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

3. Para facilitar testes futuros, alteramos o intervalo de verificação de alerta para 1 minuto.

4. Ative a estratégia de alerta e a notificação Webhook correspondente.

5. Envie uma requisição com um código de status 401 para acionar o alerta:

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

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

6. Em seguida, você deve ver a mensagem de alerta correspondente enviada pelo robô Webhook no grupo do Lark.

Uso Avançado

O API7 Enterprise suporta a passagem de variáveis de contexto de alerta através do Webhook. Variáveis comuns incluem:

• Título: {{ .Title }} Título do Alerta
• Severidade: {{ .Severity }} Severidade do Alerta
• Detalhe: {{ .Detail }} Descrição do Alerta
• AlertEvents: {{ .AlertEvents.XXX }} Eventos de alerta correspondentes com base em diferentes configurações de política.

Conclusão

O API7 Enterprise oferece muitos recursos poderosos, proporcionando conveniência e suporte para o monitoramento e gerenciamento de API empresarial. Ao usar o mecanismo de notificação de alerta Webhook integrado com sistemas IM, as informações de alerta podem ser transmitidas de forma rápida e precisa para os responsáveis, melhorando a velocidade e a qualidade da resposta a falhas. Isso traz uma experiência de monitoramento e gerenciamento mais eficiente e confiável para as empresas.