Runtime Alerts

O Runtime Alerts (alertas em tempo de execução) permite o monitoramento do comportamento das APIs.

É possível configurar disparo de alertas (envio de mensagem por e-mail, Slack, Microsoft Teams, Webhook e/ou WhatsApp) para a situação (evento) que você determinar.

Veja nos exemplos abaixo alguns dos benefícios da funcionalidade.

Exemplos de cenários

alvo

Agilidade na identificação de problemas:
Agora o time de SRE (Site Reliability Engineering) recebe mensagem por WhatsApp quando um problema ocorre e pode tomar as devidas ações prontamente. Configurei runtime alerts com base em retornos com status 500 e defini exatamente a mensagem a ser enviada para cada situação, apontando as possíveis soluções para agilizar a atuação. Além disso, requisições do tipo POST são enviadas para o sistema que cria relatórios para análises e planejamento gerenciais.

Apoio a decisões de negócios:
Minha estratégia de reconfiguração das atividades incluía um período de testes. Criei algumas APIs novas para observar sua aceitação no mercado. Configurei runtime alerts para monitorar a quantidade de chamadas que chegavam para essas APIs. Ao saber sobre a taxa de adesão de cada uma durante o período de testes, tive bases para definir o melhor caminho a seguir com meu projeto de expansão de vendas.

placa com várias direções

Nesses e outros cenários, os alertas funcionam com base em políticas de ação. Cada política define um cenário (evento) específico com as regras do disparo do alerta.

Configurando o Runtime Alerts

Configure políticas para monitorar o comportamento das APIs e receber alertas quando situações específicas ocorrerem.

Versões anteriores do Flexible Actions exigiam que fosse criado um alerta por API. Agora, com o conceito de políticas, o processo ficou muito mais simples: você cria uma política de Runtime alert e seleciona as APIs que quer associar à política.

Clique neste link para entender o funcionamento das políticas de monitoramento.

Clique nos links abaixo para ver:

Passo a passo

Descrição detalhada

Descrição detalhada

Listagem de políticas

exemplo de lista de políticas

A lista de políticas exibe informações e opções de ações a partir das seguintes colunas:

  • CLASS, com a classificação da política, indicando seu nível de criticidade:

    • ícone cinza com ponto de exclamação dentro de um círculo neutro,

    • ícone verde com ponto de exclamação dentro de um círculo sucesso,

    • ícone amarelo com ponto de exclamação dentro de um círculo atenção,

    • ícone vermelho com ponto de exclamação dentro de um círculo crítico.

  • NAME, com o nome dado à política.

    O nome da política é único.

  • TYPE, que informa a categoria de parâmetros a ser monitorada, podendo ser:

    • Total Calls (total de chamadas),

    • Availability (disponibilidade),

    • Latency (latência) e

    • HTTP Response Status (códigos de estado de respostas HTTP).

  • ACTIONS, exibindo os ícones que representam os canais de envio da notificação:

    • ícone com um envelope email,

    • logo do Slack Slack,

    • logo do Microsoft Teams Teams,

    • ícone de webhook webhook,

    • logo do Whatsapp Whatsapp.

  • LAST UPDATE, informando data e hora da última atualização da configuração.

  • ENABLED, que traz um botão para habilitar e desabilitar notificações para a política.

  • OPTIONS, oferendo opções de ação:

    • lupa em cima de uma papel: abre a página com mais detalhes da política:

      • Parâmetros do evento que dispara o alerta,

      • Itens monitorados (nome da API; quantidade de ambientes, recursos e operações; total de itens monitorados),

      • Canais de envio da notificação, incluindo destinatários, mensagem configurada e, dependendo do canal, botão para envio de mensagem de teste.

    • lápis: inicia passos para edição da política,

    • lixeira: deleta a política.

Busca

Encontre uma política utilizando a ferramenta de busca no topo da tela.

É possível filtrar as políticas pelos campos descritos abaixo. Para ver todos os campos, clique em botão com três linhas horizontais paralelas formando um triângulo com a ponta para baixo.

exemplo de lista de políticas
Você pediu e a gente implementou: agora é possível realizar buscas por nome da API e nome da política (nome do alerta).

  • API Name: comece a digitar o nome da API ou clique no campo para selecionar de uma lista.

  • Classification: clique e escolha um nível de criticidade (Neutral (neutro), Success (sucesso), Warning (atenção) ou Critical (crítico)).

  • Tags: comece a digitar ou selecione uma tag (etiqueta opcional adicionada às políticas durante sua criação ou edição para categorizá-las).

  • Status: selecione um estado ((Enabled) habilitado ou (Disabled) desabilitado).

  • Policy name: digite o nome da política.

  • Notification Type: selecione um tipo de notificação (Total Calls, Availability, Latency ou HTTP Response Status).

  • Action: selecione o canal de notificação (E-mail, Slack, Microsoft Teams, Webhook ou WhatsApp).

Detalhes da política

Clique em lupa em cima de uma papel na lista de políticas de Runtime alert para ver detalhes sobre a política, que são as informações cadastradas no processo de cadastro de uma nova política.

A tela exibe:

  • Nome da política,

  • Detalhes do evento monitorado (Monitored event details),

  • Itens monitorados (Monitored Items), com nome da API; quantidade de ambientes, recursos e operações; total de itens monitorados,

  • Canais de envio da notificação (Actions), incluindo destinatários, mensagem configurada e, dependendo do canal, botão para envio de mensagem de teste.

Editando políticas

Para editar as informações básicas de um alerta (isso é, as condições de monitoramento que farão disparar uma notificação), siga os passos abaixo.

  1. Na lista de políticas de Runtime alert, clique em ícone de edição na coluna OPTIONS da política que deseja editar.

  2. Faça as alterações desejadas.
    Os passos são os mesmos que os de criação de novas políticas.
    O tipo de notificação (Total Calls, Availability, Latency ou HTTP Response Status) não pode ser alterado.

    Se quiser alterar o tipo de notificação, você pode excluir a política e criar uma nova com o tipo desejado.

  3. No passo 4 REVIEW, confira as alterações e clique em SAVE para finalizar.

    É necessário clicar em SAVE para que as alterações sejam efetivadas.

  • As alterações só serão aplicadas a partir do próximo disparo do alerta.

  • Quando você edita as tags de um alerta, as novas tags podem ser imediatamente utilizadas para buscas na tela Runtime Alerts. No entanto, nas buscas da tela Triggered Alerts, as tags que estavam ativas quando o alerta foi disparado ainda serão consideradas. Por exemplo, se você acabou de incluir uma nova tag, ela só retornará resultados de busca em Triggered Alerts na próxima vez que o alerta editado for disparado.

Removendo políticas

Siga os passos abaixo para excluir um alerta:

  1. Na lista de políticas de Runtime alert, clique em ícone de lixeira na coluna OPTIONS da política que deseja excluir.

  2. Confirme a exclusão clicando em DELETE na janela de confirmação.

Se quiser apenas desabilitar as notificações de um alerta por tempo indeterminado, ao invés de remover a política, você pode usar os botões de habilitação/desabilitação na coluna ENABLED da página Runtime Alerts.
Thanks for your feedback!
EDIT
How useful was this article to you?