Utilisation des cartes de service et des vues de suivi AWS X-Ray avec API Gateway

Dans cette section, vous trouverez des informations détaillées sur l'utilisation des cartes de service et des vues de suivi AWS X-Ray avec API Gateway.

Pour plus d'informations sur la cartographie des services et les vues de suivi et leur interprétation, consultez la section AWS X-Ray Console.

Exemple de carte de service X-Ray

AWS X-RayLes cartes de service présentent des informations sur votre API et tous ses services en aval. Quand X-Ray est activé pour une étape d'API dans API Gateway, un nœud contenant des informations sur le temps total passé dans le service API Gateway s'affiche dans la carte de service. Vous pouvez obtenir des informations détaillées sur le statut de réponse et un histogramme du temps de réponse de l'API pour la période sélectionnée. Pour les API qui s'intègrent avec des services AWS tels que AWS Lambda et Amazon DynamoDB, vous verrez plus de nœuds fournissant des métriques de performances liées à ces services. Une cartographie des services est disponible pour chaque étape de l'API.

L'exemple suivant montre une cartographie des services pour l'étape test d'une API appelée xray. Cette API a une intégration Lambda avec une fonction d'autorisation Lambda et une fonction de backend Lambda. Les nœuds représentent le service API Gateway, le service Lambda et les deux fonctions Lambda.

Pour une explication détaillée de la structure de la carte de service, veuillez consulter Affichage de la carte de service.

Depuis la cartographie des services, vous pouvez zoomer afin de consulter un suivi de votre étape d'API. Le suivi affiche des informations détaillées concernant votre API, sous la forme de segments et de sous-segments. Par exemple, le suivi de la carte de service présentée ci-dessus inclut des segments pour le service Lambda et la fonction Lambda. Pour en savoir plus, veuillez consulter Lambda en tant que suivi AWS X-Ray.

Si vous sélectionnez un nœud ou un arc sur une carte de service X-Ray, la console X-Ray affiche un histogramme de distribution des latences. Vous pouvez utiliser un histogramme de latence pour voir de combien de temps a besoin un service pour traiter ses requêtes. Voici un histogramme de l'étape d'API Gateway nommée xray/test dans la précédente carte de service. Pour obtenir une explication détaillée des histogrammes de distribution de la latence, consultez la section Utilisation d'histogrammes des latences dans la console AWS X-Ray.

Exemple de vue de suivi X-Ray

Le schéma suivant présente une vue de suivi générée pour l'exemple d'API décrit ci-dessus, avec une fonction de backend Lambda et une fonction de mécanisme d'autorisation Lambda. Une demande de méthode d'API réussie s'affiche avec le code de réponse 200.

Pour obtenir une explication détaillée des vues de suivi, veuillez consulter Affichage des suivis.