Documentação
Incident ManagementO External Services Center da Elven Platform é a ponte que conecta você às melhores ferramentas do mercado para monitorar, gerenciar e resolver incidentes de forma simples e eficiente. Nele, é possível integrar o Grafana com a Elven Platform, permitindo o recebimento de alertas e eventos relacionados a incidentes diretamente na plataforma. Isso possibilita monitorar e analisar suas aplicações e serviços sob a perspectiva da Gestão de Incidentes, utilizando as melhores práticas e metodologias do mercado, tudo em um único lugar.
API Token
Para integrar o Elven Platform com o Grafana, precisamos criar um API Token. Essa chave única é indispensável para que as duas plataformas se conectem com segurança, garantindo a troca de informações confiável e autenticada. Basta acessar o Organization Settings da Elven Platform, navegar até a seção de API e gerar.
Criando um API Token
- 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 Grafana
- Navegue até o menu principal e clique em Services Hub.
- Em External Services Monitoring, selecione o item Alert Grafana.
Criando o External Services para Alert Grafana
No formulário, comece preenchendo o campo External Service Name, que será o nome do serviço externo, e defina os Responders, ou seja, as pessoas ou equipes que receberão notificações relacionadas a este serviço. Após isso, clique em CREATE para prosseguir. Essa ação criará o registro inicial do seu serviço externo.
Em seguida, localize o API Token que você gerou anteriormente e selecione-o para configurar a integração com o Grafana.
Configurando Webhooks no Grafana
Conectar o Grafana à Elven Platform é um processo simples e intuitivo, especialmente com o suporte dedicado às versões 8 e 10 do Grafana. Para começar, acesse o menu à esquerda no Grafana e clique em Contact Point, onde você encontrará a opção Add Contact Point. No formulário, defina um nome para o ponto de contato, como “Elven Platform”, para facilitar sua identificação na plataforma. Escolha a integração do tipo Webhook, que permite o envio de alertas em tempo real. No campo URL, insira a URL gerada na Elven Platform, certificando-se de selecionar a URL correspondente à versão do Grafana que você está utilizando — seja ela 8 ou 10. Essa compatibilidade garante que as ferramentas se integrem perfeitamente, mantendo um fluxo consistente de notificações.
Ao realizar o teste, lembre-se de criar uma label chamada severity. O valor dessa label deve representar a severidade do evento, utilizando uma das categorias predefinidas pela Elven Platform:
- critical
- high
- moderate
- low
- informational
Certifique-se de escolher o valor que melhor descreva a gravidade do cenário. Essa padronização garante clareza e facilita o entendimento no monitoramento e gestão dos alertas.
Com essa integração, você transforma a gestão de incidentes, centralizando todas as informações críticas diretamente na Elven Platform. Além de ser fácil de configurar, o suporte às diferentes versões do Grafana assegura que nenhum detalhe técnico será um obstáculo, proporcionando uma experiência adaptada às suas necessidades. Sua equipe estará sempre conectada e pronta para agir, garantindo agilidade e segurança no monitoramento e na resolução de problemas.
No Grafana, no menu à esquerda, vá em contact point e clique em Add contact point:
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: Chave única gerada na Elven Platform para permitir a autenticação e troca de informações segura entre a plataforma e ferramentas externas como Grafana.
External Services Monitoring: Área da Elven Platform que lista os serviços externos integrados, permitindo monitorar status, responder a incidentes e configurar notificações.
Contact Point: Recurso do Grafana usado para configurar pontos de contato para alertas, como Webhooks, garantindo o envio de notificações em tempo real.
Webhook: Método de comunicação entre sistemas que envia notificações automaticamente a uma URL específica, conectando o Grafana à Elven Platform.
URL: Endereço gerado pela Elven Platform que deve ser usado ao configurar um Webhook no Grafana. É específico para a versão utilizada do Grafana (8 ou 10).
Responders: Pessoas ou equipes definidas na configuração de um serviço externo que receberão notificações sobre incidentes detectados.
Alert Grafana: Serviço específico do External Services Monitoring na Elven Platform para configurar a integração com alertas do Grafana.
Status de Alarme: Classificação visual no External Services Monitoring Center, que destaca serviços em estado de alerta para priorizar ações.
Versão do Grafana: Versão específica do Grafana (como 8 ou 10) que define a URL correspondente para configuração do Webhook.
Gestão de Incidentes: Processo de monitorar, analisar e responder a eventos críticos para minimizar impactos em sistemas e serviços.
Notificações em Tempo Real: Mensagens enviadas imediatamente após um incidente ser detectado, permitindo ações rápidas para resolver problemas.
External Service Name: Nome atribuído a um serviço externo durante a configuração na Elven Platform para facilitar sua identificação e organização.
Fluxo Consistente de Notificações: Garantia de que alertas gerados no Grafana cheguem à Elven Platform sem interrupções, otimizando a gestão de incidentes.