Veja um exemplo de cenário

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Siga um cenário de exemplo que demonstra como solucionar problemas 5xx com suas APIs.

#	Etapa	Descrição
1	Monitorar o tráfego recente da API	Confira os dados recentes de monitoramento da API para todos os proxies e destinos de API que tiveram tráfego na última hora. Analise os proxies ou destinos de API com uma alta taxa de erros.
2	Identificar tendências nos dados de monitoramento da API	Acesse uma visualização histórica dos dados de monitoramento da API dos últimos três meses para ter uma perspectiva mais ampla.
3	Investigar problemas 5xx	Confira os códigos de falha que estão apresentando os maiores volumes relativos ao longo do tempo para investigar ainda mais a origem dos problemas 5xx. Normalmente, os códigos de status 5xx podem ser classificados usando um ou mais códigos de falha.
4	Configurar um alerta 5xx	Configure um alerta para ser notificado quando o número de códigos de status 5xx exceder um limite específico.
5	Gerar um relatório personalizado com detalhes do cliente (opcional)	Opcionalmente, gere um relatório personalizado para identificar detalhes sobre o cliente que está acionando os erros 5xx. Observação: você precisa ser um administrador da organização para gerar um relatório personalizado.
6	Agrupar proxies de API em uma coleção	Crie uma coleção para agrupar proxies de API e configurar valores de limite de alerta adequados para todos os membros do grupo para diagnosticar problemas mais rapidamente.
7	Resolver os problemas 5xx	Com base na sua investigação e diagnóstico, tome as medidas adequadas para resolver os problemas 5xx.

Etapa 1: monitorar o tráfego recente da API

Para conferir os dados de monitoramento da API dos proxies e destinos de API que tiveram tráfego na última hora:

1. Selecione Análise > Monitoramento da API > Recente na IU do Edge para acessar o painel "Recente".

2. Observe os proxies e destinos de API que tiveram uma alta taxa de erros na última hora.
   

3. Clique no proxy de API ou destino com uma alta taxa de erros para conferir os detalhes no painel à direita. Observe a alta porcentagem de erros 5xx neste exemplo.

   

Para mais informações sobre esta etapa, consulte Monitorar o tráfego recente da API.

Etapa 2: identificar tendências nos dados de monitoramento da API

Para acessar uma visualização histórica dos dados de monitoramento da API dos proxies e destinos de API que tiveram tráfego nos últimos três meses:

1. No painel direito do painel "Recente", selecione > Visualizar na linha do tempo para acessar o painel "Linha do tempo". Como alternativa, clique em Análise > Monitoramento da API > Linha do tempo na IU do Edge.
   
2. Confira a tendência do proxy de API ou destino ao longo do tempo. Observe que a tendência tem sido consistente nos últimos sete dias.

Para mais informações sobre esta etapa, consulte Identificar tendências nos dados de monitoramento da API.

Etapa 3: investigar problemas 5xx

A Apigee fornece um conjunto de códigos de falha que ajudam você a diagnosticar problemas. Normalmente, os códigos de status 5xx podem ser classificados usando um ou mais códigos de falha.

Para investigar problemas 5xx:

1. No painel direito do painel "Linha do tempo", selecione > Visualizar em "Investigar" para acessar o painel "Investigar". Como alternativa, clique em Análise > Monitoramento da API > Investigar na IU do Edge.
   
   O painel "Investigar" permite comparar a atividade relacional entre métricas, como código de falha versus tempo.

2. Confira a matriz de código de falha em relação ao tempo para verificar a atividade do código de falha na última hora. Observe os códigos de falha que estão apresentando os maiores volumes relativos com base no sombreamento de cor de um bloco. Quanto mais escuro o bloco, maior o volume relativo.

   Por exemplo, os códigos de falha policies.ratelimit.SpikeArrestViolation e policies.ratelimit.QuotaViolation estão mostrando um volume relativo maior na matriz a seguir:

3. Clique no bloco mais escuro (primeiro bloco) na linha policies.ratelimit.SpikeArrestViolation para conferir mais detalhes no painel à direita.
   

4. Observe que a origem da falha é o proxy de API perfBenchmark_invalid_v1 e o código de status HTTP é 500. Um código de status 500 é um código de erro de ambiente de execução comum para violações da política Spike Arrest.

5. Confira a distribuição por app do desenvolvedor, logo abaixo do painel "Causa suspeita", para identificar os apps do desenvolvedor com as maiores taxas de erro.
   

Para mais informações sobre esta etapa, consulte Identificar problemas.

Etapa 4: configurar um alerta 5xx

Configure um alerta com base no contexto selecionado no painel de detalhes "Investigar" para ser notificado quando o número de códigos de status 5xx exceder um limite específico.

1. No painel direito do painel "Investigar", selecione > Criar alerta.

2. Preencha os campos na caixa de diálogo de alerta. Os campos de condição são preenchidos automaticamente com dados do contexto atual. Exemplo:

   

3. Clique em Salvar.

No futuro, quando a taxa de erros 5xx exceder 5% por um período de cinco minutos para o proxy de API perfBenchmark_invalid_v1, uma notificação será enviada para o e-mail especificado e um alerta visual será mostrado na IU. Exemplo:

Para mais informações sobre esta etapa, consulte Configurar alertas e notificações.

Etapa 5: gerar um relatório personalizado com detalhes do cliente (opcional)

Opcionalmente, gere um relatório personalizado para identificar mais detalhes sobre o cliente que está acionando os erros 5xx.

Na página Relatórios, os relatórios personalizados criados com base em um alerta são nomeados usando o seguinte formato: API Monitoring Generated: alert-name.

1. Acesse o relatório personalizado criado ao configurar o alerta de uma das seguintes maneiras:

   • Selecione Análise > Relatórios personalizados > Relatórios na barra de navegação à esquerda para mostrar a página "Relatórios". Clique no nome do relatório na lista: API Monitoring Generated: 5xx Alert

   • Clique na notificação mostrada quando o alerta é criado. Exemplo:

   

2. Adicione as seguintes dimensões:

   • Aplicativo do desenvolvedor
   • ID do cliente
   • Endereço IP do cliente.

   

3. Para conferir um relatório com base em um app do desenvolvedor específico com uma alta taxa de erros, adicione um filtro semelhante ao seguinte:

   and (developer_app eq 'perfBenchmarkApp0')

   Observação: nesse caso, remova o app do desenvolvedor da lista de dimensões.

4. Clique em Salvar.

5. Execute o relatório para conferir detalhes sobre o app do desenvolvedor e os clientes que estão acionando o código de status 5xx.

Para mais informações sobre esta etapa, consulte Criar relatórios personalizados.

Etapa 6: agrupar proxies de API em uma coleção

Crie uma coleção para agrupar proxies de API e configurar valores de limite de alerta adequados para todos os membros do grupo para diagnosticar problemas mais rapidamente.

1. Selecione Análise > Monitoramento da API > Coleções na IU do Edge para mostrar o painel "Coleções".
2. Clique em + Coleção.
3. Selecione Proxy.
4. Selecione prod no menu suspenso do ambiente.
5. Clique em Próxima.
6. Preencha os campos na caixa de diálogo da coleção.
   
7. Clique em Salvar.

Em seguida, você pode configurar um alerta, semelhante à etapa 4, e definir a dimensão para a coleção definida acima.

Para mais informações sobre esta etapa, consulte Gerenciar coleções.

Etapa 7: resolver os problemas 5xx

Tome as medidas adequadas para resolver os problemas 5xx. Por exemplo, com base no seu diagnóstico, você pode realizar uma das seguintes tarefas:

• Use o Apigee Sense para determinar se o pico de solicitações é suspeito e decida bloquear o endereço IP do cliente identificado no relatório personalizado.
• Adicione uma política de cota para limitar o número de conexões que os apps do desenvolvedor podem fazer ao proxy de API durante um período específico.
• Monetize sua API para cobrar dos desenvolvedores o uso de um determinado número de chamadas.