Fügen Sie mit X-Ray SDK für Python Anmerkungen und Metadaten zu Segmenten hinzu

Sie können zusätzliche Informationen über Anfragen, die Umgebung oder Ihre Anwendung mit Anmerkungen und Metadaten aufzeichnen. Sie können Anmerkungen und Metadaten zu den Segmenten hinzufügen, die X-Ray SDK erstellt, oder zu benutzerdefinierten Untersegmenten, die Sie erstellen.

Anmerkungen sind Schlüssel-Wert-Paare mit Zeichenfolgen-, Zahlen- oder booleschen Werten. Anmerkungen sind für die Verwendung mit Filterausdrücken indexiert. Verwenden Sie Anmerkungen, um Daten aufzuzeichnen, die Sie zum Gruppieren von Traces in der Konsole oder beim Aufrufen von verwenden möchten. GetTraceSummariesAPI

Metadaten sind Schlüssel-Wert-Paare, die Werte beliebigen Typs enthalten können, einschließlich Objekte und Listen, aber nicht für die Verwendung mit Filterausdrücken indexiert sind. Verwenden Sie Metadaten, um zusätzliche Daten aufzuzeichnen, die Sie im Trace speichern möchten, aber nicht für die Suche verwenden müssen.

Zusätzlich zu Anmerkungen und Metadaten können Sie auch Benutzer-ID-Zeichenfolgen in Segmenten aufzeichnen. Benutzer IDs werden in einem separaten Feld in Segmenten aufgezeichnet und für die Verwendung bei der Suche indexiert.

Anmerkungen mit dem X-Ray SDK für Python aufnehmen

Verwenden Sie Anmerkungen, um Informationen zu Segmenten oder Untersegmenten, die zur Suche indiziert werden sollten, aufzuzeichnen.

Anmerkung zu Anforderungen

• Schlüssel — Der Schlüssel für eine X-Ray-Anmerkung kann bis zu 500 alphanumerische Zeichen enthalten. Sie können keine anderen Leerzeichen oder Symbole als einen Punkt oder Punkt (.) verwenden

• Werte — Der Wert für eine X-Ray-Anmerkung kann bis zu 1.000 Unicode-Zeichen enthalten.

• Die Anzahl der Anmerkungen — Sie können bis zu 50 Anmerkungen pro Spur verwenden.

So zeichnen Sie Anmerkungen auf

1. Eine Referenz des aktuellen Segments oder Untersegments finden Sie unter xray_recorder.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

   or

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_subsegment()

2. Rufen Sie put_annotation mit einem Aktivierungsschlüssel und einem booleschen Wert oder einem Zeichenfolgenwert auf.

   document.put_annotation("mykey", "my value");

   Das folgende Beispiel zeigt, wie Sie putAnnotation mit einem String-Schlüssel aufrufen, der einen Punkt und einen booleschen Wert, eine Zahl oder einen String-Wert enthält.

   document.putAnnotation("testkey.test", "my value");

Alternativ können Sie auch die put_annotation-Methode im xray_recorder verwenden. Mit dieser Methode werden Anmerkungen zum aktuellen Untersegment oder zum Segment aufgezeichnet, wenn kein Untersegment geöffnet ist.

xray_recorder.put_annotation("mykey", "my value");

Das SDK zeichnet Anmerkungen als Schlüssel-Wert-Paare in einem annotations Objekt im Segmentdokument auf. Wenn put_annotation zweimal mit demselben Schlüssel aufgerufen wird, werden zuvor aufgezeichnete Werte im gleichen Segment oder Untersegment überschrieben.

Nutzen Sie das annotation[key]-Schlüsselwort in einem Filterausdruck, um Ablaufverfolgungen durch Anmerkungen mit bestimmten Werten zu finden.

Metadaten mit dem X-Ray SDK für Python aufnehmen

Verwenden Sie Metadaten, um Segment- oder Untersegmentinformationen aufzuzeichnen, die nicht zur Suche indiziert werden müssen. Bei Metadatenwerten kann es sich um Zeichenketten, Zahlen, Boolesche Werte oder beliebige Objekte handeln, die in ein JSON Objekt oder Array serialisiert werden können.

So zeichnen Sie Metadaten auf

1. Eine Referenz des aktuellen Segments oder Untersegments finden Sie unter xray_recorder.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

   or

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_subsegment()

2. Rufen Sie put_metadata mit einem Zeichenfolgenschlüssel, einem booleschen Wert, einer Zahl, einer Zeichenfolge oder einem Objektwert und einem Zeichenfolgen-Namespace auf.

   document.put_metadata("my key", "my value", "my namespace");

   or

   Rufen Sie put_metadata nur mit einem Aktivierungsschlüssel und einem Wert auf.

   document.put_metadata("my key", "my value");

Alternativ können Sie auch die put_metadata-Methode im xray_recorder verwenden. Mit dieser Methode werden Metadaten zum aktuellen Untersegment oder zum Segment aufgezeichnet, wenn kein Untersegment geöffnet ist.

xray_recorder.put_metadata("my key", "my value");

Wenn Sie keinen Namespace angeben, verwendet der. SDK default Wenn put_metadata zweimal mit demselben Schlüssel aufgerufen wird, werden zuvor aufgezeichnete Werte im gleichen Segment oder Untersegment überschrieben.

Benutzer IDs mit dem X-Ray SDK für Python aufnehmen

Zeichnen Sie Segmente von Benutzern IDs auf Anfrage auf, um den Benutzer zu identifizieren, der die Anfrage gesendet hat.

Um den Benutzer aufzuzeichnen IDs

1. Eine Referenz des aktuellen Segments finden Sie unter xray_recorder.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

2. Rufen Sie setUser mit einer Zeichenfolgen-ID des Benutzers auf, der die Anforderung gesendet hat.

   document.set_user("U12345");

Sie können set_user in Ihrem Controller aufrufen, um die Benutzer-ID aufzuzeichnen, sobald die Anwendung mit der Bearbeitung einer Anfrage beginnt.

Nutzen Sie das user-Schlüsselwort in einem Filterausdruck, um Ablaufverfolgungen einer Benutzer-ID zu finden.