Compatibilidade com o rastreamento ativo do Amazon API Gateway para o AWS X-Ray - AWS X-Ray

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Compatibilidade com o rastreamento ativo do Amazon API Gateway para o AWS X-Ray

Você pode usar o X-Ray para rastrear e analisar solicitações do usuário à medida que elas passam pelas APIs do Amazon API Gateway em direção aos serviços subjacentes. O API Gateway comporta o rastreamento do X-Ray para todos os tipos de endpoint do API Gateway: regional, otimizado para borda e privado. Você pode usar o X-Ray com o Amazon API Gateway em todas as Regiões da AWS em que o X-Ray está disponível. Para obter mais informações, consulte Trace API Gateway API Execution with AWS X-Ray, no Guia do desenvolvedor do Amazon API Gateway.

nota

O X-Ray só comporta o rastreamento de APIs REST por meio do API Gateway.

O Amazon API Gateway oferece compatibilidade com o rastreamento ativo para o AWS X-Ray. Habilite o rastreamento ativo em seus estágios de API para realizar amostragens das solicitações de entrada e enviar rastreamentos ao X-Ray.

Para habilitar o rastreamento ativo em um estágio de API

  1. Abra o console do API Gateway em https://console.aws.amazon.com/apigateway/.

  2. Escolha uma API.

  3. Escolha um estágio.

  4. Na guia Logs/Rastreamento, escolha Habilitar rastreamento com X-Ray e selecione Salvar alterações.

  5. Escolha Resources (Recursos) no painel de navegação à esquerda.

  6. Para reimplantar a API com as novas configurações, escolha o menu suspenso Ações e selecione Implantar API.

O API Gateway usa as regras de amostragem que você define no console do X-Ray para determinar quais solicitações serão registradas. Você pode criar regras que se apliquem apenas às APIs ou que se apliquem somente às solicitações que contenham determinados cabeçalhos. O API Gateway registra cabeçalhos em atributos no segmento, bem como detalhes sobre o estágio e a solicitação. Para ter mais informações, consulte Configurar regras de amostragem.

nota

Ao rastrear APIs REST com a integração HTTP do API Gateway, o nome do serviço de cada segmento é definido como o caminho do URL da solicitação desde o API Gateway até seu endpoint de integração HTTP, o que resulta em um nó de serviço no mapa de serviço do X-Ray para cada caminho de URL exclusivo. Um grande número de caminhos de URL pode fazer com que o mapa de serviço exceda o limite de dez mil nós, resultando em um erro.

Para minimizar o número de nós de serviço criados pelo API Gateway, considere a possibilidade de passar parâmetros na string de consulta do URL ou no corpo da solicitação via POST. Qualquer abordagem garantirá que os parâmetros não façam parte do caminho do URL, o que pode resultar em menos caminhos de URL e nós de serviço distintos.

Para todas as solicitações de entrada, o Gateway da API adiciona um cabeçalho de rastreamento às solicitações HTTP de entrada que ainda não têm um.

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793
Formato do ID de rastreamento do X-Ray

Um trace_id do X-Ray consiste em três números separados por hifens. Por exemplo, 1-58406520-a006649127e371903a2de979. Isso inclui:

  • O número da versão, que é 1.

  • A hora da solicitação original, em horário epoch Unix, com 8 dígitos hexadecimais.

    Por exemplo, 10h no dia 1º de dezembro de 2016 PST equivale a 1480615200 segundos em horário epoch ou a 58406520 em dígitos hexadecimais.

  • Um identificador globalmente exclusivo de 96 bits para o rastreamento com 24 dígitos hexadecimais.

Se o rastreamento ativo estiver desabilitado, o estágio ainda registrará um segmento se a solicitação vier de um serviço que realizou a amostragem da solicitação e iniciou um rastreamento. Por exemplo, uma aplicação web instrumentada pode chamar uma API do API Gateway com um cliente HTTP. Quando você instrumenta um cliente HTTP com o X-Ray SDK, ele adiciona um cabeçalho de rastreamento à solicitação de saída que contém a decisão de amostragem. O API Gateway lê o cabeçalho de rastreamento e cria um segmento para amostras de solicitações.

Se você usar o API Gateway para gerar um SDK do Java para a API, poderá instrumentar o cliente do SDK adicionando um manipulador de solicitações ao compilador de clientes, da mesma forma que instrumentaria manualmente um cliente do SDK da AWS. Para obter instruções, consulte Rastrear chamadas de SDK da AWS com o X-Ray SDK para Java.