Documentação do Oracle Cloud Infrastructure

Como monitorar se um ponto final do Gateway de API está realmente acessível

Descubra como diagnosticar e solucionar problemas que monitoram a integridade e a acessibilidade dos gateways de API criados com o serviço API Gateway.

Use essa orientação quando precisar monitorar se um ponto final do Gateway de API está acessível. As métricas do API Gateway mostram padrões de tráfego, latência e resposta, mas não fornecem uma única métrica de status ativa do gateway integrada. Para vida útil do ponto final, use o Health Checks com um caminho de API implantado e use métricas do API Gateway para investigar o tráfego e as falhas.

Sintomas do Problema

Você pode ver um ou mais dos seguintes sintomas:

  • Nenhum sinal de acessibilidade direta está disponível para um ponto final do Gateway de API.

  • As métricas do serviço API Gateway não mostram uma métrica de status de integridade dedicada.

  • O volume de tráfego, a latência e as tendências de código de resposta não confirmam a vida útil do ponto final.

  • Nenhuma verificação de integridade nativa do OCI está configurada para o ponto final de implantação do Gateway de API.

Possíveis Causas

A acessibilidade do ponto final e as métricas de gateway medem diferentes partes do caminho da solicitação:

  • As Verificações de Integridade indicam se um caminho de API implantado pode ser acessado no local da sondagem de verificação de integridade.

  • As métricas do API Gateway indicam como o gateway se comporta após o tráfego atingir o gateway.

  • Um gateway acessível ainda pode retornar respostas 4xx ou 5xx crescentes.

  • Um gateway com pouco ou nenhum tráfego pode ter poucos pontos de dados de métricas recentes, o que torna as métricas por si só um sinal de vida fraco.

Configurar uma Verificação de Integridade para Liveness do Ponto Final

Use o Health Checks quando precisar de um sinal binário ou quase binário de que um ponto final implantado esteja acessível.

Selecione uma rota de API que atenda aos seguintes requisitos:

  • A rota retorna uma resposta de sucesso previsível, como 200 ou 204.

  • A rota não aciona redirecionamentos de acesso.

  • A rota não requer credenciais por usuário nem parâmetros de consulta de curta duração.

  • A rota não executa uma operação de gravação nem cria um efeito de negócios.

  • A rota representa o caminho do Gateway de API que você deseja monitorar.

Antes de criar a verificação de integridade, verifique a rota manualmente:

curl -i https://<gateway-hostname>/<deployment-path-prefix>/<api-route-path>

Crie uma Verificação de Integridade do OCI destinada ao ponto final implantado exato que você verificou. Use a verificação de integridade para as seguintes metas de monitoramento:

  • Acessibilidade do ponto final.

  • Verificações de disponibilidade externa.

  • Alerta quando o ponto final para de responder com o código de status esperado.

Revisar Métricas do Serviço API Gateway

Use as métricas do API Gateway para entender os padrões de tráfego e falha após o ponto final estar acessível. No Metrics Explorer, verifique as métricas públicas do Gateway de API no namespace oci_apigateway.

Comece com as seguintes métricas e dimensões:

  • HttpResponses, httpStatusCode e httpStatusCategory.

  • BackendHttpResponses, backendHttpStatusCode e backendHttpStatusCategory.

  • Latency, IntegrationLatency e InternalLatency.

  • resourceId, deploymentId e route.

Use HttpResponses para revisar os códigos de status retornados pelo Gateway de API. Use BackendHttpResponses para revisar os códigos de status retornados pelos serviços de back-end.

Interpretar resultados de monitoramento

Use o status de verificação de integridade e as métricas do API Gateway juntas para identificar onde o problema ocorre:

  • Se a verificação de integridade falhar, o ponto final poderá estar inacessível ou não íntegro no caminho de sondagem.

  • Se a verificação de integridade for bem-sucedida, mas as respostas 4xx ou 5xx aumentarem, o ponto final poderá ser acessado, mas as solicitações falharão.

  • Se o tráfego for baixo e as métricas não mostrarem dados recentes, os dados ausentes não provarão que o gateway está indisponível.

  • Se a acessibilidade for bem-sucedida, mas a latência aumentar, o gateway poderá ser acessado, mas o processamento de solicitações poderá ser degradado.

Corrigir Falhas de Monitoramento

Use o sinal de monitoramento que corresponde à pergunta que você precisa responder:

  • Para monitorar a vida útil do ponto final, configure o Health Checks para uma rota de API implantada.

  • Para investigar o comportamento da resposta, revise as métricas do Gateway de API.

  • Para monitorar a disponibilidade e o comportamento, combine Verificações de Integridade com métricas e alarmes do Gateway de API.

  • Para evitar conclusões falsas, não confie em uma métrica do Gateway de API como um indicador ativo de gateway direto.

Verificar Monitoramento de Ponto Final

Depois de configurar o monitoramento de ponto final, verifique a configuração:

  • Confirme se o caminho da API selecionado retorna o código de status esperado quando você o testa com curl.

  • Confirme se a Verificação de Integridade do OCI pode sondar o ponto final com sucesso.

  • Confirme se o Metrics Explorer mostra tendências de solicitação e resposta para o gateway.

  • Confirme se os alarmes distinguem os problemas de acessibilidade do ponto final dos problemas de código de resposta ou latência.

Para obter mais informações

Para obter mais informações, consulte: