View a markdown version of this page

Utiliser un SDK - AWS X-Ray

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utiliser un SDK

Note

X-Ray SDK/Daemon Avis de maintenance — Le 25 février 2026, il passera en mode maintenance, où les versions du X-Ray SDK et du démon AWS seront limitées pour résoudre uniquement les problèmes de sécurité. AWS X-Ray SDKs/Daemon Pour plus d'informations sur la chronologie du support, consultezChronologie du support pour le SDK et Daemon X-Ray. Nous vous recommandons de migrer vers OpenTelemetry. Pour plus d'informations sur la migration vers OpenTelemetry, consultez la section Migration d'une X-Ray instrumentation à OpenTelemetry une autre.

Utilisez un SDK si vous souhaitez utiliser une interface de ligne de commande ou si vous avez besoin de fonctionnalités de suivi, de surveillance ou de journalisation plus personnalisées que celles disponibles dans un Console de gestion AWS. Vous pouvez également utiliser un AWS SDK pour développer des programmes utilisant les X-Ray API. Vous pouvez utiliser le SDK AWS Distro for OpenTelemetry (ADOT) ou le SDK. X-Ray

Si vous utilisez un SDK, vous pouvez ajouter des personnalisations à votre flux de travail à la fois lorsque vous instrumentez votre application et lorsque vous configurez votre collecteur ou votre agent. Vous pouvez utiliser un SDK pour effectuer les tâches suivantes que vous ne pouvez pas effectuer à l'aide d'un Console de gestion AWS :

  • Publiez des mesures personnalisées — Échantillonnez des mesures en haute résolution (jusqu'à une seconde), utilisez plusieurs dimensions pour ajouter des informations sur une métrique et regroupez les points de données dans un ensemble de statistiques.

  • Personnalisez votre collecteur : personnalisez la configuration de n'importe quelle partie d'un collecteur, y compris le récepteur, le processeur, l'exportateur et le connecteur.

  • Personnalisez votre instrumentation : personnalisez les segments et les sous-segments, ajoutez des paires clé-valeur personnalisées en tant qu'attributs et créez des mesures personnalisées.

  • Créez et mettez à jour des règles d'échantillonnage par programmation.

Utilisez le ADOT SDK si vous souhaitez bénéficier de la flexibilité d'un OpenTelemetry SDK standardisé avec des niveaux supplémentaires de AWS sécurité et d'optimisation. Le SDK AWS Distro for OpenTelemetry (ADOT) est un package indépendant des fournisseurs qui permet l'intégration avec les backends d'autres fournisseurs et non fournisseurs de AWS services sans avoir à réinstrumenter votre code.

Utilisez le X-Ray SDK si vous l'utilisez déjà, si vous l' X-Ray intégrez uniquement AWS aux backends et si vous ne souhaitez pas modifier la façon dont vous interagissez avec le code de votre application X-Ray ou votre code d'application.

Pour plus d'informations sur chaque fonctionnalité, consultezChoisir entre The AWS Distro for OpenTelemetry et X-Ray SDKs.

Utilisez la commande ADOT Kit SDK

Le ADOT SDK est un ensemble d'API, de bibliothèques et d'agents open source qui envoient des données aux services principaux. ADOTest pris en charge par AWS, s'intègre à plusieurs backends et agents et fournit un grand nombre de bibliothèques open source gérées par la OpenTelemetry communauté. Utilisez le ADOT SDK pour instrumenter votre application et collecter des journaux, des métadonnées, des métriques et des traces. Vous pouvez également l'utiliser ADOT pour surveiller les services et définir une alarme en fonction de vos statistiques dans CloudWatch.

Si vous utilisez le ADOT SDK, vous disposez des options suivantes, en combinaison avec un agent :

  • Utilisez le ADOT SDK avec l'CloudWatch agent (recommandé).

  • Utilisez le ADOT SDK avec le ADOT Collector. C'est recommandé si vous souhaitez utiliser un logiciel indépendant du fournisseur avec des AWS niveaux de sécurité et d'optimisation.

Pour utiliser le ADOT SDK, procédez comme suit :

  • Instrumentez votre application à l'aide du ADOT SDK. Pour plus d'informations, consultez la documentation de votre langage de programmation dans la documentation technique ADOT.

  • Configurez un ADOT collecteur pour lui indiquer où envoyer les données qu'il collecte.

Une fois que le ADOT collecteur a reçu vos données, il les envoie au backend que vous spécifiez dans la ADOT configuration. ADOTpeut envoyer des données à plusieurs backends, y compris à des fournisseurs extérieurs AWS, comme le montre le schéma suivant :

Vous pouvez personnaliser le collecteur ADOT lorsque vous instrumentez votre application et configurez le collecteur.

AWS mises à jour régulières ADOT pour ajouter des fonctionnalités et s'aligner sur le OpenTelemetry framework. Les mises à jour et les plans futurs de développement ADOT font partie d'une feuille de route accessible au public. ADOTprend en charge plusieurs langages de programmation, notamment les suivants :

  • Go

  • Java

  • JavaScript

  • Python

  • .NET

  • Ruby

  • PHP

Si vous utilisez Python, vous ADOT pouvez automatiquement instrumenter votre application. Pour commencer à l'utiliserADOT, consultez les sections Présentation et prise en main de la AWS distribution pour OpenTelemetry Collector.

Utilisez la commande X-Ray Kit SDK

Le X-Ray SDK est un ensemble d' AWS API et de bibliothèques qui envoient des données aux services AWS principaux. Utilisez le X-Ray SDK pour instrumenter votre application et collecter des données de trace. Vous ne pouvez pas utiliser le X-Ray SDK pour collecter des données de journal ou de métriques.

Si vous utilisez le X-Ray SDK, vous disposez des options suivantes, en combinaison avec un agent :

  • Utilisez le X-Ray SDK avec AWS X-Ray daemon — Utilisez-le si vous ne souhaitez pas mettre à jour le code de votre application.

  • Utiliser le X-Ray SDK avec l' CloudWatch agent — (recommandé) L' CloudWatch agent est compatible avec le X-Ray SDK.

Pour utiliser le X-Ray SDK, procédez comme suit :

  • Instrumentez votre application à l'aide du X-Ray SDK.

  • Configurez un collecteur pour lui indiquer où envoyer les données qu'il collecte. Vous pouvez utiliser l' CloudWatch agent ou le X-Ray démon pour collecter vos informations de trace.

Une fois que le collecteur ou l'agent a reçu vos données, il les envoie à un AWS backend que vous spécifiez dans la configuration de l'agent. Le X-Ray SDK peut uniquement envoyer des données à un AWS backend, comme indiqué dans le schéma suivant :

Utilisez le X-Ray SDK avec l' CloudWatch agent ou le X-Ray démon.

Si vous l'utilisezJava, vous pouvez utiliser le X-Ray SDK pour instrumenter automatiquement votre application. Pour commencer à utiliser le X-Ray SDK, consultez les bibliothèques associées aux langages de programmation suivants :