O DevStats fornece uma API para enviar dados sobre deploys. Este tutorial foca em enviar dados de deploy via API do DevStats para permitir rastreamento de deploy mais preciso para a métrica de Deploy e o snapshot de DORA metrics.
Dica: Integre a API de Deploys do DevStats com seu pipeline de deploy CI/CD para enviar métricas de deploy diretamente ao DevStats.
☑️ Pré-requisitos
Antes de começar, certifique-se de ter:
- Um token de API para autenticar requisições. Se você não tem um, siga este guia para criar seu token de API.
- Uma ferramenta como Postman (UI) ou cURL (CLI) para enviar requisições de API.
Passo 1: Criar um Novo Deploy
Para criar um novo deploy, envie uma requisição POST com os seguintes detalhes (referência da API):
Campos
- Repository: O nome completo do repositório usando o formato
organização/repositório. - Deployed At: A data do deploy no formato ISO 8601 (ex:
2024-07-20T15:30:00+00:00).
Configuração da Requisição
- Endpoint:
https://service.devstats.com/api/v1/deploys - Headers:
{ Accept: application/json } - Authorization:
Bearer SEU_TOKEN_DE_API(Substitua este valor pelo seu token de API)
Aqui está um exemplo de corpo de requisição para a requisição POST:
{
"repository": "michielmulders/coding",
"deployed_at": "2024-12-09T15:30:00-03:00"
}
Exemplo de Resposta
Você receberá uma resposta confirmando a criação do deploy.
✅ Verifique Seu Deploy (Verifique Configurações de Fonte de Dados)
Para garantir que seu deploy esteja refletido nas métricas de Deploy e DORA, confirme que suas configurações de fonte de dados estão configuradas corretamente. Se o deploy não aparecer nas suas métricas, pode ser necessário ajustar a fonte de dados para rastrear deploys via API.
Como Atualizar Sua Fonte de Dados para API:
- Navegue até a página de Configurações no DevStats.
- Selecione a aba Avançado e localize a opção Fonte de Dados de Deploys. Defina esta opção como "API".
Uma vez atualizado, retorne ao dashboard de Deploy ou DORA metrics. Seu deploy agora deve aparecer nas estatísticas.