

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.

# Suivi des demandes entrantes avec le kit de développement X-Ray pour le middleware Python
<a name="xray-sdk-python-middleware"></a>

**Note**  
Avis de SDK/Daemon maintenance de X-Ray — Le 25 février 2026, le AWS X-Ray SDKs/Daemon passera en mode maintenance, où les versions du SDK et du Daemon de X-Ray AWS seront limitées uniquement pour résoudre les problèmes de sécurité. Pour plus d'informations sur le calendrier de support, consultez[Chronologie du support pour le SDK et Daemon X-Ray](xray-sdk-daemon-timeline.md). Nous vous recommandons de migrer vers OpenTelemetry. Pour plus d'informations sur la migration vers OpenTelemetry, voir [Migration de l'instrumentation X-Ray vers OpenTelemetry l'instrumentation](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-migration.html).

Lorsque vous ajoutez le middleware à votre application et que vous configurez un nom de segment, le SDK X-Ray pour Python crée un segment pour chaque requête é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.

Le SDK X-Ray pour Python prend en charge les intergiciels suivants pour instrumenter les requêtes HTTP entrantes : 
+ Django
+ Flask
+ Bottle

**Note**  
Pour les AWS Lambda fonctions, Lambda crée un segment pour chaque requête échantillonnée. Pour plus d’informations, consultez [AWS Lambda et AWS X-Ray](xray-services-lambda.md).

Voir un [Nœuds](scorekeep-lambda.md#scorekeep-lambda-worker) exemple de fonction Python instrumentée dans Lambda.

Pour les scripts ou applications Python sur d'autres frameworks, vous pouvez [créer des segments manuellement](#xray-sdk-python-middleware-manual).

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

**Demandes transmises**  
Si un équilibreur de charge ou un autre intermédiaire transmet une demande à votre application, X-Ray prend l'adresse IP du client depuis l'`X-Forwarded-For`en-tête de la demande plutôt que depuis l'adresse IP source du paquet IP. L'adresse IP du client enregistrée pour une demande transférée peut être falsifiée, elle ne doit donc pas être fiable.

Lorsqu'une demande est transmise, le SDK définit un champ supplémentaire dans le segment pour l'indiquer. Si le segment contient le champ `x_forwarded_for` défini sur`true`, l'adresse IP du client a été extraite de l'`X-Forwarded-For`en-tête de la requête HTTP.

L'intergiciel crée un segment pour chaque demande entrante avec un bloc `http` contenant les informations suivantes :
+ **Méthode HTTP** : GET, POST, PUT, DELETE, etc.
+ **Adresse du client** : adresse IP du client qui a envoyé la demande.
+ **Code de réponse** : code de réponse HTTP pour la demande terminée.
+ **Moment** : heure de début (date de réception de la demande) et heure de fin (date d'envoi de la réponse).
+ **Agent utilisateur** — Le formulaire `user-agent` de la demande.
+ **Longueur du contenu** : `content-length` extrait de la réponse.

**Topics**
+ [Ajout des intergiciels à votre application (Django)](#xray-sdk-python-adding-middleware-django)
+ [Ajout des intergiciels à votre application (Flask)](#xray-sdk-python-adding-middleware-flask)
+ [Ajout des intergiciels à votre application (Bottle)](#xray-sdk-python-adding-middleware-bottle)
+ [Instrumentation manuelle du code Python](#xray-sdk-python-middleware-manual)
+ [Configuration d'une stratégie d'attribution de noms de segment](#xray-sdk-python-middleware-naming)

## Ajout des intergiciels à votre application (Django)
<a name="xray-sdk-python-adding-middleware-django"></a>

Ajoutez les intergiciels à la liste `MIDDLEWARE` dans le fichier `settings.py`. L'intergiciel X-Ray doit figurer sur la première ligne du fichier `settings.py` afin que les demandes qui échouent dans d'autres intergiciels soient enregistrées.

**Example settings.py - SDK X-Ray pour intergiciel Python**  

```
MIDDLEWARE = [
    'aws_xray_sdk.ext.django.middleware.XRayMiddleware',
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware'
]
```

Ajoutez l'application Django du SDK X-Ray à la `INSTALLED_APPS` liste de votre `settings.py` fichier. Cela permettra de configurer l'enregistreur X-Ray lors du démarrage de votre application.

**Example settings.py - SDK X-Ray pour l'application Python Django**  

```
INSTALLED_APPS = [
    'aws_xray_sdk.ext.django',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]
```

Configurez un nom de segment dans le fichier [`settings.py`](xray-sdk-python-configuration.md#xray-sdk-python-middleware-configuration-django).

**Example settings.py — Nom du segment**  

```
XRAY_RECORDER = {
    'AWS_XRAY_TRACING_NAME': 'My application',
    'PLUGINS': ('EC2Plugin',),
}
```

Cela indique à l'enregistreur X-Ray de suivre les requêtes traitées par votre application Django avec le taux d'échantillonnage par défaut. Vous pouvez [configurer les paramètres du fichier Django de l'enregistreur](xray-sdk-python-configuration.md#xray-sdk-python-middleware-configuration-django) pour appliquer les règles d'échantillonnage personnalisées ou modifier d'autres paramètres.

**Note**  
Comme `plugins` ils sont transmis sous forme de tuple, veillez à inclure une fin `,` lorsque vous spécifiez un seul plugin. Par exemple, `plugins = ('EC2Plugin',)` 

## Ajout des intergiciels à votre application (Flask)
<a name="xray-sdk-python-adding-middleware-flask"></a>

Pour instrumenter l'application Flask, vous devez d'abord configurer un nom de segment dans l'élément `xray_recorder`. Utilisez ensuite la fonction `XRayMiddleware` pour corriger votre application Flask dans le code.

**Example app.py**  

```
from aws_xray_sdk.core import xray_recorder
from aws_xray_sdk.ext.flask.middleware import XRayMiddleware

app = Flask(__name__)

xray_recorder.configure(service='My application')
XRayMiddleware(app, xray_recorder)
```

Cela indique à l'enregistreur X-Ray de suivre les demandes traitées par votre application Flask avec le taux d'échantillonnage par défaut. Vous pouvez [configurer l'enregistreur dans le code](xray-sdk-python-configuration.md#xray-sdk-python-middleware-configuration-code) pour appliquer les règles d'échantillonnage personnalisées ou modifier d'autres paramètres.

## Ajout des intergiciels à votre application (Bottle)
<a name="xray-sdk-python-adding-middleware-bottle"></a>

Pour instrumenter votre application Bottle, vous devez d'abord configurer un nom de segment dans l'élément `xray_recorder`. Utilisez ensuite la fonction `XRayMiddleware` pour corriger votre application Bottle dans le code.

**Example app.py**  

```
from aws_xray_sdk.core import xray_recorder
from aws_xray_sdk.ext.bottle.middleware import XRayMiddleware
 
app = Bottle()
 
xray_recorder.configure(service='fallback_name', dynamic_naming='My application')
app.install(XRayMiddleware(xray_recorder))
```

Cela indique à l'enregistreur X-Ray de suivre les demandes traitées par votre application Bottle avec le taux d'échantillonnage par défaut. Vous pouvez [configurer l'enregistreur dans le code](xray-sdk-python-configuration.md#xray-sdk-python-middleware-configuration-code) pour appliquer les règles d'échantillonnage personnalisées ou modifier d'autres paramètres.

## Instrumentation manuelle du code Python
<a name="xray-sdk-python-middleware-manual"></a>

Si vous n'utilisez pas Django ni Flask, vous pouvez créer des segments manuellement. Vous pouvez créer un segment pour chaque demande entrante, ou créer des segments autour de clients HTTP ou AWS SDK corrigés afin de fournir un contexte permettant à l'enregistreur d'ajouter des sous-segments.

**Example main.py — Instrumentation manuelle**  

```
from aws_xray_sdk.core import xray_recorder

# Start a segment
segment = xray_recorder.begin_segment('segment_name')
# Start a subsegment
subsegment = xray_recorder.begin_subsegment('subsegment_name')

# Add metadata and annotations
segment.put_metadata('key', dict, 'namespace')
subsegment.put_annotation('key', 'value')

# Close the subsegment and segment
xray_recorder.end_subsegment()
xray_recorder.end_segment()
```

## Configuration d'une stratégie d'attribution de noms de segment
<a name="xray-sdk-python-middleware-naming"></a>

AWS X-Ray utilise un *nom de service* pour identifier votre application et la distinguer des autres applications, bases de données, ressources externes APIs et AWS ressources utilisées par votre application. Lorsque le SDK X-Ray génère des segments pour les demandes entrantes, il enregistre le nom du service de votre application dans le [champ du nom](xray-api-segmentdocuments.md#api-segmentdocuments-fields) du segment.

Le SDK X-Ray peut nommer les segments d'après le nom d'hôte dans l'en-tête de la requête HTTP. Cependant, cet en-tête peut être falsifié, ce qui peut entraîner la création de nœuds inattendus dans votre carte de service. Pour éviter que le SDK ne nomme les segments de manière incorrecte en raison de demandes contenant 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 traite des demandes pour plusieurs domaines, vous pouvez configurer le SDK pour qu'il utilise une stratégie de dénomination dynamique afin de refléter cela dans les noms des segments. Une stratégie de dénomination dynamique permet au SDK d'utiliser le nom d'hôte pour les demandes qui correspondent à un modèle attendu et d'appliquer le nom par défaut aux demandes qui ne le sont pas.

Par exemple, il se peut qu'une seule application envoie des demandes à trois sous-domaines : `www.example.com``api.example.com`, et`static.example.com`. Vous pouvez utiliser une stratégie de dénomination dynamique avec le modèle `*.example.com` pour identifier les segments de chaque sous-domaine avec un nom différent, ce qui permet d'obtenir trois nœuds de service sur la carte des services. 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 des services avec un nom de remplacement que vous spécifiez.

Pour utiliser le même nom pour tous les segments de demande, spécifiez le nom de votre application lorsque vous configurez l'enregistreur, comme illustré dans les [sections précédentes](#xray-sdk-python-adding-middleware-django).

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 des segments de façon dynamique dans Django, ajoutez le paramètre `DYNAMIC_NAMING` au fichier [settings.py](xray-sdk-python-configuration.md#xray-sdk-python-middleware-configuration-django).

**Example settings.py — Dénomination dynamique**  

```
XRAY_RECORDER = {
    'AUTO_INSTRUMENT': True,
    'AWS_XRAY_TRACING_NAME': 'My application',
    'DYNAMIC_NAMING': '*.example.com',
    'PLUGINS': ('ElasticBeanstalkPlugin', 'EC2Plugin')
}
```

Vous pouvez utiliser '\$1' dans le modèle pour correspondre à n'importe quelle chaîne ou '?' pour correspondre à un seul caractère. Pour Flask, [configurez l'enregistreur dans le code](xray-sdk-python-configuration.md#xray-sdk-python-middleware-configuration-code).

**Example main.py — Nom du segment**  

```
from aws_xray_sdk.core import xray_recorder
xray_recorder.configure(service='My application')
xray_recorder.configure(dynamic_naming='*.example.com')
```

**Note**  
Vous pouvez remplacer le nom de service par défaut que vous définissez avec la `AWS_XRAY_TRACING_NAME`variable d'environnement[Variables d’environnement](xray-sdk-python-configuration.md#xray-sdk-python-configuration-envvars).