View a markdown version of this page

Use a X-Ray API - 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á.

Use a X-Ray API

Se o X-Ray SDK não for compatível com sua linguagem de programação, você poderá usar as X-Ray APIs diretamente ou o AWS Command Line Interface (AWS CLI) para chamar os comandos X-Ray da API. Use as orientações a seguir para escolher como interagir com a API:

  • Use o AWS CLI para simplificar a sintaxe usando comandos pré-formatados ou com opções dentro de sua solicitação.

  • Use a X-Ray API diretamente para obter o máximo de flexibilidade e personalização das solicitações que você faz para X-Ray.

Se você usar a X-Ray API diretamente em vez da AWS CLI, deverá parametrizar sua solicitação no formato de dados correto e também poderá ter que configurar a autenticação e o tratamento de erros.

O diagrama a seguir mostra orientações para escolher como interagir com a X-Ray API:

X-Ray exibe informações detalhadas sobre solicitações de aplicativos.

Use a X-Ray API para enviar dados de rastreamento diretamente para X-Ray o. A X-Ray API oferece suporte a todas as funções disponíveis no X-Ray SDK, incluindo as seguintes ações comuns:

  • PutTraceSegments— Carrega documentos do segmento para. X-Ray

  • BatchGetTraces— Recupera uma lista de rastreamentos em uma lista de IDs de rastreamento. Cada rastreamento recuperado é uma coleção de documentos de segmento de uma única solicitação.

  • GetTraceSummaries— Recupera IDs e anotações para rastreamentos. Você pode especificar uma FilterExpression para recuperar um subconjunto de resumos de rastreamento.

  • GetTraceGraph— Recupera um gráfico de serviço para uma ID de rastreamento específica.

  • GetServiceGraph— recupera um documento JSON formatado que descreve os serviços que processam solicitações recebidas e ligam para solicitações posteriores.

Você também pode usar o AWS Command Line Interface (AWS CLI) dentro do código do seu aplicativo para interagir programaticamente com. X-Ray AWS CLI Ele suporta todas as funções disponíveis no X-Ray SDK, incluindo aquelas para outras Serviços da AWS. As funções a seguir são versões das operações de API listadas anteriormente com um formato mais simples:

  • put-trace-segments — Carrega documentos de segmentos para o. X-Ray

  • batch-get-traces: recupera uma lista de rastreamentos em uma lista de IDs de rastreamento. Cada rastreamento recuperado é uma coleção de documentos de segmento de uma única solicitação.

  • get-trace-summaries: recupera IDs e anotações de rastreamentos. Você pode especificar uma FilterExpression para recuperar um subconjunto de resumos de rastreamento.

  • get-trace-graph: recupera um gráfico de serviço para um ID de rastreamento específico.

  • get-service-graph: recupera um documento formatado em JSON que descreve serviços que processam solicitações de entrada e chamam solicitações subsequentes.

Para começar, você deve instalar o AWS CLI para o seu sistema operacional. AWS Linuxsuportes macOS e sistemas Windows operacionais. Para obter mais informações sobre a lista de X-Ray comandos, consulte o guia de referência de AWS CLI comandos para X-Ray.

Tópicos