O DevStats fornece uma API para enviar incidentes e atualizar dados de incidentes. Este tutorial foca na criação e resolução de incidentes via API, ajudando a garantir cálculos precisos de MTTR nas suas DORA metrics.
☑️ Pré-requisitos
Antes de começar, certifique-se de ter:
- Um token de API para autenticar requisições. Se você não possui um, siga este guia para criar seu token de API.
- Uma ferramenta como Postman (UI) ou cURL (CLI) para enviar requisições à API.
Passo 1: Criar um Incidente
Para criar um incidente, envie uma requisição POST com os seguintes detalhes (referência da API): Campos-Nome: Nome do incidente.
- Descrição: Explicação detalhada do incidente.
- Método de Detecção: Como o incidente foi detectado (
automated_monitoring,customersouinternally). - Iniciado Em: Data de início do incidente no formato ISO 8601 (ex:
2024-07-20T15:30:00+00:00). - Resolvido Em (Opcional): Data de resolução no formato ISO 8601. Se omitido, o incidente será considerado ativo.
Configuração da Requisição
- Endpoint:
https://service.devstats.com/api/v1/incidents - Headers:
{ Accept: application/json } - Autorização:
Bearer YOUR_API_TOKEN(Substitua este valor pelo seu token de API)
Aqui está um exemplo de corpo da requisição para a requisição POST:
{
"repository": "michielmulders/coding",
"name": "Problem with login",
"description": "It's impossible to log in to the system",
"detected_by": "automated_monitoring",
"started_at": "2024-12-09T15:30:00+00:00"
}
Exemplo de Resposta
Você receberá uma resposta confirmando a criação do incidente. Certifique-se de copiar o campo UUID da resposta — ele será necessário para atualizar o incidente no próximo passo.
Dica: Se o campo
resolved_atfornull, o incidente é considerado ativo.
Passo 2: Atualizar Incidente com Data de Resolução
Uma vez que o incidente esteja resolvido, envie uma requisição PATCH para atualizá-lo com a data de resolução (referência da API). Esta ação move o incidente para a aba Incidentes Resolvidos no DevStats e o inclui nos cálculos de MTTR.
Configuração da Requisição
- Endpoint:
https://service.devstats.com/api/v1/incidents/<UUID>(substitua<UUID>pelo UUID copiado no Passo 2). - Headers:
{ Accept: application/json } - Autorização:
Bearer YOUR_API_TOKEN
Exemplo de Corpo da Requisição
Não esqueça de adicionar o campo "resolved_at" ao corpo da requisição.
{
"resolved_at": "2024-12-09T16:30:00+00:00"
}
Exemplo de Resposta
Você receberá uma resposta confirmando a atualização, e o campo resolved_at agora refletirá o horário de resolução.
Tutorial em Vídeo
✅ Verificação Final
Vá até a funcionalidade de Incident Management no DevStats e verifique a aba "Incidentes Resolvidos". Você deverá ver o incidente atualizado listado com os detalhes da resolução.
Dica de Automação: Se você usa uma ferramenta de gerenciamento de incidentes, pode integrá-la com a API do DevStats para enviar e atualizar incidentes automaticamente, economizando tempo e garantindo rastreamento preciso do MTTR.