Suivi des demandes entrantes avec le kit SDK X-Ray pour Node.js

Vous pouvez utiliser le kit SDK X-Ray pour Node.js pour suivre les demandes HTTP entrantes que votre application Express et vos applications Restify répondent via une instance EC2 dans Amazon EC2,AWS Elastic Beanstalk, ou Amazon ECS.

Le kit SDK X-Ray pour Node.js fournit des intergiciels pour les applications qui utilisent les infrastructures Express et Restify. Lorsque vous ajoutez l'intergiciel X-Ray à votre application, le kit SDK X-Ray pour Node.js crée un segment pour chaque demande échantillonnée. Ce segment comprend la durée, la méthode et l'état de la demande HTTP. L'instrumentation supplémentaire crée des sous-segments sur ce segment.

Chaque segment possède un nom qui identifie votre application dans la carte de service. Le segment peut être nommé de manière statique ou vous pouvez configurer le SDK pour le nommer dynamiquement en fonction de l'en-tête de l'hôte dans la demande entrante. La dénomination dynamique permet de regrouper les traces en fonction du nom de domaine dans la demande et d'appliquer un nom par défaut si le nom ne correspond pas à un modèle attendu (par exemple, si l'en-tête de l'hôte est falsifié).

Lorsqu'une demande est transférée, le kit SDK définit un champ supplémentaire dans le segment pour indiquer cela. Si le segment contient le champx_forwarded_forréglé surtrue, l'adresse IP du client a été extraite duX-Forwarded-Fordans la requête HTTP.

Le gestionnaire de messages crée un segment pour chaque demande entrante avec un bloc http contenant les informations suivantes :

Suivi des demandes entrantes avec Express

Pour utiliser l'intergiciel Express, initialisez le client du kit de développement logiciel et utilisez l'intergiciel renvoyé par la fonction express.openSegment avant de définir vos routes.

var app = express();

var AWSXRay = require('aws-xray-sdk');
app.use(AWSXRay.express.openSegment('MyApp'));

app.get('/', function (req, res) {
  res.render('index');
});

app.use(AWSXRay.express.closeSegment());

Après avoir défini vos routes, utilisez la sortie deexpress.closeSegmentcomme indiqué pour gérer les erreurs renvoyées par le kit SDK X-Ray pour Node.js.

Suivi des demandes entrantes avec Restify

Pour utiliser l'intergiciel Restify, initialisez le client du kit de développement logiciel et exécutez enable. Indiquez-lui votre serveur Restify et le nom de votre segment.

var AWSXRay = require('aws-xray-sdk');
var AWSXRayRestify = require('aws-xray-sdk-restify');

var restify = require('restify');
var server = restify.createServer();
AWSXRayRestify.enable(server, 'MyApp'));

server.get('/', function (req, res) {
  res.render('index');
});

Configuration d'une stratégie d'attribution de noms de segment

AWS X-Rayutilise unService Namepour identifier votre application et la distinguer des autres applications, bases de données, API externes etAWSressources que votre application utilise. Lorsque le kit SDK X-Ray génère des segments pour les demandes entrantes, il enregistre le nom du service de votre application dans leNom de champ.

Le SDK X-Ray peut nommer des segments après le nom d'hôte dans l'en-tête de la requête HTTP. Toutefois, cet en-tête peut être falsifié, ce qui peut entraîner des nœuds inattendus dans votre carte de service. Pour empêcher le SDK de nommer incorrectement les segments en raison de demandes comportant des en-têtes d'hôte falsifiés, vous devez spécifier un nom par défaut pour les demandes entrantes.

Si votre application répond à des demandes pour plusieurs domaines, vous pouvez configurer le SDK pour qu'il utilise une stratégie de dénomination dynamique qui reflète cela dans les noms de segments. Une stratégie de dénomination dynamique permet au SDK d'utiliser le nom d'hôte pour les demandes correspondant à un modèle attendu, et d'appliquer le nom par défaut aux demandes qui ne le font pas.

Par exemple, vous pouvez avoir une application unique qui répond à trois sous-domaines :www.example.com,api.example.com, etstatic.example.com. Vous pouvez utiliser une stratégie de dénomination dynamique avec le modèle*.example.compour identifier les segments de chaque sous-domaine portant un nom différent, ce qui entraîne trois nœuds de service sur la carte de service. Si votre application reçoit des demandes dont le nom d'hôte ne correspond pas au modèle, vous verrez un quatrième nœud sur la carte de service avec un nom de secours que vous spécifiez.

Pour utiliser le même nom pour tous les segments de la demande, spécifiez le nom de votre application lorsque vous initialisez l'intergiciel, comme indiqué dans les sections précédentes.

Une stratégie d'attribution de noms dynamique définit un modèle auquel doivent correspondre les noms d'hôte et un nom par défaut à utiliser si le nom d'hôte de la demande HTTP ne correspond pas au modèle. Pour nommer dynamiquement des segments, utilisez AWSXRay.middleware.enableDynamicNaming.

var app = express();

var AWSXRay = require('aws-xray-sdk');
app.use(AWSXRay.express.openSegment('MyApp'));
AWSXRay.middleware.enableDynamicNaming('*.example.com');
        
app.get('/', function (req, res) {
  res.render('index');
});

app.use(AWSXRay.express.closeSegment());