View a markdown version of this page

Utiliser l' X-Ray API - 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 l' X-Ray API

Si le X-Ray SDK ne prend pas en charge votre langage de programmation, vous pouvez utiliser les X-Ray API directement ou le AWS Command Line Interface (AWS CLI) pour appeler les commandes d' X-Ray API. Suivez les instructions suivantes pour choisir la manière dont vous interagissez avec l'API :

  • Utilisez le AWS CLI pour simplifier la syntaxe à l'aide de commandes préformatées ou avec des options dans votre requête.

  • Utilisez directement l' X-Ray API pour une flexibilité et une personnalisation maximales des demandes que vous envoyez à X-Ray.

Si vous utilisez l'X-Ray API directement au lieu de AWS CLI, vous devez paramétrer votre demande dans le format de données correct et vous devrez peut-être également configurer l'authentification et la gestion des erreurs.

Le schéma suivant indique comment vous souhaitez interagir avec l' X-RayAPI :

X-Ray affiche des informations détaillées sur les demandes de candidature.

Utilisez l' X-Ray API pour envoyer des données de trace directement à X-Ray. L' X-Ray API prend en charge toutes les fonctions disponibles dans le X-Ray SDK, y compris les actions courantes suivantes :

  • PutTraceSegments— Télécharge les documents de segment vers. X-Ray

  • BatchGetTraces— Récupère une liste de traces dans une liste d'ID de trace. Chaque trace récupérée est une collection de documents segmentés provenant d'une seule demande.

  • GetTraceSummaries— Récupère les identifiants et les annotations des traces. Vous pouvez spécifier a FilterExpression pour récupérer un sous-ensemble de résumés de traces.

  • GetTraceGraph— Récupère un graphique de service pour un identifiant de trace spécifique.

  • GetServiceGraph— Extrait un document JSON formaté qui décrit les services qui traitent les demandes entrantes et appellent les demandes en aval.

Vous pouvez également utiliser le AWS Command Line Interface (AWS CLI) dans le code de votre application pour interagir par programmation avec. X-Ray Il AWS CLI prend en charge toutes les fonctions disponibles dans le X-Ray SDK, y compris celles pour les autres Services AWS. Les fonctions suivantes sont des versions des opérations d'API répertoriées précédemment dans un format plus simple :

  • put-trace-segments — Télécharge les documents des segments vers. X-Ray

  • batch-get-traces — Récupère une liste de traces dans une liste d'ID de trace. Chaque trace récupérée est une collection de documents segmentés provenant d'une seule demande.

  • get-trace-summaries — Récupère les identifiants et les annotations des traces. Vous pouvez spécifier a FilterExpression pour récupérer un sous-ensemble de résumés de traces.

  • get-trace-graph — Récupère un graphe de service pour un identifiant de trace spécifique.

  • get-service-graph — Récupère un document JSON formaté qui décrit les services qui traitent les demandes entrantes et appellent les demandes en aval.

Pour commencer, vous devez l'installer AWS CLI pour votre système d'exploitation. AWS supports Linux macOS et systèmes Windows d'exploitation. Pour plus d'informations sur la liste des X-Ray commandes, consultez le guide de référence des AWS CLI commandes pour X-Ray.

Rubriques