Ablaufverfolgung eingehender Anfragen mit dem X-Ray-SDK für Python-Middleware - AWS X-Ray

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Ablaufverfolgung eingehender Anfragen mit dem X-Ray-SDK für Python-Middleware

Wenn Sie die Middleware zu Ihrer Anwendung hinzufügen und einen Segmentnamen festlegen, erstellt das X-Ray-SDK für Python ein Segment für jede gesampelte Anfrage. Dieses Segment umfasst Dauer, Methode und Status der HTTP-Anforderung. Die zusätzliche Instrumentierung schafft Untersegmente zu diesem Segment.

Das X-Ray-SDK for Python unterstützt die folgende Middleware, um eingehende HTTP-Anfragen zu instrumentieren:

  • Django

  • Flask

  • Bottle

Anmerkung

FürAWS LambdaFunktionen erstellt Lambda ein Segment für jede stichprobenartig geprüfte Anforderung. Weitere Informationen finden Sie unter AWS Lambda und AWS X-Ray.

Siehe .Workerfür ein Beispiel Python-Funktion, die in Lambda instrumentiert ist.

Für Skripts oder Python-Anwendungen auf anderen Frameworks können Sie Segmente manuell erstellen.

Jedes Segment hat einen Namen, der Ihre Anwendung in der Service-Map identifiziert. Das Segment kann statisch benannt werden, oder Sie können das SDK so konfigurieren, dass es basierend auf dem Host-Header in der eingehenden Anforderung dynamisch benennt. Mit der dynamischen Benennung können Sie Traces basierend auf dem Domänennamen in der Anforderung gruppieren und einen Standardnamen anwenden, wenn der Name nicht mit einem erwarteten Muster übereinstimmt (z. B. wenn der Host-Header gefälscht ist).

Weitergeleitete Anfragen

Wenn ein Load Balancer oder ein anderer Vermittler eine Anfrage an Ihre Anwendung weiterleitet, übernimmt X-Ray die Client-IP von derX-Forwarded-ForHeader in der Anforderung statt von der Quell-IP im IP-Paket. Die Client-IP, die für eine weitergeleitete Anfrage aufgezeichnet wird, kann gefälscht werden und sollte daher nicht vertrauenswürdig sein.

Wenn eine Anforderung weitergeleitet wird, legt das SDK ein zusätzliches Feld im Segment fest, um dies anzugeben. Wenn das Segment das Feld enthältx_forwarded_foreingestellt auftruewurde die Client-IP von derX-Forwarded-ForHeader in der HTTP-Anforderung.

Die Middleware erzeugt für jede eingehende Anfrage ein Segment mit einem http-Block mit folgenden Informationen:

  • HTTP method (HTTP-Methode)— ABRUFEN, POSTEN, PUTEN, LÖSCHEN usw.

  • Client-Adresse— Die IP-Adresse des Clients, der die Anforderung gesendet hat.

  • Antwortcode— Der HTTP-Antwortcode für die abgeschlossene Anforderung.

  • Timing— Die Startzeit (zu der die Anforderung empfangen wurde) und die Endzeit (zu der die Antwort gesendet wurde).

  • Benutzer-Agent— Dieuser-agentaus der Anfrage.

  • Inhaltslänge— Diecontent-lengthaus der Antwort.

Hinzufügen der Middleware zu Ihrer Anwendung (Django)

Fügen Sie die Middleware zur MIDDLEWARE-Liste in Ihrer settings.py-Datei hinzu. Die X-Ray-Middleware sollte die erste Zeile in Ihrer settings.py-Datei darstellen, um sicherzugehen, dass Anfragen, die in anderen Middlewares fehlschlagen, aufgezeichnet werden.

Beispiel settings.py - X-Ray-SDK für Python-Middleware

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' ]

Fügen Sie die X-Ray-SDK-App Django-App zurINSTALLED_APPSAuflisten in Ihrersettings.pyfile. Dadurch kann der X-Recorder während des Starts Ihrer App konfiguriert werden.

Beispiel settings.py - X-Ray-SDK für Python Django-App

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', ]

Konfigurieren Sie einen Segmentnamen in Ihrer settings.py-Datei.

Beispiel settings.py — Segmentname

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

Dadurch wird der X-Recorder angewiesen, Anfragen, die von Ihrer Django-Anwendung verarbeitet werden, mit der Standard-Samplingrate nachzuverfolgen. Sie können den Recorder in Ihrer Django-Einstellungsdatei konfigurieren, um benutzerdefinierte Samplingregeln anzuwenden oder andere Einstellungen zu ändern.

Hinzufügen der Middleware zu Ihrer Anwendung (Flask)

Um Ihre Flask-Anwendung zu instrumentieren, konfigurieren Sie zunächst einen Segmentnamen im xray_recorder. Verwenden Sie dann die XRayMiddleware-Funktion zum Patchen Ihrer Flask-Anwendung im Code.

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

Dadurch wird der X-Recorder angewiesen, Anfragen, die von Ihrer Flask-Anwendung verarbeitet werden, mit der Standard-Samplingrate nachzuverfolgen. Sie können den Recorder im Code konfigurieren, um benutzerdefinierte Samplingregeln anzuwenden oder andere Einstellungen zu ändern.

Hinzufügen der Middleware zu Ihrer Anwendung (Bottle)

Um Ihre Bottle-Anwendung zu instrumentieren, konfigurieren Sie zunächst einen Segmentnamen im xray_recorder. Verwenden Sie dann die XRayMiddleware-Funktion zum Patchen Ihrer Bottle-Anwendung im Code.

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

Dadurch wird der X-Recorder angewiesen, Anfragen, die von Ihrer Bottle-Anwendung verarbeitet werden, mit der Standard-Samplingrate nachzuverfolgen. Sie können den Recorder im Code konfigurieren, um benutzerdefinierte Samplingregeln anzuwenden oder andere Einstellungen zu ändern.

Manuelle Instrumentierung von Python-Code

Wenn Sie weder Django noch Flask verwenden, können Sie Segmente manuell erstellen. Sie können ein Segment für jede eingehende Anforderung erstellen. Wenn Sie auch Segmente um gepatchte HTTP- oderAWSSDK-Clients, um Kontext für den Recorder bereitzustellen, um Teilsegmente hinzuzufügen.

Beispiel main.py — Manuelle Instrumentierung

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

Konfiguration einer Segmentbenennungsstrategie

AWS X-Rayverwendet einService-Nameum Ihre Anwendung zu identifizieren und von den anderen Anwendungen, Datenbanken, externen APIs zu unterscheiden undAWS-Ressourcen, die Ihre Anwendung verwendet. Wenn das X-Ray SDK Segmente für eingehende Anfragen generiert, zeichnet es den Dienstnamen Ihrer Anwendung im Segment aufNamen-Feldaus.

Das X-Ray SDK kann Segmente nach dem Hostnamen im HTTP-Anforderungsheader benennen. Dieser Header kann jedoch gefälscht werden, was zu unerwarteten Knoten in Ihrer Service-Map führen kann. Um zu verhindern, dass das SDK Segmente aufgrund von Anforderungen mit gefälschten Host-Headern falsch benennt, müssen Sie einen Standardnamen für eingehende Anfragen angeben.

Wenn Ihre Anwendung Anfragen für mehrere Domänen bereitstellt, können Sie das SDK so konfigurieren, dass es eine dynamische Benennungsstrategie verwendet, die dies in Segmentnamen widerspiegelt. Eine dynamische Benennungsstrategie ermöglicht es dem SDK, den Hostnamen für Anfragen zu verwenden, die einem erwarteten Muster entsprechen, und den Standardnamen auf Anfragen anzuwenden, die dies nicht tun.

Beispielsweise haben Sie möglicherweise eine einzige Anwendung, die Anfragen an drei Subdomains verarbeitet.www.example.com,api.example.com, undstatic.example.comaus. Sie können eine dynamische Benennungsstrategie mit dem Muster verwenden*.example.comum Segmente für jede Subdomain mit einem anderen Namen zu identifizieren, was zu drei Serviceknoten auf der Service-Map führt. Wenn Ihre Anwendung Anfragen mit einem Hostnamen erhält, der nicht mit dem Muster übereinstimmt, wird auf der Service-Map ein vierter Knoten mit einem von Ihnen angegebenen Fallback-Namen angezeigt.

Wenn Sie denselben Namen für alle Anfragesegmente verwenden möchten, geben Sie bei der Konfiguration des Recorders den Namen Ihrer Anwendung, wie in den vorherigen Abschnitten gezeigt, ein.

Eine dynamische Benennungsstrategie definiert ein Muster, dem Hostnamen entsprechen sollten, sowie einen Standardnamen, der verwendet wird, wenn der Hostname in der HTTP-Anforderung nicht mit diesem Muster übereinstimmt. Zur dynamischen Segmentbenennung fügen Sie die DYNAMIC_NAMING-Einstellung zu Ihrer settings.py-Datei hinzu.

Beispiel settings.py - dynamische Benennung

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

Sie können "*" im Muster verwenden, um eine Übereinstimmung mit einer beliebigen Zeichenfolge zu erzielen, oder "?" für die Übereinstimmung mit einem einzelnen Zeichen. Für Flask konfigurieren Sie den Recorder im Code.

Beispiel main.py — Segmentname

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

Sie können den mit der AWS_XRAY_TRACING_NAME-Umgebungsvariablen in Code definierten standardmäßigen Dienstnamen überschreiben.