Tracciamento delle richieste in arrivo con l'SDK X-Ray per Python

Quando aggiungi il middleware all'applicazione e configuri il nome di un segmento, l'SDK X-Ray per Python crea un segmento per ogni richiesta campionata. Questo segmento include durata, metodo e conclusione della richiesta HTTP. Analisi ulteriori creano sottosegmenti associati a questo segmento.

l'SDK X-Ray per SDK for Python per Python per strumentare le richieste HTTP in entrata:

• Django

• Flask

• Bottle

Nota

PerAWS Lambda le funzioni, Lambda crea un segmento per ogni richiesta campionata. Per ulteriori informazioni, consulta AWS Lambda e AWS X-Ray.

VediWorker per un esempio di funzione Python strumentata in Lambda.

Per gli script o le applicazioni Python su altri framework, puoi creare i segmenti manualmente.

Ogni segmento ha un nome che identifica l'applicazione nella mappa dei servizi. Il segmento può essere denominato staticamente oppure è possibile configurare l'SDK per denominarlo in modo dinamico in base all'intestazione dell'host nella richiesta in arrivo. La denominazione dinamica consente di raggruppare le tracce in base al nome di dominio nella richiesta e di applicare un nome predefinito se il nome non corrisponde a uno schema previsto (ad esempio, se l'intestazione dell'host è falsificata).

Richieste inoltrate

Se un sistema di bilanciamento del carico o un altro intermediario inoltra una richiesta all'applicazione, X-Ray prende l'IP del client dall'X-Forwarded-Forintestazione della richiesta anziché dall'IP di origine nel pacchetto IP. L'IP del client registrato per una richiesta inoltrata può essere falsificato, quindi non dovrebbe essere considerato affidabile.

Quando viene inoltrata una richiesta, l'SDK imposta un campo aggiuntivo nel segmento per indicarlo. Se il segmento contiene il campox_forwarded_for impostato sutrue, l'IP del client è stato preso dall'X-Forwarded-Forintestazione della richiesta HTTP.

Il middleware crea un segmento per ogni richiesta in entrata con un blocco http che contiene le informazioni riportate qui di seguito:

• Metodo HTTP: GET, POST, PUT, DELETE, ecc.

• Indirizzo client: l'indirizzo IP del client che ha inviato la richiesta.

• Codice di risposta: il codice di risposta HTTP per la richiesta completata.

• Tempistica: l'ora di inizio (quando è stata ricevuta la richiesta) e l'ora di fine (quando è stata inviata la risposta).

• Agente utente: lauser-agent parte della richiesta.

• Lunghezza del contenuto: la lunghezzacontent-length della risposta.

Aggiunta del middleware all'applicazione (Django)

Aggiungi il middleware all'elenco MIDDLEWARE nel tuo file settings.py. Il middleware X-Ray dovrebbe essere presente nella prima riga del tuo file settings.py per assicurarti che le richieste che non ricadano sotto il controllo di altri middleware quando vengono registrate.

Esempio settings.py - SDK X-Ray per 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'
]

Aggiungi l'app X-Ray SDK Django all'INSTALLED_APPSelenco del tuosettings.py file. Ciò consentirà di configurare il registratore a X-Ray all'avvio dell'app.

Esempio settings.py - l'SDK X-Ray per 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',
]

Configurazione di un nome di segmento nel tuo file settings.py.

Esempio settings.py — nome del segmento

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

Questo indica al registratore X-Ray di tracciare le richieste servite dall'applicazione Django con la frequenza di campionamento predefinita. Puoi configurare il file delle impostazioni del registratore Django affinché applichi le regole di campionatura personalizzate o modificare altre impostazioni.

Nota

Poichéplugins vengono passati come tupla, assicurati di includere un finale, quando specifichi un singolo plugin. Ad esempio, plugins = ('EC2Plugin',)

Aggiunta del middleware all'applicazione (flask)

Per analizzare la tua applicazione, prima di tutto configura un nome di segmento in xray_recorder. Quindi, utilizza la funzione XRayMiddleware per applicare una patch al codice dell'applicazione Flask.

Esempio 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)

Questo indica al registratore a X-Ray di tracciare le richieste servite dall'applicazione Flask con la frequenza di campionamento predefinita. Puoi configurare il registratore all'interno del codice affinché applichi le regole di campionatura personalizzate o modificare altre impostazioni.

Aggiunta del middleware all'applicazione (Bottle)

Per analizzare l'applicazione Bottle, prima di tutto configura un nome di segmento in xray_recorder. Quindi, utilizza la funzione XRayMiddleware per applicare una patch al codice dell'applicazione Bottle.

Esempio 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))

Questo indica al registratore a X-Ray di tracciare le richieste inviate dall'applicazione Bottle con la frequenza di campionamento predefinita. Puoi configurare il registratore all'interno del codice affinché applichi le regole di campionatura personalizzate o modificare altre impostazioni.

Analisi manuale del codice Python

Se non utilizzi Django o Flask, puoi creare i segmenti manualmente. È possibile creare un segmento per ogni richiesta in arrivo o creare segmenti attorno ai client HTTP oAWS SDK con patch per fornire al registratore il contesto in cui aggiungere sottosegmenti.

Esempio main.py — Strumentazione manuale

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()

Configurazione di una strategia di denominazione dei segmenti

AWS X-Rayutilizza un nome di servizio per identificare l'applicazione e distinguerla dalle altre applicazioni, database, API esterne eAWS risorse utilizzate dall'applicazione. Quando l'SDK X-Ray genera segmenti per le richieste in entrata, registra il nome del servizio dell'applicazione nel campo del nome del segmento.

L'SDK X-Ray può assegnare ai segmenti il nome dell'host nell'intestazione della richiesta HTTP. Tuttavia, questa intestazione può essere falsificata, il che potrebbe causare nodi imprevisti nella mappa dei servizi. Per evitare che l'SDK nomini i segmenti in modo errato a causa di richieste con intestazioni host contraffatte, è necessario specificare un nome predefinito per le richieste in entrata.

Se la tua applicazione soddisfa richieste per più domini, puoi configurare l'SDK in modo che utilizzi una strategia di denominazione dinamica per rispecchiarla nei nomi dei segmenti. Una strategia di denominazione dinamica consente all'SDK di utilizzare il nome host per le richieste che corrispondono a uno schema previsto e di applicare il nome predefinito alle richieste che non lo soddisfano.

Ad esempio, potresti avere una singola applicazione che invia richieste a tre sottodomini:www.example.comapi.example.com, estatic.example.com. È possibile utilizzare una strategia di denominazione dinamica con il modello*.example.com per identificare i segmenti per ogni sottodominio con un nome diverso, ottenendo tre nodi di servizio sulla mappa dei servizi. Se la tua applicazione riceve richieste con un nome host che non corrisponde al modello, vedrai un quarto nodo sulla mappa del servizio con un nome di fallback specificato.

Per utilizzare lo stesso nome per tutti i segmenti della richiesta, specifica il nome della tua applicazione quando configuri il registratore, come illustrato nelle sezioni precedenti.

Una strategia di denominazione dinamica definisce un modello al quale devono corrispondere i nomi degli host e un nome di default per l'utilizzo qualora il nome dell'host nella richiesta HTTP non corrisponda al modello. Per denominare in modo dinamico i segmenti in Django, aggiungere l'impostazione DYNAMIC_NAMING al tuo file settings.py.

Esempio settings.py — Denominazione dinamica

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

Puoi utilizzare '*' nel modello per una corrispondenza con qualsiasi stringa o '?' per una corrispondenza con qualsiasi carattere singolo. Per Flask, configura il registratore nel codice.

Esempio main.py — nome del segmento

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

Nota

È possibile sovrascrivere il nome del servizio predefinito definito nel codice con la variabile diAWS_XRAY_TRACING_NAME ambiente.