Konfigurieren von -Samplingregeln

Sie können die AWS X-Ray Konsole verwenden, um Samplingregeln für Ihre Services zu konfigurieren. Das X-Ray-SDK und AWS-Services , die aktives Tracing mit Sampling-Konfiguration unterstützen, verwenden Sampling-Regeln, um zu bestimmen, welche Anforderungen aufgezeichnet werden sollen.

Konfigurieren von -Samplingregeln

Sie können Sampling für die folgenden Anwendungsfälle konfigurieren:

• API Gateway Entrypoint – API Gateway unterstützt Sampling und aktives Tracing. Informationen zum Aktivieren der aktiven Ablaufverfolgung für eine API-Stufe finden Sie unter Unterstützung für aktives Amazon API Gateway-Tracing für AWS X-Ray.

• AWS AppSync – AWS AppSync unterstützt Sampling und aktives Tracing. Informationen zum Aktivieren der aktiven Ablaufverfolgung für AWS AppSync -Anforderungen finden Sie unter Ablaufverfolgung mit AWS X-Ray.

• Instrument X-Ray SDK auf Datenverarbeitungsplattformen – Bei Verwendung von Datenverarbeitungsplattformen wie Amazon EC2, Amazon ECS oder wird das Sampling unterstützt AWS Elastic Beanstalk, wenn die Anwendung mit dem neuesten X-Ray SDK instrumentiert wurde.

Anpassen von Samplingregeln

Durch die Anpassung von Samplingregeln können Sie die Menge der Daten steuern, die Sie aufzeichnen. Sie können das Sampling-Verhalten auch ändern, ohne Ihren Code zu ändern oder erneut bereitzustellen. Samplingregeln teilen dem X-Ray-SDK mit, wie viele Anforderungen für einen Satz von Kriterien aufgezeichnet werden sollen. Standardmäßig zeichnet das X-Ray-SDK die erste Anfrage pro Sekunde und fünf Prozent aller zusätzlichen Anfragen auf. Eine Anfrage pro Sekunde ist das Reservoir. Dadurch wird sichergestellt, dass jede Sekunde mindestens eine Ablaufverfolgung aufgezeichnet wird, solange der Dienst Anfragen verarbeitet. Fünf Prozent ist die Rate, mit der die über die Reservoirgröße hinausgehenden Anforderungen geprüft werden.

Sie können das X-Ray-SDK so konfigurieren, dass Samplingregeln aus einem JSON-Dokument gelesen werden, das Sie Ihrem Code hinzufügen. Wenn Sie jedoch mehrere Instances Ihres Services ausführen, führt jede Instance das Sampling unabhängig aus. Dies bewirkt, dass sich der Gesamtprozentsatz der geprüften Anforderungen erhöht, da die Reservoirs aller Instances effektiv zusammengezählt werden. Um lokale Samplingregeln zu aktualisieren, müssen Sie Ihren Code erneut bereitstellen.

Durch die Definition von Samplingregeln in der X-Ray-Konsole und die Konfiguration des SDK zum Lesen von Regeln aus dem X-Ray-Service können Sie diese beiden Probleme vermeiden. Der Service verwaltet die Reservoirs für jede Regel und weist jeder Instance Ihres Services Kontingente zu, um das Reservoir gleichmäßig zu verteilen, basierend auf der Anzahl der Instances, die ausgeführt werden. Das Reservoir-Limit wird gemäß den von Ihnen festgelegten Regeln berechnet. Da die Regeln im Service konfiguriert sind, können Sie Regeln verwalten, ohne zusätzliche Bereitstellungen durchzuführen.

Anmerkung

X-Ray verwendet bei der Anwendung von Samplingregeln einen Best-Effort-Ansatz, und in einigen Fällen stimmt die effektive Sampling-Rate möglicherweise nicht genau mit den konfigurierten Sampling-Regeln überein. Im Laufe der Zeit sollte die Anzahl der Stichprobenanforderungen jedoch nahe dem konfigurierten Prozentsatz liegen.

Sie können jetzt X-Ray-Samplingregeln in der Amazon- CloudWatch Konsole konfigurieren. Sie können auch weiterhin die X-Ray-Konsole verwenden.

CloudWatch console

So konfigurieren Sie Samplingregeln in der CloudWatch Konsole

1. Melden Sie sich bei der an AWS Management Console und öffnen Sie die - CloudWatch Konsole unter https://console.aws.amazon.com/cloudwatch/.

2. Wählen Sie im linken Navigationsbereich Einstellungen aus.

3. Wählen Sie unter Samplingregeln im Abschnitt X-Ray-Ablaufverfolgungen die Option Einstellungen anzeigen aus.

4. Um eine Regel zu erstellen, wählen Sie Create sampling rule (Samplingregel erstellen) aus.

   Um eine Regel zu bearbeiten, wählen Sie eine Regel aus und klicken Sie auf Bearbeiten, um sie zu bearbeiten.

   Um eine Regel zu löschen, wählen Sie eine Regel aus und klicken Sie auf Löschen, um sie zu löschen.

X-Ray console

So konfigurieren Sie Samplingregeln in der X-Ray-Konsole

1. Öffnen Sie die X-Ray-Konsole .

2. Wählen Sie im linken Navigationsbereich Sampling aus.

3. Um eine Regel zu erstellen, wählen Sie Create sampling rule (Samplingregel erstellen) aus.

   Um eine Regel zu bearbeiten, wählen Sie den Namen einer Regel aus.

   Um eine Regel zu löschen, wählen Sie eine Regel aus und verwenden das Menü Actions (Aktionen), um diese zu löschen.

Optionen für Samplingregeln

Für jede Regel stehen folgende Optionen zur Verfügung. Für Zeichenfolgenwerte können Platzhalter verwendet werden, um einem einzelnen Zeichen (?) oder null oder mehreren Zeichen (*) zu entsprechen.

Optionen für Samplingregeln

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

• Priorität (Ganzzahl zwischen 1 und 9999) – Die Priorität der Sampling-Regel. 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 Anforderungen an das Gerät pro Sekunde, bevor die feste Rate angewendet wird. Das Reservoir wird nicht direkt von Services verwendet, sondern gilt für alle Services, die die Regel gemeinsam verwenden.

• Rate (Ganzzahl zwischen 0 und 100) – Der Prozentsatz der übereinstimmenden Anfragen an das Gerät, nachdem das Reservoir erschöpft ist. Wählen Sie beim Konfigurieren einer Samplingregel in der Konsole einen Prozentsatz zwischen 0 und 100 aus. Geben Sie bei der Konfiguration einer Samplingregel in einem Client-SDK mithilfe eines JSON-Dokuments einen Prozentwert zwischen 0 und 1 an.

• Servicename (Zeichenfolge) – Der Name des instrumentierten Services, wie er in der Ablaufverfolgungszuordnung angezeigt wird.

  • X-Ray SDK – Der Servicename, den Sie auf dem Recorder konfigurieren.

  • Amazon API Gateway – api-name/stage.

• Servicetyp (Zeichenfolge) – Der Servicetyp, wie er in der Ablaufverfolgungszuordnung angezeigt wird. Legen Sie für das X-Ray-SDK den Servicetyp fest, indem Sie das entsprechende Plugin anwenden:

  • AWS::ElasticBeanstalk::Environment – Eine AWS Elastic Beanstalk Umgebung (Plugin).

  • AWS::EC2::Instance – Eine Amazon EC2-Instance (Plugin).

  • AWS::ECS::Container – Ein Amazon-ECS-Container (Plugin).

  • AWS::APIGateway::Stage – Eine Amazon API Gateway-Stufe.

  • AWS::AppSync::GraphQLAPI – Eine AWS AppSync API-Anforderung.

• Host (Zeichenfolge) – Der Hostname aus dem HTTP-Host-Header.

• HTTP-Methode (Zeichenfolge) – Die Methode der HTTP-Anforderung.

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

  • X-Ray SDK – Der Pfadteil der HTTP-Anforderungs-URL.

• Ressourcen-ARN (Zeichenfolge) – Der ARN der AWS Ressource, auf der der Service ausgeführt wird.

  • X-Ray SDK – nicht unterstützt. Das SDK kann nur Regeln verwenden, bei denen der Ressourcen-ARN auf * festgelegt ist.

  • Amazon API Gateway – Der Stufen-ARN.

• (Optional) Attribute (Schlüssel und Wert) – Segmentattribute, die bei der Entscheidung über das Sampling bekannt sind.

  • X-Ray SDK – nicht unterstützt. Das SDK ignoriert Regeln, die Attribute angeben.

  • Amazon API Gateway – Header aus der ursprünglichen HTTP-Anforderung.

Beispiele für Samplingregeln

Beispiel – Standardregel ohne Reservoir und mit niedriger Rate

Sie können das Reservoir und die Rate der Standardregel ändern. Die Standardregel gilt für alle Anforderungen, die nicht mit einer anderen Regel übereinstimmen.

• Reservoir 0:

• Rate : 5 (0.05, wenn mit einem JSON-Dokument konfiguriert)

Beispiel – Debugging-Regel zum Nachverfolgen aller Anforderungen für eine problematische Route

Eine Regel mit hoher Priorität, die vorübergehend für das Debuggen angewendet wird.

• Regelname: DEBUG – history updates

• Priorität: 1

• Reservoir 1:

• Rate : 100 (1, wenn mit einem JSON-Dokument konfiguriert)

• Servicename: Scorekeep

• Service type (Servicetyp): *

• Host *:

• HTTP-Methode: PUT

• URL-Pfad: /history/*

• Ressourcen-ARN: *

Beispiel – Höhere Mindestrate für POSTs

• Regelname: POST minimum

• Priorität: 100

• Reservoir 10:

• Rate : 10 (.1, wenn mit einem JSON-Dokument konfiguriert)

• Servicename: *

• Service type (Servicetyp): *

• Host *:

• HTTP-Methode: POST

• URL-Pfad: *

• Ressourcen-ARN: *

Konfigurieren Ihres Service für die Verwendung von Samplingregeln

Das X-Ray-SDK erfordert eine zusätzliche Konfiguration, um Samplingregeln zu verwenden, die Sie in der Konsole konfigurieren. Im Konfigurationsthema finden Sie in Ihrer Sprache Einzelheiten zur Konfiguration einer Samplingstrategie:

• Java: Samplingregeln

• Go: Samplingregeln

• Node.js: Samplingregeln

• Python: Samplingregeln

• Ruby: Samplingregeln

• .NET: Samplingregeln

Informationen zu API Gateway finden Sie unter Unterstützung für aktives Amazon API Gateway-Tracing für AWS X-Ray.

Anzeigen von Samplingergebnissen

Auf der Sampling-Seite der X-Ray-Konsole werden detaillierte Informationen darüber angezeigt, wie Ihre Services die einzelnen Samplingregeln verwenden.

Die Spalte Trend zeigt, wie die Regel in den letzten paar Minuten verwendet wurde. Jede Spalte zeigt Statistiken für ein 10-Sekunden-Fenster an.

Samplingstatistiken

• Übereinstimmungsregel insgesamt: Die Anzahl der Anforderungen, die dieser Regel entsprachen. Diese Zahl umfasst keine Anforderungen, die mit dieser Regel übereingestimmt hätten, aber zuvor mit einer Regel mit höherer Priorität übereingestimmt haben.

• Insgesamt Stichprobe: Die Anzahl der aufgezeichneten Anforderungen.

• Stichprobe mit fester Rate: Die Anzahl der Anfragen, die durch Anwendung der festen Rate der Regel Stichproben gesammelt wurden.

• Stichprobe mit Reservoir-Limit: Die Anzahl der Anfragen, die mit einem von X-Ray zugewiesenen Kontingent Stichproben erstellt wurden.

• Aus dem Reservoir geliehen: Die Anzahl der Anfragen, die durch Ausleihen aus dem Reservoir erfasst wurden. Wenn ein Service zum ersten Mal eine Anforderung an eine Regel anordnet, wurde ihm noch kein Kontingent von X-Ray zugewiesen. Wenn das Reservoir jedoch mindestens 1 beträgt, leiht sich der Service eine Spur pro Sekunde aus, bis X-Ray ein Kontingent zuweist.

Weitere Informationen zu Samplingstatistiken und dazu, wie Services Samplingregeln verwenden, finden Sie unter Verwenden von Samplingregeln mit der X-Ray-API.

Nächste Schritte

Sie können die X-Ray-API verwenden, um Samplingregeln zu verwalten. Mit der API können Sie Regeln erstellen und aktualisieren, und zwar programmgesteuert nach einem Zeitplan oder als Reaktion auf Alarme oder Benachrichtigungen. Anleitungen und weitere Regelbeispiele finden Sie unter Konfigurieren von Sampling-, Gruppen- und Verschlüsselungseinstellungen mit der AWS X-Ray-API.

Das X-Ray-SDK und verwenden AWS-Services auch die X-Ray-API, um Samplingregeln zu lesen, Samplingergebnisse zu melden und Samplingziele abzurufen. Services müssen verfolgen, wie oft sie jede Regel anwenden, Regeln basierend auf der Priorität auswerten und sich aus dem Reservoir ausleihen, wenn eine Anforderung mit einer Regel übereinstimmt, für die X-Ray dem Service noch kein Kontingent zugewiesen hat. Weitere Informationen dazu, wie ein Service die API für das Sampling verwendet, finden Sie unter Verwenden von Samplingregeln mit der X-Ray-API.

Wenn das X-Ray-SDK Sampling-APIs aufruft, verwendet es den X-Ray-Daemon als Proxy. Wenn Sie TCP-Port 2000 bereits verwenden, können Sie den Daemon so konfigurieren, dass er den Proxy auf einem anderen Port ausführt. Details dazu finden Sie unter Konfigurieren des AWS X-Ray Daemon.