# Guia Configuração do External Service Alert Grafana na Elven Platform

O **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.

{% embed url="<https://demo.elven.works/demo/cmd3gutk2038y3l0itl41nqbs>" %}

## **API Token**&#x20;

Para integrar a 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**&#x20;

* No menu superior na parte de configuração de seu usuário, clique em **Organization Settings**. &#x20;
* Na aba API, clique no botão **+** para criar um novo API Token.&#x20;

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FtsWeklxO90YoMWuhuzBk%2Fgrafa01.png?alt=media&#x26;token=6f40f5e0-f5e0-40f7-8223-38df4294f7b6" alt=""><figcaption></figcaption></figure>

## **Acessando External Service Alert Grafana**

* Navegue até o menu principal e clique em **Services Hub**. &#x20;
* Em **External Services Monitoring**, selecione o item **Alert Grafana**.&#x20;

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FE9fQX82FcsUTiTQH4k9p%2Fgrafa02.png?alt=media&#x26;token=ca5bbd24-33e4-4197-a40f-310193609cbd" alt=""><figcaption></figcaption></figure>

## **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.

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FqTxap3jtvT9MnUJeo5TF%2Fgrafa03.png?alt=media&#x26;token=4190d92e-c719-4514-a0d3-92a9dbb8b9c2" alt=""><figcaption></figcaption></figure>

Em seguida, localize o **API Token** que você gerou anteriormente e selecione-o para configurar a integração com o Grafana.

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2F0ZZCwJMkMIeaoK1biy5T%2Fgrafa04.png?alt=media&#x26;token=d2b6e40d-889b-4b28-8695-fc4c3613f790" alt=""><figcaption></figcaption></figure>

## **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.&#x20;

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.&#x20;

#### **No Grafana, no menu à esquerda, vá em contact point e clique em Add contact point:**

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FCCZabfc27Fx03fY2ERhM%2Fgrafa05.png?alt=media&#x26;token=ed9f49c0-84ec-47b0-a8a0-0f6fe3fb37cb" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FrWyzDKgnypPsuKLukhtm%2Fgrafa06.png?alt=media&#x26;token=5004f715-015a-4936-881b-b1d9ecbc8bb5" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2F5EslwogQlkICWLuWf6jf%2Fgrafa07.png?alt=media&#x26;token=0d45c704-2f22-45e0-84aa-3f8de3da87ab" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FFHsZodQ1ArPI8KFMRA3b%2Fgrafa08.png?alt=media&#x26;token=46330645-1b37-48ce-9d6a-0e5ad6452d48" alt=""><figcaption></figcaption></figure>

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.&#x20;

**External Services Monitoring:** Área da Elven Platform que lista os serviços externos integrados, permitindo monitorar status, responder a incidentes e configurar notificações.&#x20;

**Contact Point:** Recurso do Grafana usado para configurar pontos de contato para alertas, como Webhooks, garantindo o envio de notificações em tempo real.&#x20;

**Webhook:** Método de comunicação entre sistemas que envia notificações automaticamente a uma URL específica, conectando o Grafana à Elven Platform.&#x20;

**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).&#x20;

**Responders:** Pessoas ou equipes definidas na configuração de um serviço externo que receberão notificações sobre incidentes detectados.&#x20;

**Alert Grafana:** Serviço específico do **External Services Monitoring** na Elven Platform para configurar a integração com alertas do Grafana.&#x20;

**Status de Alarme:** Classificação visual no **External Services Monitoring Center**, que destaca serviços em estado de alerta para priorizar ações.&#x20;

**Versão do Grafana:** Versão específica do Grafana (como 8 ou 10) que define a URL correspondente para configuração do Webhook.&#x20;

**Gestão de Incidentes:** Processo de monitorar, analisar e responder a eventos críticos para minimizar impactos em sistemas e serviços.&#x20;

**Notificações em Tempo Real:** Mensagens enviadas imediatamente após um incidente ser detectado, permitindo ações rápidas para resolver problemas.&#x20;

**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.&#x20;

**Fluxo Consistente de Notificações:** Garantia de que alertas gerados no Grafana cheguem à Elven Platform sem interrupções, otimizando a gestão de incidentes.&#x20;