Konfigurieren von AWS X-Ray-Samplingregeln für API-Gateway-APIs

Sie können die AWS X-Ray-Konsole oder das SDK verwenden, um Samplingregeln für Ihre Amazon-API-Gateway-API zu konfigurieren. Eine Samplingregel gibt an, welche Anforderungen X-Ray für Ihre API aufzeichnen soll. Durch das Anpassen von Samplingregeln können Sie die Menge der von Ihnen aufgezeichneten Daten steuern und das Stichprobenverhalten im laufenden Betrieb ändern, ohne Ihren Code ändern oder neu implementieren zu müssen.

Bevor Sie Ihre X-Ray-Samplingregeln festlegen, lesen Sie die folgenden Themen im X-Ray-Entwicklerhandbuch:

• Konfigurieren von Samplingregeln in der AWS X-Ray-Konsole

• Verwenden von Samplingregeln mit der X-Ray-API

Optionswerte der X-Ray-Samplingregeln für API Gateway-APIs

Die folgenden X-Ray-Samplingoptionen sind für API Gateway relevant. String-Werte können Platzhalter verwenden, um ein einzelnes Zeichen (?) Oder null oder mehr Zeichen (*) zu finden. Für weitere Details, einschließlich einer detaillierten Erklärung der Verwendung der Einstellungen Reservoir und Rate, finden Sie unter Konfigurieren von Samplingregeln in der AWS X-Ray-Konsole.

• Regelname (Zeichenfolge) – Ein eindeutiger Name für die Regel.

• Priorität (Ganzzahl zwischen 1 und 9999) – Die Priorität der Samplingregel. Services werten Regeln in aufsteigender Reihenfolge der Priorität aus und treffen eine Sampleentscheidung mit der ersten übereinstimmenden Regel.

• Reservoir (nicht negative Ganzzahl) – Eine feste Anzahl übereinstimmender Anfragen an das Gerät pro Sekunde vor Anwendung des festen Satzes. Das Reservoir wird nicht direkt von Services verwendet, sondern gilt für alle Services, die die Regel gemeinsam verwenden.

• Rate (Anzahl zwischen 0 und 100) – Der Prozentsatz der übereinstimmenden Anfragen an das Gerät, nachdem das Reservoir erschöpft ist.

• Servicename (Zeichenfolge) – Der API-Stufenname in Form von {api-name}/{stage-name}. Wenn Sie beispielsweise die PetStore-Beispiel-API für eine Stufe mit dem Namen test bereitstellen möchten, lautet der in der Samplingregel anzugebende Wert für Service Name (Servicename) pets/test.

• Servicetyp (Zeichenfolge) – Für eine API Gateway-API kann entweder AWS::ApiGateway::Stage oder AWS::ApiGateway::* angegeben werden.

• Host (Zeichenfolge) – Der Hostname aus dem HTTP-Host-Header. Setzen Sie dies auf *, um mit allen Hostnamen übereinzustimmen. Oder geben Sie einen vollständigen oder teilweisen Hostnamen an, z. B. api.example.com oder *.example.com.

• Ressourcen-ARN (Zeichenfolge) – Der ARN der API-Stufe, z. B. arn:aws:apigateway:region::/restapis/api-id/stages/stage-name.

  Der Stufenname kann von der Konsole oder der API Gateway-CLI oder -API abgerufen werden. Weitere Informationen zu ARN-Formaten finden Sie in der Allgemeinen Amazon Web Services-Referenz.

• HTTP-Methode (Zeichenfolge) – Die Methode, die gesampelt werden soll, z. B. GET.

• URL path (URL-Pfad) (Zeichenfolge) – Der URL-Pfad der Anforderung.

• (optional) Attribute (Schlüssel und Wert) – Header aus der ursprünglichen HTTP-Anforderung, z. B. Connection, Content-Length oder Content-Type. Jeder Attributwert kann bis zu 32 Zeichen lang sein.

Beispiele für X-Ray-Samplingregeln

Beispiel #1 für Samplingregeln

Diese Regel sampelt alle GET Anforderungen für die testxray API- test Stufe.

• Rule name (Regelname — test-sampling

• Priorität — 17

• Reservoirgröße — 10

• Bestimmtes Zeitintervall — 10

• Servicename — testxray/test

• Servicetyp – AWS::ApiGateway::Stage

• HTTP-Methode — GET

• Ressourcen-ARN – *

• Host — *

Beispiel #2 für Samplingregeln

Diese Regel sampelt alle Anforderungen für die testxray API in der prod-Stufe.

• Rule name (Regelname — prod-sampling

• Priorität — 478

• Reservoirgröße — 1

• Bestimmtes Zeitintervall — 60

• Servicename — testxray/prod

• Servicetyp – AWS::ApiGateway::Stage

• HTTP-Methode — *

• Ressourcen-ARN – *

• Host — *

• Attribute — {}