Este tópico descreve como configurar o Tracing Analysis no console do API Gateway para enviar logs à plataforma Alibaba Cloud Tracing Analysis. O Tracing Analysis oferece ferramentas como reconstrução de chamadas, estatísticas de volume de requisições, mapas de topologia e análise de dependências de aplicações para aumentar a eficiência no desenvolvimento e na diagnose de problemas. Esse recurso está disponível apenas para instâncias dedicadas.
Pré-requisitos
Utilize uma instância dedicada do API Gateway.
Ative o Tracing Analysis.
Ative o Simple Log Service.
Conceder permissões ao Tracing Analysis
Faça login no Tracing Analysis console.
Na página Overview, clique em Authorize Now para conceder ao Tracing Analysis permissão de leitura e escrita nos dados do Simple Log Service.
Na página Cloud Resource Access Authorization, selecione as permissões necessárias e clique em Confirm Authorization Policy.
Após a autorização, acesse a página Overview no painel de navegação à esquerda. Na seção Access Process, clique em View Access Point Information. Na página Access Point Information, ative Show Token e escolha Jaeger como Client-side Collection Tool. Localize e salve o endereço do endpoint na seção Report Data over HTTP.
Configurar análise de rastreamento no API Gateway
Faça login no API Gateway console.
-
No painel de navegação à esquerda, escolha API Management > API Groups. Na lista API Groups, clique em um grupo de APIs para abrir a página Group Details. Na página Group Details, configure os seguintes parâmetros:
Trace Field Position: especifique a localização do campo de rastreamento. Valores válidos: Header e Query.
-
Tracing Field Name: defina o nome do campo rastreado.
O cliente gera o campo rastreado. O API Gateway encaminha esse campo ao service de backend e o registra no campo CustomTraceId. O valor desse campo serve como ID de rastreamento para envio de logs ao Tracing Analysis e deve seguir o formato padrão TraceId (número hexadecimal de 16 ou 32 bits).
Se o cliente não gerar o campo rastreado ou se o valor estiver em formato inválido, o API Gateway criará automaticamente um ID de rastreamento aleatório para reportar os logs ao Tracing Analysis.
Pass through or generate EagleEye-related headers (Eagleeye-Rpcid, Eagleeye-Traceid, Eagleeye-Sampled): ao marcar esta opção, o API Gateway repassa os cabeçalhos relacionados ao EagleEye do cliente para o service de backend. Se o cliente não enviar esses cabeçalhos, o API Gateway os gerará e os encaminhará ao backend. (Recurso disponível para instâncias Serverless e dedicadas).
Pass through or generate B3-related headers (X-B3-traceid, X-B3-Parentspanid, X-B3-Spanid, X-B3-Sampled): com esta opção selecionada, o API Gateway transmite os cabeçalhos B3 do cliente ao service de backend. Na ausência desses cabeçalhos no cliente, o API Gateway os gerará e os enviará ao backend. (Recurso disponível para instâncias Serverless e dedicadas).
-
Upload Trace Logs to Alibaba Cloud Tracing Analysis (For dedicated instances only):
App Name: informe o nome da aplicação para configurar a análise de rastreamento.
Endpoint: insira o endereço do endpoint obtido na etapa 4 em Grant permissions to Tracing Analysis. Para services na mesma região, use o endpoint de rede interna para obter melhor desempenho.
Log Sampling Strategy: escolha a estratégia conforme sua necessidade. Opções disponíveis: Upload all, Percentage upload e Fixed number of uploads per second.
Após configurar o Tracing Analysis no console do API Gateway, visualize os rastreamentos de requisições no console do Tracing Analysis. Para mais detalhes sobre o uso do Tracing Analysis, consulte View API call details.