Runtime Alerts com o novo conceito "Policy"

O que muda

Antes

Agora

Criação de alerta
(cadastro de monitoramento e notificação)

Baseada em API

Baseada em política

Inclusão de apenas uma operação da API (Operation) por cadastro

Inclusão de diversas APIs (Monitored Items) por cadastro

Muitas APIs = muitos cadastros

Muitas APIs (com mesma política) = 1 cadastro

Passos

Event > Schedule > Actions > Review

Policy > Monitored itens > Actions > Review

O cadastro de monitoramento e notificação era baseado em recurso único da API (Operation). Com esse formato, APIs com diversas operações e necessidade de monitoramento completa demandavam o cadastro de vários monitoramentos e notificações, um a um.

Com o novo conceito de política, um mesmo modelo de monitoramento e notificação pode ser aplicado de uma única vez para diversas APIs e, caso necessário, para todo o conjunto de operações que possua. Essa melhoria tornará o cadastro de alertas mais rápido e simplificará o gerenciamento de monitoramentos quando as APIs monitoradas pelo Flexible Actions forem atualizadas com novas operações.

Leia mais sobre as opções de atualização dinâmica ou fixa.

Passos

Os passos "Event" e "Schedule", da versão anterior, foram condensados no step "Policy".
Em "Monitored items", você seleciona as APIs e operações que serão monitoradas pela política.

Antes: Event > Schedule > Actions > Review
Agora: Policy > Monitored items > Actions > Review

Tela Inicial Runtime Alerts

Na tela inicial do Runtime Alerts, tínhamos o botão New Definition para criar novo monitoramento. Ao clicar nele, iniciava-se o processo de criação de novo monitoramento Runtime Alerts. Após a criação do monitoramento, ele era listado na tela inicial:

tela inicial do runtime alerts antiga com exemplos de lista de alertas

Com a melhoria, a criação de monitoramento agora começa pelo botão New Policy. Ao clicar em New Policy, dá-se início à nova jornada de criação de monitoramento, com o conceito de "policy" (política).

Após sua criação, a política é listada na tela inicial, que mostra um resumo com informações básicas das políticas, como nome, tipo de monitoramento, qual ação (notificação) será disparada e se estão ativas ou não.

tela inicial do runtime alerts nova com destaque para o botão new policy

Novo processo de criação de alertas

Na versão anterior, o evento de monitoramento era cadastrado na primeira etapa do processo e permitia a inclusão de apenas uma operação da API.

Na nova versão de Runtime Alerts, você poderá incluir diversas APIs (Monitored Items) em apenas um evento de monitoramento.

No vídeo você pode ver rapidamente como será feito o registro das informações básicas do monitoramento de Runtime Alerts como nome da política, qual o evento de monitoramento (Total de Chamadas, Latência etc.) e os parâmetros desse monitoramento. Veja também o vídeo com mais detalhes.

No segundo passo (Monitored Items - imagem abaixo) incluiremos as APIs/Operations que serão monitoradas pelo evento definido no primeiro passo. Você pode definir várias APIs em cada política, mas para facilitar o seu gerenciamento, recomendamos que divida em mais políticas se precisar monitorar mais de 50 itens.

Ainda no segundo passo, você define se quer que as atualizações na API (inclusões de novas operações) entrem automaticamente no monitoramento ou não. Veja a diferença entre as opções "all" e "any".

segundo passo do cadastro de politica

Os demais passos, Actions e Review, são similares aos da versão anterior do Flexible Actions.

Exemplo

Após uma política ter sido criada, o evento de monitoramento será executado conforme os parâmetros indicados para todos os itens (APIs/Operations) selecionados e, caso seja detectado que determinada API/operation se enquadra nesse evento, a notificação escolhida na política será acionada individualmente para cada API/operation.

Acompanhe um exemplo (por vídeo ou texto).

Criei uma política para ser executada a cada 5 minutos para as seguintes APIs/Operations (Monitored Items):

1. API Pedidos 1.0, Environment Production, Resource Pedidos, Operation GET /list e GET /item
2. API Delivery 1.0, Environment Any, Resource Any, Operation Any
3. API Tokens 1.0, Environment All, Resource Tokens, Operation All

Essa política vai monitorar se a quantidade de chamadas ultrapassa 10 chamadas com status code 200 nos últimos 5 minutos.

Imagine os seguintes cenários:

1. API Pedidos 1.0, Environment Production, Resource Pedidos, Operation GET /list e GET /item

Suponha que:

para a Operation GET /list, a condição seja verdadeira, ou seja, ela teve mais que 10 chamadas com status code 200 nos últimos 5 minutos no momento da verificação e
para a Operation GET /item, a condição seja falsa.

→ Então a notificação será enviada apenas para a operation GET /list. Note que apenas o deployment da API no Environment Production será monitorado.

2. API Delivery 1.0, Environment Any, Resource Any, Operation Any

Suponha que:

para Operation (Any), alguma operação ultrapassou 10 chamadas com status code 200 nos últimos 5 minutos no momento da verificação

→ Então será disparada notificação para cada operation individualmente. Note que, como a verificação é realizada em qualquer (Any) Environment, as notificações serão enviadas individualmente também para cada Environment e Operation.

3. API Tokens 1.0, Environment All, Resource Tokens, Operation All

Suponha que:

houve alguma operação do Resource Tokens que ultrapassou 10 chamadas com status code 200 nos últimos 5 minutos no momento da verificação.

→ Então será disparada notificação para cada uma dessas operações que tiveram a condição verdadeira da política.

→ As operações desse recurso que não ultrapassaram 10 chamadas com status code 200 não serão incluídas nas notificações.

→ Com a seleção de "All" para ambientes e operações, serão considerados somente os ambientes e operações existentes no momento da criação ou edição da política. Se novos ambientes ou operações forem criados depois disso, eles não serão incluídos no monitoramento.

Por outro lado, ao escolher "Any" em algum critério da API (Environments, Resources, Operations), todas as opções dessa API serão consideradas no monitoramento, inclusive aquelas criadas após a criação ou edição da política. Veja mais detalhes em Configurações fixas ou dinâmicas.

A tabela abaixo resume o exemplo:

Situações de exemplo

Condição: quantidade de chamadas ultrapassa 10 E status code 200 E últimos 5 minutos
Itens monitorados	Condição verdadeira?	Quantidade de notificações
1. API Pedidos 1.0, Environment Production, Resource Pedidos, Operation GET /list e GET /item	GET /list: Sim GET /item: Não	Apenas 1 para GET /list que está no ambiente de produção. Mesmo que esta operação exista em outro ambiente, ela não será monitorada.
2. API Delivery 1.0, Environment Any, Resource Any, Operation Any	Sim para qualquer operação	Uma notificação por operação e por ambiente. Ex.: a cada 5 minutos, se 4 ambientes com 5 operações em cada atenderem à condição, serão enviadas 20 notificações ao todo.
3. API Tokens 1.0, Environment All, Resource Tokens, Operation All	Sim para todas as operações do Resource Token em todos os ambientes existentes no momento da criação da política	Uma notificação por operação e por ambiente, para itens existentes no momento da criação da política. Ex.: a cada 5 minutos, se 4 ambientes com 5 operações em cada (que já existiam no momento da criação da política) atenderem à condição, serão enviadas 20 notificações ao todo.

Condição: quantidade de chamadas ultrapassa 10 E status code 200 E últimos 5 minutos

Itens monitorados

Condição verdadeira?

Quantidade de notificações

1. API Pedidos 1.0, Environment Production, Resource Pedidos, Operation GET /list e GET /item

GET /list: Sim
GET /item: Não

Apenas 1 para GET /list que está no ambiente de produção. Mesmo que esta operação exista em outro ambiente, ela não será monitorada.

2. API Delivery 1.0, Environment Any, Resource Any, Operation Any

Sim para qualquer operação

Uma notificação por operação e por ambiente.
Ex.: a cada 5 minutos, se 4 ambientes com 5 operações em cada atenderem à condição, serão enviadas 20 notificações ao todo.

3. API Tokens 1.0, Environment All, Resource Tokens, Operation All

Sim para todas as operações do Resource Token em todos os ambientes existentes no momento da criação da política

Uma notificação por operação e por ambiente, para itens existentes no momento da criação da política.
Ex.: a cada 5 minutos, se 4 ambientes com 5 operações em cada (que já existiam no momento da criação da política) atenderem à condição, serão enviadas 20 notificações ao todo.

Configurações fixas ou dinâmicas (all ou any)

As opções All e Any definem se a política é fixa (os parâmetros que disparam o alerta são sempre os mesmos que você configurou/editou) ou dinâmica (os parâmetros são atualizados automaticamente com a API).

Leia sobre elas no texto abaixo ou veja o vídeo (aos 03:00)

All: ao selecionar todos (all) os itens (em Environment, Resource e Operation) para serem monitorados por uma política, todos os itens da API selecionados no momento da criação ou edição da política serão considerados para o disparo do alerta. Itens criados depois dessa definição, não entrarão no monitoramento.
Any: selecionando qualquer (any) item (em Environment, Resource e Operation) para ser monitorado por uma política, todo e qualquer item da API será considerado para monitoramento, incluindo adições à API que ocorram após a definição da política.

Usar a opção Any concede maior dinamicidade ao monitoramento, pois será atualizado automaticamente quando novas operações forem adicionadas à API.

Já a opção All permite que você mantenha fixos os parâmetros do monitoramento tal como foi configurado inicialmente. Novas adições às APIs deverão ser configuradas manualmente para que sejam incluídas nos disparos de alertas.

Ficam temporariamente indisponíveis com esta atualização:

indicação que avisa quando uma operação da API não está implantada (deployed) no ambiente selecionado para monitoramento.
opção de clonar uma política.

Esses recursos retornarão em lançamentos futuros.

Thanks for your feedback!

EDIT

How useful was this article to you?