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

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 AWS Management Console. Vous pouvez également utiliser un AWS SDK pour développer des programmes utilisant les API X-Ray. 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 AWS Management Console :

  • Publiez des métriques personnalisées : échantillonnez des métriques à des résolutions élevées (jusqu'à 1 seconde), utilisez plusieurs dimensions pour ajouter des informations sur une métrique et agréger des 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 métriques 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 du fournisseur qui permet l'intégration avec les backends d'autres fournisseurs et AWS non-services sans avoir à réinstrumenter votre code.

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

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

Utiliser le ADOT 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 indicateurs CloudWatch.

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

  • Utiliser le ADOT SDK avec l'CloudWatch agent, c'est recommandé.

  • Utiliser le ADOT SDK avec le ADOTcollecteur : recommandé si vous souhaitez utiliser un logiciel indépendant du fournisseur avec AWS plusieurs 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 OpenTelemetrycadre. Les mises à jour et les futurs plans de développement ADOT font partie d'une feuille de route accessible au public. ADOTprend en charge plusieurs langages de programmation, dont les suivants :

  • Go

  • Java

  • JavaScript

  • Python

  • .NET

  • Ruby

  • PHP

Si vous utilisez Python, vous ADOT pouvez automatiquement instrumenter votre application. Pour commencer à utiliserADOT, consultez Introduction et prise en main de la AWS distribution pour OpenTelemetry Collector.

Utiliser le X-Ray SDK

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

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

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

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

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

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

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

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 SDK X-Ray peut uniquement envoyer des données à un AWS backend, comme le montre le schéma suivant :

Utilisez le SDK X-Ray avec l' CloudWatch agent ou le daemon X-Ray.

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