Veja um exemplo de cenário

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

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

#	Step	Descrição
1	Monitorar o tráfego recente da API	Confira os dados recentes de monitoramento de API de todos os proxies e destinos de API que tiveram tráfego na última hora. Detalhe os proxies ou destinos de API com uma alta taxa de porcentagem de erro.
2	Identifique tendências nos dados de monitoramento da API	Acesse uma visualização do histórico dos seus dados de monitoramento de API dos últimos três meses para ter uma perspectiva mais ampla.
3	Investigar problemas 5xx	Consulte os códigos de falha com os maiores volumes relativos ao longo do tempo para investigar 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 receber notificações quando o número de códigos de status 5xx exceder um determinado limite.
5	Gerar um relatório personalizado com detalhes do cliente (opcional)	Como opção, 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 defina valores de limite de alerta adequados para todos os membros do grupo para diagnosticar problemas com mais rapidez.
7	Resolver os problemas do 5xx	Com base na sua investigação e no diagnóstico, tome as medidas apropriadas para resolver os problemas do 5xx.

Etapa 1: monitorar o tráfego recente da API

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

1. Selecione Analyze > API Monitoring > Recent na IU do Edge para acessar o painel Recente.

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

3. Clique no proxy ou no destino da API com uma alta taxa de porcentagem de erro para visualizar os detalhes no painel direito. Há uma alta porcentagem de erros 5xx nesse exemplo.

   

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

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

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

1. No painel à direita do painel "Recentes", selecione > Ver na linha do tempo para acessar o painel. Outra opção é clicar em Analyze > API Monitoring > Timeline na IU do Edge.
   
2. Confira a tendência do proxy ou destino da API ao longo do tempo. Observe que a tendência foi consistente nos últimos sete dias.

Para mais informações sobre essa 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, faça o seguinte:

1. No painel à direita do painel da linha do tempo, selecione > Visualizar em Investigar para acessar o painel "Investigar". Outra opção é clicar em Analyze > API Monitoring > Investigar na IU do Edge.
   
   No painel "Investigar", é possível comparar a atividade relacional entre métricas, como código de falha e tempo.

2. Confira a matriz de horário e o código de falha para conferir a atividade do código de falha na última hora. Observe os códigos de falha que apresentam os maiores volumes relativos com base no sombreamento de cores 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 seguinte matriz:

3. Clique no bloco mais escuro (primeiro bloco) da linha policies.ratelimit.SpikeArrestViolation para ver mais detalhes no painel direito.
   

4. 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 comum no tempo de execução para violações da política de detenção de pico.

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

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

Etapa 4: configurar um alerta 5xx

Configure um alerta com base no contexto selecionado no painel "Investigar detalhes" para receber uma notificação 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 pré-preenchidos com dados do contexto atual. Exemplo:

   

3. Clique em Salvar.

No futuro, quando a taxa de erro 5xx exceder 5% por um período de cinco minutos para o proxy de API perfBenchmark_invalid_v1, uma notificação será enviada ao e-mail especificado e um alerta visual será exibido na interface. 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)

Se quiser, 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 durante a configuração do alerta de uma das seguintes maneiras:

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

   • Clique na notificação que aparece 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 de desenvolvedor específico com uma alta taxa de erro, 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. Gere o relatório para ver detalhes sobre o app do desenvolvedor e os clientes que estão acionando o código de status 5xx.

Para mais informações sobre essa 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 defina valores de limite de alerta adequados para todos os membros do grupo para diagnosticar problemas com mais rapidez.

1. Selecione Analisar > Monitoramento de API > Coleções na IU do Edge para exibir o painel Coleções.
2. Clique em + Coleção.
3. Selecione Proxy.
4. Selecione prod na lista suspensa 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, configure um alerta, semelhante à etapa 4, e defina a dimensão como o conjunto definido acima.

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

Etapa 7: resolver os problemas 5xx

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

• Use o Apigee Sense para determinar se o pico de solicitações é suspeito e decida que quer 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 de desenvolvedores podem fazer com o proxy de API durante um período específico.
• Gere receita com sua API para cobrar dos desenvolvedores pelo uso acima de um determinado número de chamadas.