This page is not yet available in English. Read it in Portuguese

Skip to content
Menu da documentação

Operação

Incident Management

SLOs com orçamento de erro, incidentes a partir de alertas, plantão, runbooks e página de status, com a leitura pela API v1 e pela CLI.

#O que faz

Incidentes correlacionados com mudanças, investigação, plantão, runbooks e postmortems.

FuncionalidadeO que fazNa área logada
SLOs & error budgetsSLI, orçamento de erro, burn rate em várias janelas e mudanças recentes do serviço./plataforma/engenharia/slos
IncidentsAlertas do Alertmanager e do Sentry, deduplicação, linha do tempo e rascunho de postmortem sugerido por IA a partir dela, publicado só com aprovação de uma pessoa./plataforma/engenharia/incidentes
On-call & runbooksEscalas de plantão e escalonamento, com chamada por e-mail e WhatsApp (Voxentra Flow) nos canais que cada pessoa confirma, horário silencioso e reconhecimento que para o escalonamento; não chama por SMS nem por ligação. Runbooks versionados por serviço e tipo de alerta, sugeridos ao abrir o incidente, com execução passo a passo auditada; ação com efeito (automação n8n ou ferramenta MCP) só roda com aprovação humana na hora./plataforma/engenharia/incidentes
Incident responseAbertura manual e exercício (inclusive pelo GameDay do caos, sem chamar o plantão e fora do DORA), papéis de comandante, escriba, comunicação e operações, comando /incidente no Slack do próprio time com assinatura conferida, escriba que registra as mensagens do canal do incidente e separa decisões e ações, e escalonamento para Jira, ServiceNow e PagerDuty com a credencial do cliente cifrada, e Prometheus do cliente como fonte de saúde dos SLOs./plataforma/engenharia/incidentes
Status pagePágina pública por organização, que só o owner publica: componentes do catálogo, estado derivado de incidentes abertos e SLOs, histórico de 90 dias, incidentes e manutenções escritos por pessoas (nada interno sai sozinho) e inscrição por e-mail com confirmação./plataforma/engenharia/incidentes

#Como ativar

  • Na área logada: o dono adiciona o Cortex em Produtos (veja Produtos e conta pré-paga). As telas ficam no menu do produto.
  • Pela API v1 e pela CLI: a organização precisa do Cortex ativo, de conta de faturamento válida e de uma chave de API ligada ao workspace, com o escopo da rota.

Nota

Produto da plataforma não ativo ou módulo não liberado para a organização: a API v1 responde 404 not_found, como se a rota não existisse. Sem conta de faturamento válida: 402. Veja API v1.

#Primeiro uso

  1. Cadastre a fonte de alertas

    Em Incidentes, crie uma fonte (genérica, Alertmanager ou Sentry). O segredo dela aparece uma vez.
  2. Defina SLOs e plantão

    Na mesma área: SLOs por serviço, escalas e runbooks.
  3. Leia pela CLI ou pela API

    bash
    curl "https://aiuby.com/api/v1/engineering/incidents?status=open" -H "Authorization: Bearer $AIUBY_TOKEN"
    
    aiuby incidents list --status open
    aiuby slos list
    aiuby slos get <id>
    aiuby runbooks get <id>

#Entrada de alertas

A fonte de alertas não usa chave de API: cada envio é assinado com o segredo da fonte, em HMAC sobre timestamp.corpo.

ItemValor
RotaPOST /api/platform/alerts/{sourceId}
Cabeçalhosx-aiuby-timestamp e x-aiuby-signature: v1=<hex>
Janela do carimbo5 minutos para mais ou para menos
CorpoO formato da fonte (genérico, Alertmanager ou Sentry), até 256 KB
RecusasEntrega repetida, assinatura errada (e 429 depois de 30 erros por minuto do mesmo endereço) e acima do limite de alertas por fonte

#Rotas da API

RotaEscopoPara quêCLI
GET /api/v1/engineering/slosLer a engenharia (API v1) engineering:readLista os SLOsaiuby slos list
GET /api/v1/engineering/slos/{id}Ler a engenharia (API v1) engineering:readEstado de um SLOaiuby slos get <id>
GET /api/v1/engineering/slo-compositesLer a engenharia (API v1) engineering:readLista os SLOs compostosaiuby slos composites
GET /api/v1/engineering/slo-composites/{id}Ler a engenharia (API v1) engineering:readEstado de um SLO compostoaiuby slos composite <id>
GET /api/v1/engineering/incidentsLer a engenharia (API v1) engineering:readIncidentesaiuby incidents list
GET /api/v1/engineering/incidents/{id}Ler a engenharia (API v1) engineering:readUm incidenteaiuby incidents get <id>
GET /api/v1/engineering/runbooksLer a engenharia (API v1) engineering:readRunbooksaiuby runbooks list
GET /api/v1/engineering/runbooks/{id}Ler a engenharia (API v1) engineering:readUm runbookaiuby runbooks get <id>

Nota

Os SLOs pela API são só leitura: a consulta não grava alerta.

#O que ainda não existe

  • Abrir, reconhecer ou encerrar incidente por chave de API; linha do tempo e postmortem ficam na tela.
  • Executar runbook pela API: a execução é passo a passo na tela, e ação com efeito pede aprovação humana na hora.
  • Chamar o plantão por SMS ou ligação: só e-mail e WhatsApp.