Com o external service custom, recebemos dados em nossa API (Application Programming Interface). Nós geramos um CURL que nos enviará os dados de “alarmed” (abre um incidente na plataforma) ou “resolved” (fecha o incidente na plataforma). Desta forma, nossa plataforma consegue tratar esses dados e acionar sua equipe caso a sua aplicação esteja com erro. Para configurar uma integração custom, solicite junto à nossa equipe o CURL.
Criando um API Token
Para criar um API Token na plataforma:
1 – Clique em Organization Settings no canto inferior esquerdo
2 – Na aba API, clique no botão “+” para criar um novo API Token
3 – Selecione o tipo Api Token e preencha o campo Name, em seguida, clique em Generate Integration Token
Criando um External Service Custom
1 – Entre no Service Hub, localizado no menu lateral esquerdo
2 – Selecione entre as opções, caso queira abrir um alerta, selecione Alert Custom ou caso queira abrir um incidente, selecione Incident Custom
3 – No formulário, deve preencher o External service name e os Responders que receberão s notificações deste serviço, em seguida clique em CREATE
4 – Mais abaixo aparecerá as informações do seu External Service solicitando que selecione um Api token, selecione o criado anteriormente
5 – Após selecionar o Api Token, as informações necessárias para configurar o CURL estão completas
6 – Após criados, seus External Services aparecerão no External services monitoring center, eles serão classificados em ordem de status (em alarme antes dos operacionais)
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",
"organization": "<org_uid fornecido pela Elven>",
"severity": "critical"
}'
- “–url” = API_URL gerada na criação do External Service;
- “titile” = Neste campo você define um título que aparecerá no incidente aberto na 1P;
- “description” = Neste campo você define uma descrição ao incidente, aparecerá em “causa” no incidente aberto na 1P;
- “external_aggregate_key” = Neste campo você define um identificador para “abrir” e “fechar” o incidente, ou seja, quando for fechar o incidente, ele deve ter o mesmo external_aggregate_key que o incidente aberto;
- “action” = Neste campo você define a ação a ser executada podendo ser “alarmed” (abre o incidente) ou “resolved” (fecha o incidente);
- “organization” = Este campo é fornecido pela equipe da Elven no momento da solicitação;
- “severity” = Neste campo você define a severidade associada ao incidente podendo ser informational, low, moderate, high ou critical.
Obs.: não se esqueça de adicionar os headers:
–header ‘Content-Type: application/json’ \
–header ‘User-Agent: 1PcustomAuth/1.0’ \
Postando este CURL você abrirá/fechará incidentes na plataforma, podendo assim fazer a gestão, sendo notificado.