O API Gateway oferece recursos de observabilidade, como logs de chamadas de API, monitoramento, alertas e Tracing Analysis, para ajudar você a monitorar o desempenho das APIs e manter a estabilidade do sistema.
Logs de chamadas de API
O API Gateway disponibiliza os seguintes tipos de logs de chamadas de API:
-
Gerencie logs de chamadas de API com o Simple Log Service.
A integração entre o API Gateway e o Simple Log Service permite consultas de log em tempo real, download de logs e análises estatísticas multidimensionais. Veja os detalhes:
Consulta de logs online: pesquise logs por palavra-chave com correspondência exata ou aproximada para solucionar problemas e realizar análises estatísticas.
Consulta detalhada de logs: filtre registros de chamadas detalhados por campos específicos.
Visualização de logs de chamadas: visualize os logs de chamadas de API.
-
Configure o registro de requisições e respostas HTTP
Registre as requisições HTTP recebidas pelo API Gateway e as respostas HTTP retornadas aos clientes.
NotaEste recurso está disponível apenas para instâncias dedicadas.
Para mais informações, consulte API call logs.
Monitoramento e alertas
O API Gateway oferece os seguintes recursos de monitoramento e alertas:
-
Visualize dados de monitoramento
Monitore os dados do API Gateway por região, grupo de APIs e API individual. Confira as opções:
Monitoramento por região.
Monitoramento de instâncias (apenas instâncias dedicadas).
Monitoramento de grupos de APIs.
Monitoramento de APIs.
-
Configure alertas para APIs.
Use o CloudMonitor para configurar alertas sobre APIs publicadas no API Gateway e acompanhar o status de execução das APIs em tempo real.
-
Configure uma regra de alerta para um pool de conexões de saída.
No Simple Log Service, especifique uma frequência de verificação e condições de acionamento para criar uma regra de alerta. Os alertas são disparados quando as condições definidas são atendidas.
Quando um pool de conexões atinge sua capacidade máxima, o API Gateway retorna o erro
Backend service connect failed 'Connection lease request time out'para requisições excedentes. Esse erro é registrado no campoerrorMessagedos logs; use-o para configurar uma regra de alerta. Para mais informações, consulte Alert configuration quick start.
Para mais informações, consulte Monitoring and alerting.
Configurar análise de rastreamento
Este recurso está disponível apenas para instâncias dedicadas.
Configure o Tracing Analysis no console do API Gateway para enviar logs à plataforma Alibaba Cloud Tracing Analysis. O Tracing Analysis fornece ferramentas como mapeamento de rastreamentos, estatísticas de requisições, topologia de rastreamentos e análise de dependências de aplicações para auxiliar no desenvolvimento e na solução de problemas. Veja o que esta seção aborda:
Como autorizar o Tracing Analysis.
Como configurar a análise de rastreamento no console do API Gateway.
Para mais informações, consulte Configure tracing analysis.