Usar um SDK - 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á.

Usar um SDK

nota

End-of-support aviso — Em 25 de fevereiro de 2027, o AWS X-Ray interromperá o suporte para AWS X-Ray SDKs o daemon. Depois de 25 de fevereiro de 2027, você não receberá mais atualizações ou lançamentos. Para obter mais informações sobre o cronograma de suporte, consulteCronograma de fim do suporte do X-Ray SDK e do daemon. Recomendamos migrar para o. OpenTelemetry Para obter mais informações sobre a migração para OpenTelemetry, consulte Migrando da instrumentação X-Ray para a instrumentação. OpenTelemetry

Use um SDK se quiser usar uma interface de linha de comando ou precisar de mais recursos personalizados de rastreamento, monitoramento ou log do que os disponíveis em um AWS Management Console. Você também pode usar um AWS SDK para desenvolver programas que usam o X-Ray APIs. Você pode usar o AWS Distro for OpenTelemetry (ADOT) SDK ou o X-Ray SDK.

Ao usar um SDK, você pode adicionar personalizações ao fluxo de trabalho ao instrumentar sua aplicação e ao configurar o coletor ou o agente. Você pode usar um SDK para realizar as seguintes tarefas, o que não é possível usando um AWS Management Console:

  • Publicar métricas personalizadas: avalie métricas em altas resoluções de até 1 segundo, use várias dimensões para adicionar informações sobre uma métrica e agregue pontos de dados em um conjunto de estatísticas.

  • Personalizar seu coletor: personalize a configuração de qualquer parte de um coletor, incluindo o receptor, o processador, o exportador e o conector.

  • Personalizar sua instrumentação: personalize segmentos e subsegmentos, adicione pares de valor-chave personalizados como atributos e crie métricas personalizadas.

  • Crie e atualize regras de amostragem programaticamente.

Use o ADOT SDK se quiser a flexibilidade de usar um OpenTelemetry SDK padronizado com camadas adicionais de AWS segurança e otimização. O AWS Distro for OpenTelemetry (ADOT) SDK é um pacote independente de fornecedor que permite a integração com back-ends de outros fornecedores e não prestadores de AWS serviços sem precisar reinstrumentar seu código.

Use o SDK do X-Ray se você já estiver usando o SDK do X-Ray, se integrar apenas com backends da AWS e não quiser alterar a maneira como interage com o X-Ray ou com o código da aplicação.

Para obter mais informações sobre cada recurso, consulte Escolhendo entre o AWS Distro for OpenTelemetry e o X-Ray SDKs.

Usar o SDK do ADOT

O ADOT SDK é um conjunto de bibliotecas e agentes de código APIs aberto que enviam dados para serviços de back-end. ADOTé suportado por AWS, se integra a vários back-ends e agentes e fornece um grande número de bibliotecas de código aberto mantidas pela OpenTelemetry comunidade. Use o SDK do ADOT para instrumentar sua aplicação e coletar logs, metadados, métricas e rastreamentos. Você também pode usar ADOT para monitorar serviços e definir um alarme com base em suas métricas em CloudWatch.

Ao usar o SDK do ADOT, você tem as seguintes opções, em combinação com um agente:

  • Use o ADOT SDK com o CloudWatch agente — recomendado.

  • Use o ADOT SDK com o ADOTCollector — recomendado se você quiser usar um software independente de fornecedor com AWS camadas de segurança e otimização.

Para usar o SDK do ADOT, faça o seguinte:

  • Instrumente sua aplicação usando o SDK do ADOT. Para obter mais informações, consulte a documentação de sua linguagem de programação na documentação técnica do ADOT.

  • Configure um coletor do ADOT para informá-lo para onde enviar os dados que ele coleta.

Depois que o ADOT coletor recebe seus dados, ele os envia para o back-end especificado na ADOT configuração. ADOTpode enviar dados para vários back-ends, inclusive para fornecedores externos AWS, conforme mostrado no diagrama a seguir:

Você pode personalizar o coletor do ADOT ao instrumentar sua aplicação e configurar o coletor.

AWS ADOTatualiza regularmente para adicionar funcionalidades e se alinhar à OpenTelemetryestrutura. Atualizações e futuros planos de desenvolvimento do ADOT fazem parte de um roteiro que está disponível para o público. O ADOT é compatível com várias linguagens de programação que incluem o seguinte:

  • Go

  • Java

  • JavaScript

  • Python

  • .NET

  • Ruby

  • PHP

Se você estiver usando Python, o ADOT pode instrumentar automaticamente sua aplicação. Para começar a usarADOT, consulte Introdução e Introdução à AWS distribuição do OpenTelemetry Collector.

Usar o SDK do X-Ray

O X-Ray SDK é um conjunto AWS APIs e bibliotecas que enviam dados para serviços de AWS back-end. Use o SDK do X-Ray para instrumentar a aplicação e coletar dados de rastreamento. Não é possível usar o SDK do X-Ray para coletar dados métricos ou de log.

Ao usar o SDK do X-Ray, você tem as seguintes opções, em combinação com um agente:

  • Usar o SDK do X-Ray com o AWS X-Ray daemon: use isso se não quiser atualizar o código da aplicação.

  • Use o X-Ray SDK com o CloudWatch agente — (recomendado) O CloudWatch agente é compatível com o X-Ray SDK.

Para usar o SDK do X-Ray, faça o seguinte:

  • Instrumente sua aplicação usando o SDK do X-Ray.

  • Configure um coletor para informá-lo para onde enviar os dados que ele coleta. Você pode usar o CloudWatch agente ou o daemon X-Ray para coletar suas informações de rastreamento.

Depois que o coletor ou agente recebe seus dados, ele os envia para um AWS back-end que você especifica na configuração do agente. O SDK do X-Ray só pode enviar dados para um backend da AWS , conforme mostrado no diagrama a seguir:

Use o X-Ray SDK com o CloudWatch agente ou com o daemon X-Ray.

Se estiver usando o Java, você pode usar o SDK do X-Ray para instrumentar automaticamente sua aplicação. Para começar a usar o SDK do X-Ray, consulte as bibliotecas associadas às seguintes linguagens de programação: