Documentação
Incident ManagementA integração do External Service Alert CloudWatch com a Elven Platform é uma solução pensada para facilitar sua vida, centralizando a gestão de alertas em um único lugar. Com ela, você recebe notificações diretamente da Amazon CloudWatch, eliminando a necessidade de alternar entre plataformas e permitindo uma visão clara e eficiente de tudo o que acontece no seu ambiente de trabalho.
Além disso, a integração é totalmente personalizável. Você define quais métricas e condições são mais relevantes para o seu negócio, garantindo que os alertas recebidos sejam úteis e alinhados com suas necessidades. É uma maneira prática de transformar o monitoramento em uma experiência mais fluida, organizada e assertiva.
Configuração API Token
Para configurar o External Service Alert no CloudWatch, é necessário gerar um API Token. Esse token será utilizado como parte essencial do processo de autenticação, sendo incorporado diretamente no Path da requisição. Ele atua como uma camada de segurança adicional, garantindo que apenas usuários devidamente autorizados possam acessar e interagir com o serviço externo. Nesse contexto, o API Token é incluído como parâmetro da URL na chamada para a API. Isso assegura que a autenticação do cliente seja realizada corretamente durante o envio de alertas ou a interação com o serviço.
- No menu superior na parte de configuração de seu usuário, clique em Organization Settings.
- Na aba API, clique no botão + para criar um novo API Token.
Acessando External Service Alert Custom
- Navegue até o menu principal e clique em Services Hub.
- Em External Services Monitoring, selecione o item Alert CloudWatch.
Configuração do External Service Alert CloudWatch
A configuração dos campos no External Service Alert CloudWatch é um passo essencial para garantir que seus alertas na Elven Platform funcionem de forma eficiente e atinjam as pessoas certas no momento certo. O primeiro campo, External Service Name, é onde você deve dar um nome ao serviço que está sendo integrado. Este nome será exibido em dashboards e relatórios, facilitando a identificação rápida do serviço em meio a outros. Escolha um nome claro e descritivo, pois ele será sua referência para gerenciar e revisar o histórico de alertas no futuro.
Já o campo Responders é a ponte entre o incidente e a solução do problema. Aqui você define quem será notificado quando o alerta for disparado, sejam indivíduos específicos, equipes inteiras ou mesmo sistemas automatizados. Este campo é vital para que as notificações de alertas cheguem às pessoas certas, evitando atrasos e confusões. Adicione contatos relevantes, como e-mails ou IDs de equipes, e certifique-se de que todos os responsáveis tenham as informações e acessos necessários para agir rapidamente.
Função Lambda do External Service Alert CloudWatch
Ao configurar um External Service Alert CloudWatch, um dos passos mais importantes é selecionar a API Token que você gerou anteriormente. Essa chave é como uma credencial exclusiva que conecta seu sistema ao serviço de notificação de alertas de maneira segura. Pense nela como uma chave mestra que permite autenticação e comunicação entre as plataformas. Certifique-se de escolher a API Token correta e mantê-la protegida, pois ela é fundamental para o funcionamento do serviço e para garantir a integridade da integração.
Depois de selecionar a API Token, você terá acesso à função, que é gerada automaticamente. Essa função será responsável por intermediar a comunicação entre os alarmes do CloudWatch e a Elven Platform, processando os eventos recebidos e enviando notificações claras e acionáveis. A integração é projetada para transformar dados brutos em alertas estruturados, garantindo que qualquer evento importante seja capturado e entregue de forma eficiente. Isso assegura que você esteja sempre informado sobre os estados críticos de seus recursos, permitindo uma resposta rápida e assertiva.
AWS Lambda e AWS SNS
Essa automação é uma peça-chave para agilizar a identificação e a resposta a problemas em seu ambiente de monitoramento. Nesse processo, a função Lambda e o serviço SNS (Simple Notification Service) desempenham papéis fundamentais.
A função Lambda atua como o intermediário inteligente, processando os eventos gerados pelos alarmes do CloudWatch. Quando configurada corretamente, ela transforma essas notificações brutas em informações que podem ser enviadas para a Elven Platform, garantindo que você receba alertas claros e acionáveis. Sem a Lambda, o fluxo automatizado de dados entre o CloudWatch e a Elven Platform não seria possível.
O SNS (Simple Notification Service) desempenha um papel essencial como o “mensageiro” no sistema de integração com a Elven Platform. Ele gerencia e distribui as notificações geradas pelos alarmes do CloudWatch, garantindo que cada evento relevante seja entregue à função Lambda e, posteriormente, processado para envio à Elven Platform.
Essa configuração permite que os alertas sejam encaminhados de maneira eficiente e em tempo real para a plataforma, onde podem ser centralizados e gerenciados de forma mais prática.
Configurando no CloudWatch
Na aws devemos criar uma lambda, no menu de serviços procure por lambda, depois Create Function:
Na criação da lambda, devemos informar o nome e o Runtime. Por padrão o utilizado é o Node.js 20x.
Após preencher os campos acima clique em Create function.
Após acessar a lambda criada, em code source, substituir o padrão pelo obtido na criação do External Service Alert CloudWatch.
Clique em deploy, após inserir o código fornecido.
Acessar o serviço SNS.
Após acessar o serviço, acesse topics e depois create topic:
Selecionar a opção Standard, de um nome de sua preferência.
Após isso clicar em Create topic.
Ao criar o tópico, o próximo passo é associar a lambda criada. Para isso, role o cursor do mouse até o fim da página e clique em Create Subscription.
Selecione o tópico criado, em protocolo escolha o AWS Lambda e no endpoint selecione o criado para a integração. Após isso clique em Create subscription.
Após criar o tópico SNS, devemos configurar no CloudWatch.
Ao acessar o serviço cloudwatch, o próximo passo é criar o alerta clicando em “Create alarm”.
Selecione a métrica que seja monitorar, no exemplo abaixo estamos monitorando a métrica de CPU Utilization:
Defina as condições conforme sua operação
Clique em next para a próxima etapa.
Configure actions, devemos configurar a notificação para as três status:
- In Alarm
- OK
- Insufficient data
Todos devem enviar para o tópico criado no SNS, conforme exemplo:
Clique em next para a próxima etapa e assim nomear o alerta criado
Verifique se o alerta e condições foram criadas corretamente e clique em Create alarm para finalizar. Após isso todos os alertas do Cloudwatch deverão aparecer no One Platform.
Assim que configurado, o serviço aparecerá no External Services Monitoring Center, classificado por status, facilitando o monitoramento de incidentes com prioridade para aqueles em estado de alarme.
Configurações adicionais de segurança e performance
- Whitelist de IPs: A comunicação via API pode ser configurada para permitir apenas IPs autorizados. Para ativar ou modificar essa configuração, entre em contato com o suporte da Elven Platform.
- Rate Limiting: O tempo padrão para limitação de requisições é 5 minutos, mas pode ser ajustado conforme a necessidade. Para alterações, entre em contato com o suporte da Elven Platform.
Essas configurações garantem maior segurança e controle sobre o tráfego de dados entre os sistemas integrados.
Glossário de Termos Técnicos
API Token: Uma chave única usada para autenticação segura entre sistemas. No contexto desta documentação, é essencial para conectar o CloudWatch à Elven Platform.
CloudWatch: Serviço de monitoramento da AWS que coleta e rastreia métricas, monitora logs e gera alarmes para alterações em seu ambiente.
External Service Name: Nome descritivo atribuído a um serviço externo integrado à Elven Platform, usado para identificação em dashboards e relatórios.
Responders: Pessoas, equipes ou sistemas designados para receber notificações de alertas e agir conforme necessário.
Lambda Function: Função na AWS Lambda que processa eventos gerados pelos alarmes do CloudWatch e os encaminha para a Elven Platform.
SNS (Simple Notification Service): Serviço de mensagens da AWS que entrega notificações geradas pelos alarmes do CloudWatch para a função Lambda ou outros endpoints.
Node.js Runtime: Ambiente de execução usado para a função Lambda. Nesta documentação, o Node.js 20.x é mencionado como padrão.
Code Source: Área dentro da função Lambda onde o código de processamento é inserido ou editado antes de ser implantado.
Topics (SNS): Recurso do SNS usado para organizar e distribuir mensagens para assinantes específicos, como funções Lambda.
Subscription: Associação entre um tópico do SNS e um endpoint (por exemplo, uma função Lambda), que garante o envio de notificações.
CPU Utilization: Métrica comum usada no monitoramento de recursos para avaliar o uso da CPU por instâncias ou aplicações na AWS.
Standard Topic (SNS): Tipo de tópico no SNS que entrega mensagens com um esforço máximo de disponibilidade e confiabilidade.
Endpoint: Destino para onde as notificações do SNS são enviadas, como uma função Lambda configurada para a integração.