Esta página foi traduzida pela API Cloud Translation.

Configurar alertas e notificações

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Um dos principais objetivos da monitorização de APIs é manter-se informado sobre eventos ou padrões invulgares, como picos no tráfego ou latências. Para acompanhar eventos como estes, pode configurar alertas, que são acionados quando ocorre um evento especificado. Um evento real que aciona um alerta é denominado incidente.

Pode definir regras específicas para um alerta. Por exemplo, o alerta pode ser acionado por um código de resposta 500 (erro interno do serviço) num proxy. Quando ocorre um incidente para o alerta, pode ver os respetivos detalhes no painel Incidentes da Google Cloud console página Alertas.

Se quiser receber uma notificação quando um alerta específico for acionado, pode configurar uma notificação para o alerta. Quando ocorre um incidente, o Apigee envia-lhe uma notificação com um resumo do evento, incluindo links para o Google Cloud console e a IU do Apigee, para uma investigação mais detalhada.

Existem dois tipos de alertas na monitorização de APIs:

Alertas baseados em métricas, que são acionados por alterações nas métricas da API.
Alertas baseados em registos, que se baseiam em dados da API armazenados pelo Cloud Logging.

Alertas baseados em métricas

Os alertas baseados em métricas são acionados quando uma métrica de dados da API atinge um nível especificado ou começa a mudar rapidamente. Define uma regra de alerta através de duas propriedades principais:

A métrica: a quantidade que aciona o alerta, por exemplo, o número de pedidos.
O limite: o nível que a métrica tem de atingir para acionar o alerta.

As secções seguintes fornecem exemplos de alertas baseados em métricas.

Alerta para o código de resposta 500 num proxy

O exemplo seguinte cria um alerta quando é devolvido um código de resposta 500 (erro interno do servidor). Pode criar um alerta semelhante para qualquer código de resposta.

Para criar o alerta, comece por seguir estes passos:

Na Google Cloud consola, aceda à página Monitorização > Alertas > Políticas.

Aceder a Criar política de alertas
Clique em Selecionar uma métrica.
Desmarque o botão Ativo.
Nota: se não existirem dados de tráfego da API recentes na sua organização, a métrica no passo seguinte não é apresentada, a menos que esta opção seja desmarcada.
Selecione uma métrica da seguinte forma:
1. Se estiver a usar o Apigee hybrid v1.12, copie e cole o seguinte no campo Selecionar uma métrica:
```
apigee.googleapis.com/proxy/response_count
```
  Nota: se estiver a usar o Apigee hybrid v1.10 ou v1.11, use a seguinte métrica em alternativa:
```
apigee.googleapis.com/proxyv2/response_count
```
2. Selecione Apigee Proxy.
3. No painel apresentado à direita, selecione Proxy.
4. No painel seguinte à direita, selecione Apigee proxy response count.
5. Clique em Aplicar.
Adicione um filtro para o código de resposta da seguinte forma:
1. Clique em Adicionar filtro.
2. Clique no campo Filtro e selecione response_code no menu pendente.
3. No Comparador, selecione =.
4. No campo Valor, escreva 500.
5. Clique em Concluído.

Configure o acionador do alerta

Para configurar o evento que aciona o alerta, clique primeiro em Configurar acionador no painel do lado esquerdo. Depois, siga estes passos:

Em Tipo de condição, selecione Limite.
No campo Acionador de alerta, selecione Qualquer série cronológica viola.
No campo Posição do limite, selecione Acima do limite.
No campo Valor do limite, introduza 1.

Com estas definições, é acionado um alerta sempre que é devolvida uma resposta com o código 500.

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

Configure uma notificação para o alerta

No painel Configurar notificações e finalizar alerta, pode configurar uma notificação que é enviada quando um alerta é acionado. Para isso:

Clique no campo Canais de notificação. Se já tiver criado um canal para a notificação, como um endereço de email ou um número de SMS, pode selecioná-lo em Canais de notificação.

Caso contrário, tem de adicionar um canal selecionando Gerir canais de notificação. É aberto o painel Canais de notificação, onde pode adicionar um ou mais canais. Consulte o artigo Faça a gestão dos canais de notificações para mais informações. Quando terminar, regresse ao painel Configure as notificações e finalize o alerta.
Nota: pode ter de clicar no botão de atualização junto a Gerir canais de notificação para apresentar um novo canal depois de o criar.
Depois de selecionar um ou mais canais de notificação, clique em OK.
No campo Documentação, pode adicionar uma mensagem que vai ser enviada com a notificação. Por exemplo, a mensagem pode descrever o motivo do alerta e conter links para documentação que explica como responder ao mesmo.
Clique em Seguinte para rever os detalhes do alerta. Se estiver satisfeito com as mesmas, clique em Criar política para criar a política de alerta.

Adicionar uma condição: alerta para o código de resposta 500 para pedidos HTTP POST num proxy

Pode criar várias condições para um alerta. Por exemplo, no alerta para o código de resposta 500 num proxy descrito na secção anterior, pode querer adicionar a condição de que o alerta só é acionado para pedidos HTTP POST. Para tal, basta seguir os mesmos passos que no exemplo anterior, mas, após o passo 8, adicione outro filtro da seguinte forma:

Clique em Adicionar filtro.
Clique no campo Filtro e selecione método HTTP na lista pendente.
No campo Comparador, selecione =.
No campo Value, introduza POST.
Clique em Concluído.

Em seguida, continue com os passos em Configure o acionador de alerta. Depois de terminar, o alerta é acionado quando o proxy recebe um código de resposta 500 de um pedido HTTP POST.

Consulte o artigo Alerta para combinações de códigos de resposta e métodos HTTP para ver um exemplo relacionado.

Ver detalhes do incidente

Um evento de API que aciona um alerta é denominado incidente. Pode ver os detalhes dos incidentes recentes na Google Cloud console página Alertas.

Métricas e filtros

Uma métrica é a quantidade que aciona um alerta, por exemplo, o número de pedidos. Esta secção descreve as métricas e os filtros que pode usar para criar alertas baseados em métricas. Existem dois tipos de métricas:

Novas métricas: novas versões das métricas do Apigee com melhorias no desempenho e na fiabilidade. Atualmente, estas métricas estão disponíveis para o Apigee e o Apigee hybrid v1.12 e superior. Recomendamos que use as novas métricas sempre que possível.
Métricas originais: as métricas originais continuam a ser suportadas para utilização com o Apigee Hybrid v1.10 e v1.11.

Novas métricas

A tabela abaixo lista as novas métricas.

Métrica	Descrição
`apigee.googleapis.com/proxy/details`	Detalhes relevantes para o proxy implementado num ambiente do Apigee.
`apigee.googleapis.com/proxy/request_count`	Número de pedidos ao proxy do Apigee desde que a última amostra foi registada.
`apigee.googleapis.com/proxy/response_count`	O número de respostas enviadas pelo proxy da API Apigee.
`apigee.googleapis.com/proxy/latencies`	Distribuição das latências, que são calculadas a partir do momento em que o pedido foi recebido pelo proxy do Apigee até ao momento em que a resposta foi enviada do proxy do Apigee para o cliente.
`apigee.googleapis.com/target/request_count`	O número de pedidos enviados para o destino do Apigee desde que a última amostra foi registada.
`apigee.googleapis.com/target/response_count`	O número de respostas recebidas do destino do Apigee desde que a última amostra foi registada.
`apigee.googleapis.com/target/latencies`	Distribuição das latências, que são calculadas a partir do momento em que o pedido foi enviado para o destino do Apigee até ao momento em que a resposta foi recebida pelo proxy do Apigee. O tempo não inclui a sobrecarga do proxy de API do Apigee.

Métricas originais

Segue-se uma lista das versões originais das métricas apresentadas na tabela acima, que ainda são suportadas para utilização apenas com o Apigee hybrid v1.10 e v1.11.

Métrica	Descrição
`apigee.googleapis.com/proxyv2/details`	Detalhes relevantes para o proxy implementado num ambiente do Apigee.
`apigee.googleapis.com/proxyv2/request_count`	O número total de pedidos recebidos pelo proxy de API do Apigee.
`apigee.googleapis.com/proxyv2/response_count`	O número total de respostas devolvidas pelo proxy da API Apigee.
`apigee.googleapis.com/proxyv2/latencies_percentile`	Percentil de todas as respostas do proxy da API a um pedido.
`apigee.googleapis.com/targetv2/request_count`	O número total de pedidos recebidos pelo destino da API Apigee.
`apigee.googleapis.com/targetv2/response_count`	O número total de respostas devolvidas pelo destino da API Apigee.
`apigee.googleapis.com/targetv2/latencies_percentile`	Percentil de todas as respostas de destino da API a um pedido.

Filtros

Os filtros permitem-lhe criar alertas para subconjuntos de dados da API. Um filtro especifica uma condição que define o subconjunto. Por exemplo, pode criar um alerta com base nos dados de um único proxy.

Pode escolher entre os seguintes filtros:

Filtro	Descrição	Métricas às quais o filtro pode ser aplicado
`env`	Ambiente para os dados.	Tudo
`location`	Localização dos dados.	Tudo
`proxy_name`	Proxy para os dados.	Tudo
`proxy_deployment_type`	Tipo de implementação do proxy do Apigee	`apigee.googleapis.com/proxy/details` `apigee.googleapis.com/proxyv2/details`
`runtime_version`	Versão de tempo de execução dos dados.	Métricas originais
`instance_id`	ID da instância dos dados.	Métricas originais
`method`	Método HTTP para os dados.	Tudo
`response_code`	Código de resposta HTTP para os dados.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`fault_code`	Código de falha para os dados.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`fault_source`	Origem da falha dos dados. Se quiser detetar erros gerais que podem ocorrer em qualquer lugar numa rede de APIs, defina `fault_source` como `proxy`.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`percentile`	Percentil de latências de respostas do proxy do Apigee.	`apigee.googleapis.com/proxyv2/latencies_percentile`

Alertas baseados em registos

Além dos alertas baseados em métricas descritos na secção anterior, também pode criar alertas baseados em registos, que monitorizam os dados da API armazenados pelo Cloud Logging.

Configurar um alerta baseado em registos

O exemplo seguinte mostra como configurar um alerta baseado em registos. Consulte o artigo Crie consultas no Explorador de registos para mais informações.

Abra o Explorador de registos no Google Cloud console.
Selecione Mostrar consulta no lado direito do Explorador de registos.
No painel Consulta, introduza uma consulta como no exemplo apresentado abaixo.
```
resource.type="apigee.googleapis.com/Environment"
logName="projects/<project_id>/logs/apigee.googleapis.com%2Fanomaly_event"
```
Nota: o / antes de anomaly_event (o [LOG_ID]) tem de ser codificado por URL como %2F. Consulte a página de referência LogEntry.
Clique em Executar consulta. Os resultados são apresentados no Verifique se a consulta devolve as entradas de registo sobre as quais quer receber alertas.
Clique em Criar alerta abaixo do painel Consulta.
Siga o procedimento na caixa de diálogo Criar política de alertas baseada em registos para criar o alerta. Consulte o artigo Configure alertas baseados em registos para ver detalhes.