Criando Novos Alertas (Platform Events)

Para configurar um novo alerta, clique no botão + NEW DEFINITION, no canto superior direito da página Platform Events.

platform events

A criação de um alerta é feita por meio de um wizard com três etapas, especificadas no restante desta página:

  • EVENT, para a inserção de qual modificação será monitorada;

  • ACTIONS, para configurar os meios utilizados para enviar a notificação; e

  • REVIEW, que exibe as informações cadastradas para o alerta criado.

Event

A etapa EVENT compreende a definição do que deve ser monitorado e inclui duas seções: OVERVIEW e EVENT DETAILS:

platform events event

Estes são os campos a serem completados:

  • OVERVIEW

    • Name: nome para ajudar a identificar o alerta (não precisa ser único).

    • Object: define o objeto a ser monitorado e, caso exista alguma alteração, o alerta será emitido. Veja aqui os objetos disponíveis para seleção e o tipo de alteração monitorada em cada caso.

    • Tags: campo para incluir tags (etiquetas) opcionais que podem ser utilizadas para encontrar alertas mais facilmente (tanto na tela Platform Events quanto em Triggered Alerts). É possível incluir até 50 tags por alerta e cada uma pode ter até 70 caracteres.

      As etiquetas servem para categorizar os alertas seguindo os rótulos que fizerem sentido para o seu negócio. Por exemplo, você pode adicionar etiquetas para identificar APIs por unidade de negócio, para distinguir ambientes de desenvolvimento ou testes relacionados ao monitoramento, ou mesmo para apontar os desenvolvedores responsáveis pelos alertas. A ideia é pensar em categorias úteis para que depois você encontre os alertas que precisar mais rapidamente!
    • Classification: classificação, que representa o nível de criticidade. Opções: neutral (neutro), success (sucesso), warning (atenção) e critical (crítico).

      A classificação não tem um significado pré-definido. O usuário pode definir a criticidade de cada ação como julgar melhor, seguindo suas regras de negócio.

Após escolher o objeto, a seção EVENT DETAILS é exibida. Ela contém o campo Activity Type para seleção do tipo de modificação no objeto selecionado que dispará o alerta.

Na imagem acima, o campo de seleção lista as opções de modificação a ser monitorada para o objeto environment. Se escolhermos created, toda vez que um ambiente for criado, isso disparará uma notificação com o nome do ambiente, a informação de que foi criado, o usuário que o criou e a data de criação.

Após incluir os dados, o botão NEXT no canto inferior direito da tela será habilitado e levará à próxima etapa.

Actions

A etapa ACTIONS compreende os canais de envio de notificações (E-mail, Slack e Webhook):

actions

Para adicionar uma ação e configurá-la, clique em icon add.

É necessário que pelo menos uma ação seja configurada para que você possa salvar/criar o alerta.

E-mail

Quando esta ação é configurada, um email de notificação é enviado sempre que o alerta for disparado.

actions email

Para incluir destinatários, insira o endereço de email no campo E-mails, dentro da seção RECEIVERS. Você pode adicionar quantos endereços desejar, digitando-os individualmente ou inserindo múltiplos emails ao mesmo tempo, separando cada um com vírgulas.

Depois de um destinatário ter sido incluído no campo acima, ele receberá um email, como o da imagem abaixo, para que autorize o recebimento das notificações. Para confirmar, clicar sobre o botão YES, I WANT TO SEE EVERYTHING!. O link de confirmação contido no email será válido por 24 horas após o envio.
receivers email

Caso um destinatário não tenha ainda confirmado sua inscrição como recebedor, seu endereço de email será realçado em amarelo na tela de edição do alerta (veja mais sobre edição de alertas aqui).

Você pode enviar um novo email de confirmação clicando no ícone ao lado da lista de emails (icon new email), como na imagem abaixo:
actions email

Na seção ADD CUSTOM MESSAGE você pode inserir uma mensagem adicional personalizada a ser enviada com a notificação. Para isso, habilite o botão e inclua a mensagem no campo de edição que será aberto, como no exemplo abaixo:

platform events email filled
A mensagem pode ser escrita em formato puro texto ou em HTML.

Ao clicar em SAVE, você voltará a visualizar o quadro de ações, e agora a ação E-mail conterá ícones para visualização de detalhes (icon more), edição (icon edit e remoção (icon delete). Ao clicar em icon more, você verá as informações configuradas:

platform events email more

Agora, você poderá configurar outra ação ou salvar o alerta, seguindo para a etapa REVIEW.

Slack

Quando esta ação é configurada, uma notificação é enviada para um canal do Slack sempre que o alerta for disparado.

actions slack

Primeiro, selecione o workspace do Slack que será utilizado. Se você não tiver incluído um workspace na tela Integrations, pode fazer isso clicando no botão + ADD WORKSPACE. Os passos são os mesmos (veja mais sobre isso aqui). Depois de escolhido o workspace, será aberto o campo Channel para a escolha do canal, como no exemplo abaixo:

platform events slack filled

Por padrão, só serão exibidos canais públicos, mas é também possível adicionar um canal privado. Leia sobre essa configuração aqui.

Só é possível escolher um canal por alerta.

Na seção ADD CUSTOM MESSAGE você pode inserir uma mensagem adicional personalizada a ser enviada com a notificação. Para isso, habilite o botão e inclua a mensagem no campo de edição que será aberto, como no exemplo da imagem acima.

A mensagem pode ser escrita em formato puro texto ou utilizando a formatação aceita pelo Slack. Leia mais sobre isso na documentação do Slack.

Ao clicar em SAVE, você voltará a visualizar o quadro de ações, e agora a ação Slack conterá ícones para visualização de detalhes (icon more), edição (icon edit e remoção (icon delete). Ao clicar em icon more, você verá as informações configuradas:

platform events slack more

Se desejar, pode enviar uma mensagem de teste para o canal configurado clicando em SEND TEST MESSAGE.

Agora, você poderá configurar outra ação ou salvar o alerta, seguindo para a etapa REVIEW.

Webhook

Quando você configura uma ação de Webhook, o Flexible Actions envia uma requisição HTTP POST para o endpoint que você determinar sempre que o alerta for disparado. Com isso, você consegue acionar uma API específica a partir do monitoramento do Flexible Actions. O payload dessa requisição incluirá os parâmetros monitorados do alerta e a mensagem adicional, caso você inclua uma.

actions webhook

Esses são os campos necessários para configurar um webhook:

  • ENDPOINT: inclua o endpoint no campo Url.

  • AUTHENTICATION: seção não obrigatória para estabelecer credenciais que o Flexible Actions deverá incluir na requisição. Cada credencial é composta por um client ID acompanhado ou não de um client secret e identificando onde elas serão trafegadas na requisição (em header ou query param). Todas as credenciais cadastradas estão listadas na tela Integrations e você pode selecionar uma credencial existente no campo Credential. Se você não tiver cadastrado a credencial que deseja usar na tela Integrations, pode fazer isso clicando no botão + NEW CREDENTIAL. Os passos são os mesmos (veja mais sobre isso aqui).

Na seção ADD CUSTOM MESSAGE você pode inserir uma mensagem adicional personalizada a ser incluída na requisição. Para isso, habilite o botão e inclua a mensagem no campo de edição que será aberto, como neste exemplo:

platform events webhook filled
A mensagem será incluída no payload da requisição, identificada por "customMessage".

Ao clicar em SAVE, você voltará a visualizar o quadro de ações, e agora a ação Webhook conterá ícones para visualização de detalhes (icon more), edição (icon edit e remoção (icon delete). Ao clicar em icon more, você verá as informações configuradas:

platform events webhook more

É possível visualizar o schema JSON e uma amostra de payload que será enviado clicando no botão {…​} VIEW SAMPLE.

Agora, você poderá configurar outra ação ou salvar o alerta, seguindo para a etapa REVIEW.

Review

A etapa REVIEW exibe os detalhes configurados do alerta recém-criado, como no exemplo abaixo:

platform events review

As ações cadastradas conterão o ícone icon more para mais informações. Além disso, para Slack, é possível enviar uma mensagem de teste clicando em SEND TEST MESSAGE; e para Webhook é possível visualizar o schema JSON e uma amostra de payload que será enviado clicando no botão {…​} VIEW SAMPLE.

Thanks for your feedback!
EDIT
How useful was this article to you?