Unterstützung für aktives Amazon API Gateway-Tracing für AWS X-Ray

Sie können X-Ray verwenden, um Benutzeranfragen zu verfolgen und zu analysieren, während sie über Ihre Amazon API Gateway-APIs zu den zugrunde liegenden Services gelangen. API Gateway unterstützt X-Ray-Ablaufverfolgung für alle API Gateway-Endpunkttypen: regional, Edge-optimiert und privat. Sie können X-Ray mit Amazon API Gateway in allen verwenden, in AWS-Regionen denen X-Ray verfügbar ist. Weitere Informationen finden Sie unter Verfolgen der API Gateway-API-Ausführung mit AWS X-Ray im Amazon API Gateway-Entwicklerhandbuch.

Anmerkung

X-Ray unterstützt nur die Nachverfolgung für REST-APIs über API Gateway.

Amazon API Gateway bietet Unterstützung für aktives Tracing für AWS X-Ray. Aktivieren Sie die aktive Nachverfolgung für Ihre API-Stufen, um eingehende Anfragen zu erfassen und Ablaufverfolgungen an X-Ray zu senden.

So aktivieren Sie die aktive Ablaufverfolgung auf einer API-Stufe

1. Öffnen Sie die API Gateway-Konsole unter https://console.aws.amazon.com/apigateway/.

2. Wählen Sie eine API aus.

3. Wählen Sie eine Stufe aus.

4. Wählen Sie auf der Registerkarte Protokolle/Ablaufverfolgung die Option X-Ray-Ablaufverfolgung aktivieren und dann Änderungen speichern aus.

5. Wählen Sie im Navigationsbereich links Resources (Ressourcen) aus.

6. Um die API mit den neuen Einstellungen erneut bereitzustellen, wählen Sie das Dropdown-Menü Aktionen und dann API bereitstellen aus.

API Gateway verwendet Samplingregeln, die Sie in der X-Ray-Konsole definieren, um zu bestimmen, welche Anforderungen aufgezeichnet werden sollen. Sie können Regeln erstellen, die nur für APIs oder gelten, die nur für Anforderungen gelten, die bestimmte Header enthalten. API Gateway zeichnet Header in Attributen im Segment zusammen mit Details zur Stufe und Anforderung auf. Weitere Informationen finden Sie unter Konfigurieren von -Samplingregeln.

Anmerkung

Bei der Nachverfolgung von REST-APIs mit API Gateway-HTTP-Integration wird der Servicename jedes Segments auf den Anforderungs-URL-Pfad von API Gateway zu Ihrem HTTP-Integrationsendpunkt festgelegt, was zu einem Serviceknoten auf der X-Ray-Ablaufverfolgungszuordnung für jeden eindeutigen URL-Pfad führt. Eine große Anzahl von URL-Pfaden kann dazu führen, dass die Ablaufverfolgungszuordnung das Limit von 10.000 Knoten überschreitet, was zu einem Fehler führt.

Um die Anzahl der von API Gateway erstellten Serviceknoten zu minimieren, sollten Sie Parameter innerhalb der URL-Abfragezeichenfolge oder im Anforderungstext über POST übergeben. Beide Ansätze stellen sicher, dass Parameter nicht Teil des URL-Pfads sind, was zu weniger unterschiedlichen URL-Pfaden und Serviceknoten führen kann.

Für alle eingehenden Anforderungen fügt API Gateway eingehenden HTTP-Anforderungen, die noch keinen haben, einen Ablaufverfolgungs-Header hinzu.

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793

X-Ray-Trace-ID-Format

Ein X-Ray trace_id besteht aus drei Zahlen, die durch Bindestriche getrennt sind. Beispiel: 1-58406520-a006649127e371903a2de979 Dies umfasst:

• Die Versionsnummer, 1.

• Die Uhrzeit der ursprünglichen Anforderung in Unix-Epochenzeit mit 8 Hexadezimalziffern.

  Beispielsweise beträgt 10:00 Uhr am 1. Dezember 2016 PST in der Epochenzeit 1480615200 Sekunden oder 58406520 Hexadezimalziffern.

• Eine global eindeutige 96-Bit-Kennung für die Ablaufverfolgung in 24 Hexadezimalziffern.

Wenn die aktive Ablaufverfolgung deaktiviert ist, zeichnet die Stufe dennoch ein Segment auf, wenn die Anforderung von einem Service stammt, der die Anforderung geprüft und eine Nachverfolgung gestartet hat. Beispielsweise kann eine instrumentierte Webanwendung eine API Gateway-API mit einem HTTP-Client aufrufen. Wenn Sie einen HTTP-Client mit dem X-Ray-SDK instrumentieren, fügt er der ausgehenden Anforderung einen Ablaufverfolgungs-Header hinzu, der die Sampling-Entscheidung enthält. API Gateway liest den Ablaufverfolgungs-Header und erstellt ein Segment für Stichprobenanforderungen.

Wenn Sie API Gateway verwenden, um ein Java-SDK für Ihre API zu generieren, können Sie den SDK-Client instrumentieren, indem Sie einen Anfrage-Handler mit dem Client-Builder hinzufügen, genauso wie Sie einen AWS SDK-Client manuell instrumentieren würden. Detaillierte Anweisungen finden Sie unter Nachverfolgen von AWS SDK-Aufrufen mit dem X-Ray SDK for Java.