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

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

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

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

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

X-Ray SDK for Goを使用して注釈を記録する

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

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


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

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

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

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

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


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

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

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


import (
  "context"
  "github.com/aws/aws-xray-sdk-go/xray"
)

mySegment := xray.GetSegment(context)

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

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

カスタムサブセグメント

によるインストゥルメンテーション Java