Exemplos de alertas

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

A Apigee permite criar alertas complexos com base em várias condições. As seções a seguir apresentam alguns exemplos de alertas:

Alerta de ausência de código de resposta 200 por 5 minutos

O próximo exemplo cria um alerta quando não há um código de resposta 200 (solicitação bem-sucedida) por 5 minutos.

Para criar o alerta:

  1. Abra o painel Criar política de alertas no Console do Google Cloud.

  2. Clique em Selecionar uma métrica.
  3. Desmarque o botão Ativo.

    Observação: se não houver dados de tráfego recentes da API na sua organização, a métrica na próxima etapa não será exibida, a menos que essa opção esteja desmarcada.

  4. Selecione uma métrica da seguinte forma:
    1. Copie e cole o seguinte no campo Selecionar uma métrica: 
      apigee.googleapis.com/proxy/response_count
    2. Selecione Proxy da Apigee.
    3. No painel aberto à direita, selecione Proxy.
    4. No próximo painel à direita, selecione Contagem de respostas do proxy da Apigee.
    5. Clique em Aplicar.
  5. Adicione um filtro para o código de resposta da seguinte maneira:
    1. Clique em Adicionar filtro.
    2. Clique no campo Filtro e selecione response_code no menu suspenso.
    3. No Comparador, selecione =.
    4. No campo Valor, digite 200.
    5. Clique em Aplicar.

Configurar o gatilho de alerta

Para configurar o evento que causa o gatilho de alerta, primeiro clique em Configurar gatilho no painel à esquerda. Depois, siga estas etapas:

  1. Em Tipo de condição, selecione Ausência de métrica.
  2. No campo Gatilho de alerta, selecione Qualquer série temporal viola.
  3. No campo Tempo de ausência da métrica, selecione 5 min.
  4. Se quiser, digite um nome para a condição no campo Nome da condição.

Com essas configurações, um alerta será acionado quando o proxy não receber um código de resposta 200 por cinco minutos.

Clique em Avançar para abrir o painel Configurar notificações e finalizar o alerta.

Configurar uma notificação para o alerta

No painel Configurar notificações e finalizar alerta, é possível configurar uma notificação que será enviada quando um alerta for acionado. Para fazer isso, siga estas etapas:

  1. Clique no campo Canais de notificação. Se você já tiver criado um canal para a notificação, como um endereço de e-mail ou número de SMS, selecione-o em Canais de notificação.

    Caso contrário, você precisará adicionar um canal selecionando Gerenciar canais de notificação. Isso abre o painel Canais de notificação, em que é possível adicionar um ou mais canais. Consulte Gerenciar canais de notificação para mais informações. Quando terminar, volte ao painel Configurar notificações e finalizar o alerta.

    Observação:pode ser necessário clicar no botão de atualização ao lado de Gerenciar canais de notificação para exibir um novo canal depois de criá-lo.

    Depois de selecionar um ou mais canais de notificação, clique em OK.

  2. No campo Documentação, é possível adicionar uma mensagem que será enviada com a notificação. Por exemplo, a mensagem pode descrever o motivo do alerta e conter links para a documentação que explica como responder a ele.
  3. Clique em Avançar para revisar os detalhes do alerta. Se estiver tudo certo, clique em Criar política para criar a política de alerta.

Alerta de pico de tráfego

As seções a seguir mostram como criar um alerta que é acionado quando o número de solicitações de API em um período de um minuto ultrapassa 3.600.

Para criar o alerta:

  1. Abra o painel Criar política de alertas no Console do Google Cloud.

  2. Clique em Selecionar uma métrica.
  3. Desmarque o botão Ativo.

    Observação: se não houver dados de tráfego recentes da API na sua organização, a métrica na próxima etapa não será exibida, a menos que essa opção esteja desmarcada.

  4. Selecione uma métrica da seguinte forma:
    1. Copie e cole o seguinte no campo Selecionar uma métrica: 
      apigee.googleapis.com/proxy/request_count
    2. Selecione Proxy da Apigee.
    3. No painel aberto à direita, selecione Proxy.
    4. No próximo painel à direita, selecione Contagem de solicitações de proxy da Apigee.
    5. Clique em Aplicar.
  5. No painel Transformar dados:
    • Em Em cada série temporal:
      • No campo Janela contínua, selecione 1 min.
      • Em Função de janela contínua, selecione taxa.
    • Em Entre séries temporais, em Agregação de série temporal, selecione soma.

Configurar o gatilho de alerta

Para configurar o evento que causa o gatilho de alerta, primeiro clique em Configurar gatilho no painel à esquerda. Depois, siga estas etapas:

  1. Em Tipo de condição, selecione Limite.
  2. No campo Gatilho de alerta, selecione Qualquer série temporal viola.
  3. No campo Posição do limite, selecione Acima do limite.
  4. No campo Valor do limite, insira 60.

O motivo de você definir Valor do limite como 60 (em vez de 3.600) é que as unidades do Valor do limite são por segundo. Portanto, se esse limite for mantido por um minuto, haverá pelo menos 3.600 solicitações nesse período.

Com essas configurações, um alerta será acionado quando o número total de solicitações em um período de um minuto ultrapassar 3.600.

Clique em Próxima para abrir o painel Configurar notificações e finalizar alerta e seguir as etapas em Configurar uma notificação para o alerta.

Alerta de latência

Os exemplos a seguir mostram como criar um alerta que é acionado quando 95% das latências médias nas respostas, em intervalos de 10 minutos, é maior que 600 ms.

Crie o alerta usando a Apigee ou a Apigee híbrida v1.12.

Para criar o alerta usando a Apigee, faça o seguinte:

  1. Abra o painel Criar política de alertas no Console do Google Cloud.

  2. Clique em Selecionar uma métrica.
  3. Desmarque o botão Ativo.

    Observação: se não houver dados de tráfego recentes da API na sua organização, a métrica na próxima etapa não será exibida, a menos que essa opção esteja desmarcada.

  4. Selecione uma métrica da seguinte forma:
    1. Copie e cole o seguinte no campo Selecionar uma métrica: 
      apigee.googleapis.com/proxy/latencies
    2. Selecione Proxy da Apigee.
    3. No painel aberto à direita, selecione Proxy.
    4. No próximo painel à direita, selecione Latências do proxy da Apigee.
    5. Clique em Aplicar.
  5. No painel Transformar dados, em Em cada série temporal:
    • No campo Janela contínua, selecione 10 min.
    • No campo Função de janela contínua, digite 95%.

Consulte Criar o gatilho de alerta para configurar o evento que aciona o alerta.

Crie o alerta usando a Apigee híbrida v1.10 ou v1.11.

Para criar o alerta usando a Apigee híbrida v1.10 ou v1.11:

  1. Abra o painel Criar política de alertas no Console do Google Cloud.

  2. Clique em Selecionar uma métrica.
  3. Desmarque o botão Ativo.

    Observação: se não houver dados de tráfego recentes da API na sua organização, a métrica na próxima etapa não será exibida, a menos que essa opção esteja desmarcada.

  4. Selecione uma métrica da seguinte forma:
    1. Copie e cole o seguinte no campo Selecionar uma métrica: 
      apigee.googleapis.com/proxyv2/latencies_percentile
    2. Selecione Proxy da Apigee (v2).
    3. No painel aberto à direita, selecione Proxyv2.
    4. No próximo painel à direita, selecione Porcentagem de latências de resposta do proxy da Apigee.
    5. Clique em Aplicar.

  5. Adicione um filtro da seguinte forma:

    1. Clique em Adicionar um filtro.
    2. Clique no campo Filtro e selecione porcentagem no menu suspenso.
    3. No Comparador, selecione =.
    4. No campo Valor, digite 95.
    5. Clique em Aplicar.
  6. No painel Transformar dados, em Em cada série temporal:
    • No campo Janela contínua, selecione 10 min.
    • No campo Função de janela contínua, insira média.

Consulte Criar o gatilho de alerta para configurar o evento que aciona o alerta.

Configurar o gatilho de alerta

Para configurar o evento que causa o gatilho de alerta, primeiro clique em Configurar gatilho no painel à esquerda. Depois, siga estas etapas:

  1. Em Tipo de condição, selecione Limite.
  2. No campo Gatilho de alerta, selecione Qualquer série temporal viola.
  3. No campo Posição do limite, selecione Acima do limite.
  4. No campo Valor do limite, insira 600.

Com essas configurações, um alerta será acionado quando 95% das latências estiver acima do limite de 600 ms.

Clique em Próxima para abrir o painel Configurar notificações e finalizar alerta e seguir as etapas em Configurar uma notificação para o alerta.

Quando você receber uma notificação e clicar no botão Ver na Apigee no e-mail de notificação, o painel "Investigar" exibirá um gráfico de latência com o limite, semelhante ao exemplo mostrado abaixo: Selecione uma métrica.