Notificação usando Webhooks
Sugerir alterações
PDFs
Os webhooks permitem que os usuários enviem notificações de alerta para vários aplicativos usando um canal de webhook personalizado.
Muitos aplicativos comerciais oferecem suporte a webhooks como uma interface de entrada padrão, por exemplo: Slack, PagerDuty, Teams e Discord, todos oferecem suporte a webhooks. Ao oferecer suporte a um canal webhook genérico e personalizável, o Data Infrastructure Insights pode oferecer suporte a muitos desses canais de entrega. Informações sobre webhooks podem ser encontradas nestes sites de aplicativos. Por exemplo, o Slack fornece"este guia útil" .
Você pode criar vários canais de webhook, cada canal direcionado a uma finalidade diferente; aplicativos separados, destinatários diferentes, etc.
A instância do canal webhook é composta pelos seguintes elementos:
Nome |
Nome único |
URL |
URL de destino do webhook, incluindo o prefixo http:// ou https:// junto com os parâmetros de URL |
Método |
GET, POST - O padrão é POST |
Cabeçalho personalizado |
Especifique quaisquer linhas de cabeçalho personalizadas aqui |
Corpo da mensagem |
Coloque o corpo da sua mensagem aqui |
Parâmetros de alerta padrão |
Lista os parâmetros padrão para o webhook |
Parâmetros e segredos personalizados |
Parâmetros e segredos personalizados permitem que você adicione parâmetros exclusivos e elementos seguros, como senhas |
Criando um Webhook
Para criar um webhook do Data Infrastructure Insights , acesse Admin > Notificações e selecione a aba Webhooks.
A imagem a seguir mostra um exemplo de webhook configurado para o Slack:
Insira as informações apropriadas para cada um dos campos e clique em "Salvar" quando terminar.
Você também pode clicar no botão "Testar Webhook" para testar a conexão. Observe que isso enviará o "Corpo da Mensagem" (sem substituições) para a URL definida de acordo com o Método selecionado.
Os webhooks do Data Infrastructure Insights compreendem uma série de parâmetros padrão. Além disso, você pode criar seus próprios parâmetros ou segredos personalizados.
Parâmetros: O que são e como usá-los?
Parâmetros de alerta são valores dinâmicos preenchidos por alerta. Por exemplo, o parâmetro %%TriggeredOn%% será substituído pelo objeto no qual o alerta foi disparado.
Você pode adicionar qualquer atributo de objeto (por exemplo, nome de armazenamento) como um parâmetro para um webhook. Por exemplo, você pode definir parâmetros para o nome do volume e o nome do armazenamento em uma descrição de webhook como: "Alta latência para volume: %%relatedObject.volume.name%%, Armazenamento: %%relatedObject.storage.name%%".
Observe que nesta seção, as substituições não são realizadas ao clicar no botão "Testar Webhook"; o botão envia uma carga útil que mostra as %% substituições, mas não as substitui por dados.
Parâmetros e segredos personalizados
Nesta seção, você pode adicionar quaisquer parâmetros personalizados e/ou segredos que desejar. Por motivos de segurança, se um segredo for definido, somente o criador do webhook poderá modificar este canal do webhook. É somente leitura para outros. Você pode usar segredos em URL/Cabeçalhos como %%<secret_name>%%.
Página de lista de webhooks
Na página da lista Webhooks, são exibidos os campos Nome, Criado por, Criado em, Status, Seguro e Último relatório.
Escolhendo Notificação de Webhook em um Monitor
Para escolher a notificação do webhook em um"monitor" , vá para Alertas > Gerenciar Monitores e selecione o monitor desejado ou adicione um novo monitor. Na seção Configurar notificações da equipe, escolha Webhook como método de entrega. Selecione os níveis de alerta (Crítico, Aviso, Resolvido) e escolha o webhook desejado.
Exemplos de webhook:
Webhooks para"Folga" Webhooks para"PagerDuty" Webhooks para"Equipes" Webhooks para"Discórdia"