Support de suivi actif d'Amazon API Gateway pour AWS X-Ray - 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.

Support de suivi actif d'Amazon API Gateway pour AWS X-Ray

Vous pouvez utiliser X-Ray pour suivre et analyser les demandes des utilisateurs lorsqu'elles transitent par vos API Amazon API Gateway vers les services sous-jacents. API Gateway prend en charge le suivi X-Ray pour tous les types de terminaux API Gateway : régionaux, optimisés pour les périphériques et privés. Vous pouvez utiliser X-Ray avec Amazon API Gateway partout Régions AWS où X-Ray est disponible. Pour plus d'informations, consultez Trace API Gateway API Execution with AWS X-Ray dans le manuel Amazon API Gateway Developer Guide.

Note

X-Ray prend uniquement en charge le suivi pour les API REST via API Gateway.

Amazon API Gateway fournit un support de suivi actif pour AWS X-Ray. Activez le suivi actif sur les étapes de votre API pour échantillonner les demandes entrantes et envoyer des traces à X-Ray.

Pour activer le suivi actif sur une étape d'API

  1. Ouvrez la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

  2. Choisissez une API.

  3. Choisissez une étape.

  4. Dans l'onglet Logs/Tracing, choisissez Enable X-Ray Tracing, puis sélectionnez Save Changes.

  5. Dans le volet gauche de navigation, choisissez Ressources.

  6. Pour redéployer l'API avec les nouveaux paramètres, choisissez le menu déroulant Actions, puis sélectionnez Déployer l'API.

API Gateway utilise des règles d'échantillonnage que vous définissez dans la console X-Ray pour déterminer les demandes à enregistrer. Vous pouvez créer des règles qui s'appliquent uniquement aux API ou qui s'appliquent uniquement aux demandes contenant certains en-têtes. API Gateway enregistre les en-têtes dans les attributs du segment, ainsi que des détails sur l'étape et la demande. Pour de plus amples informations, veuillez consulter Configuration de règles d'échantillonnage .

Note

Lors du suivi des API REST avec l'intégration HTTP d'API Gateway, le nom de service de chaque segment est défini sur le chemin URL de la demande entre API Gateway et votre point de terminaison d'intégration HTTP, ce qui donne un nœud de service sur la carte de suivi X-Ray pour chaque chemin d'URL unique. Un grand nombre de chemins d'URL peut faire en sorte que la carte de trace dépasse la limite de 10 000 nœuds, ce qui entraîne une erreur.

Pour minimiser le nombre de nœuds de service créés par API Gateway, pensez à transmettre des paramètres dans la chaîne de requête URL ou dans le corps de la demande via POST. L'une ou l'autre approche garantit que les paramètres ne font pas partie du chemin d'URL, ce qui peut réduire le nombre de chemins d'URL et de nœuds de service distincts.

Pour toutes les demandes entrantes, API Gateway ajoute un en-tête de suivi aux requêtes HTTP entrantes qui n'en ont pas déjà un.

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793
Format d'identification X-Ray Trace

Un X-Ray trace_id est composé de trois chiffres séparés par des tirets. Par exemple, 1-58406520-a006649127e371903a2de979. Cela consiste notamment à :

  • Le numéro de version, qui est1.

  • L'heure de la demande initiale sous Unix Epoch Time en utilisant 8 chiffres hexadécimaux.

    Par exemple, le 1er décembre 2016 à 10 h 00 PST est exprimé en 1480615200 secondes ou 58406520 en chiffres hexadécimaux.

  • Identifiant 96 bits unique au monde pour la trace en 24 chiffres hexadécimaux.

Si le suivi actif est désactivé, l'étape enregistre toujours un segment si la demande provient d'un service qui a échantillonné la demande et démarré une trace. Par exemple, une application Web instrumentée peut appeler une API API Gateway avec un client HTTP. Lorsque vous instrumentez un client HTTP avec le SDK X-Ray, celui-ci ajoute un en-tête de suivi à la demande sortante contenant la décision d'échantillonnage. API Gateway lit l'en-tête de suivi et crée un segment pour les requêtes échantillonnées.

Si vous utilisez API Gateway pour générer un SDK Java pour votre API, vous pouvez instrumenter le client du SDK en ajoutant un gestionnaire de requêtes avec le générateur de clients, de la même manière que vous instrumentiez manuellement un AWS client SDK. Pour obtenir des instructions, consultez Suivi des appels du AWS SDK avec le SDK X-Ray pour Java.