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

O recurso External Service Alert Custom permite que você conecte sua API à Elven Platform de forma prática e eficiente. Com essa funcionalidade, sua API pode enviar dados diretamente para a plataforma, utilizando uma URL gerada especificamente para esse propósito. Esses dados podem ser utilizados para abrir alertas personalizados, permitindo que você monitore eventos ou situações críticas de forma automatizada. É uma forma simples de integrar seu sistema com a plataforma, garantindo uma resposta rápida e alinhada às suas necessidades.

Além disso, você também pode enviar atualizações de status, como a resolução de problemas. Isso significa que, assim que um alerta for tratado em sua API, o status pode ser automaticamente atualizado na Elven Platform para Resolvido. Essa integração reduz o esforço manual e melhora a visibilidade do fluxo de trabalho, proporcionando mais controle e tranquilidade no gerenciamento dos seus serviços. Com essa flexibilidade, o External Service Alert Custom se adapta perfeitamente ao seu ambiente, colocando você no comando de suas operações.

Acessando External Service Alert Custom

Navegue até o menu principal e clique em Services Hub.

Em External Services Monitoring, selecione o item Alert Custom.

Configuração API Token

Para configurar o External Service Alert Custom, é necessário gerar um API Token. Este token será incluído diretamente na URL como parte da autenticação, funcionando como um item de segurança essencial para garantir que apenas usuários autorizados possam acessar e interagir com o serviço externo.

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.

Configuração do External Service Alert Custom

A configuração dos campos no External Service Alert Custom é um passo essencial para garantir que seus alertas 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 os alertas no futuro.

Já o campo Responders é a ponte entre o alerta 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 os 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. Com essa configuração, você transforma alertas em ações imediatas e eficazes, garantindo uma experiência fluida e confiável para todos os envolvidos.

URL do External Service Alert Custom

Ao configurar um External Service Alert Custom, 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 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 à URL do External Service Alert Custom, que é gerada automaticamente. Essa URL será usada para enviar as notificações de alerta a Elven Platfom. É importante guardar essa URL com cuidado e compartilhar apenas com pessoas ou sistemas autorizados. Com essa configuração, você garante que os alertas sejam entregues com eficiência, criando uma experiência confiável para os times envolvidos e reduzindo possíveis interrupções ou falhas no fluxo de comunicação.

Além disso, ao configurar um alerta no External Service Alert Custom, é importante preencher corretamente alguns campos-chave para garantir que o sistema funcione de forma eficaz. O campo action deve ser preenchido com os valores “alarmed” (para abrir um incidente) ou “resolved” (para indicar que o incidente foi resolvido). Já o campo external_aggregate_key funciona como um identificador único do incidente, sendo obrigatório em ambas as ações, pois ele conecta as informações de abertura e resolução do alerta. Além disso, o campo severity define a gravidade do incidente e deve ser preenchido com uma das opções disponíveis: critical (crítico), high (alto), moderate (moderado), low (baixo) ou informational (informativo). Ainda, no campo tags, você pode adicionar informações que ajudam a identificar a origem do alerta. Isso facilita a categorização e o rastreamento dos alertas, tornando a análise mais ágil e eficiente. Preencher esses campos corretamente ajuda a garantir uma comunicação clara e eficiente entre os sistemas, permitindo que os times priorizem as respostas com base na gravidade e no status do incidente.

Segue um exemplo de CURL da integração custom:

curl --request POST \
--url '<URL da API Elven>' \
--header 'Content-Type: application/json' \
--header 'User-Agent: 1PcustomAuth/1.0' \
--data '{
  "title": "<título do incidente>",
  "description": "<descrição do incidente>",
  "external_aggregate_key": "001",
  "action": "alarmed",
  "severity": "<Severidade do incidente>",
  "tags": [
    {
      "name": "tag-00",
      "value": "value0"
    },
    {
      "name": "tag-01",
      "value": "value1"
    },
    {
      "name": "tag-02",
      "value": "value2"
    }
  ]
}'

–url: API_URL gerada na criação do External Service.
title: Define o título do incidente que aparecerá na Elen Platfomr.
description: Descrição do incidente, que será exibida em “causa” na Elven Platfom.
external_aggregate_key: Identificador usado para “abrir” e “fechar” o incidente. Deve ser o mesmo para ambas as ações.
action: Ação executada, como “alarmed” (abrir) ou “resolved” (fechar) o incidente.
severity: Define a severidade do incidente (informational, low, moderate, high, critical).
tags: Use o campo tags para identificar a origem do alerta e facilitar sua análise.

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: Credencial exclusiva utilizada para autenticar e autorizar a comunicação entre sua API e a Elven Platform. Incluído na URL gerada para autenticação e envio de dados ao serviço externo.

External Service Alert Custom: Recurso da Elven Platform que permite integrar APIs externas para envio de alertas e atualizações de status. Automatizar o monitoramento de eventos críticos e gerenciar alertas com eficiência.

External Service Name: Nome atribuído ao serviço integrado. Identifica o serviço nos dashboards e relatórios da plataforma.

Responders: Pessoas, equipes ou sistemas responsáveis por responder aos alertas disparados. Notificados automaticamente para resolver problemas relacionados ao alerta.

URL do External Service Alert Custom: Endereço gerado automaticamente para envio de notificações de alerta ao serviço integrado. Conecta sua API ao sistema de alertas da Elven Platform.

Organization Settings: Menu da Elven Platform onde os tokens de API podem ser gerados e gerenciados. Local para criar novos tokens para autenticação de serviços externos.

title: Título do incidente que será exibido na Elven Platform. Fornece uma visão clara e rápida sobre a natureza do incidente.

description : Detalhe do incidente, exibido no campo “causa” na Elven Platform. Fornece contexto adicional para análise e solução do problema.

external_aggregate_key: Identificador único usado para associar ações como “abrir” e “fechar” incidentes. Deve ser o mesmo em ambas as ações para manter a consistência no gerenciamento do incidente.

action: Ação executada no incidente, como “alarmed” (abrir) ou “resolved” (fechar). Indica o status atual do incidente no sistema.

severity: Nível de gravidade do incidente, podendo ser informational, low, moderate, high ou critical. Ajuda a priorizar a resposta ao incidente com base em sua severidade.