Navegar na documentação

Criar um ouvinte de webhook

O assistente Adicionar ouvinte Webhook cria um ouvinte a partir de uma Fonte de Dados: você escolhe a urgência, a fonte e quais alertas entram, identificados pela key que o seu sistema envia no payload.

Antes de começar

É preciso ter uma fonte cadastrada em Ajustes › Fontes de Dados; sem isso o assistente avisa Cadastre uma fonte de dados em Ajustes antes de criar ouvintes. Veja Criar uma fonte de dados.

Diferente do Zabbix, uma fonte de webhook não tem catálogo de triggers. O que o assistente lista são os alertas que a fonte já recebeu, agrupados pela key. Uma fonte recém-criada ainda não tem nada para listar, e por isso existe o caminho de digitar a key à mão.

Passo a passo

  1. Urgência Escolha Sirene, Crítico, Padrão ou Silencioso, e ligue se quiser Avisar em recorrências e Avisar quando resolver (com o Som da resolução). A urgência vem primeiro porque a Sirene muda o que a etapa Alertas oferece.
  2. Fonte Marque uma fonte de dados. Um ouvinte de webhook parte de uma fonte só; para juntar outras origens, adicione gatilhos depois em Editar ouvinte.
  3. Alertas A primeira linha é Todos os alertas desta fonte: cria um gatilho de Fonte inteira, que cobre qualquer alerta, inclusive os que nunca chegaram. Abaixo vem o catálogo dos alertas já recebidos, cada um com título, host e quantas vezes ocorreu. Marque os que interessam. Se a fonte ainda não recebeu nada, o app avisa Nenhum alerta recebido desta fonte ainda. A fonte inteira pode ser ouvida mesmo assim.
  4. Adicionar key manualmente Ainda na etapa Alertas, digite a key exatamente como o seu script envia no campo key do payload e toque em Adicionar. A key manual vale para qualquer host e aparece marcada como qualquer host · adicionada à mão. Esse bloco some quando Todos os alertas desta fonte está marcado.
  5. Resumo Dê o Nome do ouvinte e confira urgência, fonte, quantidade de gatilhos e avisos extras. Toque em Salvar ouvinte.

A relação com a key

A key é a identidade estável de um problema na fonte: o mesmo problema deve chegar sempre com a mesma key, e é ela que agrupa ocorrências, conta recorrências e permite resolver. O ouvinte casa pela mesma identidade. Um alerta do catálogo vira um gatilho de key + host; uma key digitada à mão vira um gatilho de key em qualquer host. Alertas enviados sem key chegam soltos e só são alcançados por um ouvinte de fonte inteira. Veja Ciclo de vida do alerta e a key.

GatilhoCasa comDisponível na Sirene
Todos os alertas desta fonteQualquer alerta da fonte, com ou sem key, de qualquer hostNão
Alerta do catálogoA key daquele alerta, no host em que ele chegouSim, se tiver key
Key adicionada à mãoA key digitada, em qualquer hostSim
Fonte nova e Sirene. Uma fonte que ainda não recebeu alertas não tem catálogo e a Sirene não aceita fonte inteira. Digitar a key à mão é o único caminho para um ouvinte Sirene numa fonte recém-criada.

O que muda com a Sirene

Com a urgência Sirene, a etapa Alertas mostra o aviso Sirene: no máximo 10 alertas identificados (com key). Envios com severidade abaixo de 5 são recusados pela API nesses alertas. A linha Todos os alertas desta fonte desaparece, alertas sem key ficam de fora e o teto de 10 vale para o ouvinte inteiro.

A severidade é garantida no recebimento: quando um alerta de problema cai numa key coberta por ouvinte Sirene com severity menor que 5, a API responde 422 e explica o motivo; com severity: 5, a resposta ganha siren_listener: true. Resoluções passam sempre. Veja Sirene: o alerta máximo e Referência do payload.

Veja também