X-Ray SDK for Go を使用してセグメントに注釈とメタデータを追加する

リクエスト、環境、または注釈やメタデータを使用するアプリケーションに関する追加情報を記録できます。X-Ray がSDK作成するセグメント、または作成するカスタムサブセグメントに注釈とメタデータを追加できます。

注釈は文字列、数値、またはブール値を使用したキーと値のペアです。注釈は、フィルタ式用にインデックス付けされます。注釈を使用して、コンソールでトレースをグループ化するために使用するデータ、または GetTraceSummaries を呼び出すときに記録しますAPI。

メタデータは、オブジェクトとリストを含む、任意のタイプの値を持つことができるキーバリューのペアですが、フィルタ式に使用するためにインデックスは作成されません。メタデータを使用してトレースに保存する追加のデータを記録しますが、検索で使用する必要はありません。

注釈とメタデータに加えて、セグメントにユーザー ID 文字列を記録することもできます。ユーザーはセグメントの別のフィールドにIDs記録され、検索で使用するインデックスが付けられます。

X-Ray SDK for Go を使用した注釈の記録

注釈を使用して、検索用にインデックスを作成するセグメントに情報を記録します。

注釈の要件

• キー – X-Ray 注釈のキーには、最大 500 文字の英数字を使用できます。ドットまたはピリオド ( ) 以外のスペースまたは記号は使用できません。 ）

• 値 – X-Ray 注釈の値は、最大 1,000 文字の Unicode 文字を持つことができます。

• 注釈の数 — トレースごとに最大 50 個の注釈を使用できます。

注釈を記録するには、セグメントに関連付けるメタデータを含む文字列で AddAnnotation を呼び出します。

xray.AddAnnotation(key string, value interface{})

は、セグメントドキュメント内のannotationsオブジェクトのキーと値のペアとして注釈SDKを記録します。同じキーで AddAnnotation を 2 回呼び出すと、同じセグメントに以前記録された値が上書きされます。

特定の値を持つ注釈のあるトレースを見つけるには、annotation[key]フィルタ式の キーワードを使用します。

X-Ray SDK for Go を使用したメタデータの記録

メタデータを使用して、検索用にインデックスを作成する必要のないセグメントに情報を記録します。

メタデータを記録するには、セグメントに関連付けるメタデータを含む文字列で AddMetadata を呼び出します。

xray.AddMetadata(key string, value interface{})

X-Ray SDK for Go IDsを使用したユーザーの記録

リクエストセグメントIDsにユーザーを記録して、リクエストを送信したユーザーを特定します。

ユーザーを記録するには IDs

1. AWSXRay から現在のセグメントへの参照を取得します。

   import (
     "context"
     "github.com/aws/aws-xray-sdk-go/xray"
   )
   
   mySegment := xray.GetSegment(context)

2. リクエストを送信したユーザーの文字列 ID を使用して setUser を呼び出します。

   mySegment.User = "U12345"

ユーザー ID のトレースを見つけるには、userフィルタ式で、 キーワードを使用します。