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

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

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

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

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

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

X-Ray のすべての注釈には、以下が必要です。

注釈の要件

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

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

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

AWS Lambda 関数の外部に注釈を記録するには

1. AWSXRayRecorder のインスタンスを取得します。

   using Amazon.XRay.Recorder.Core;
   ...
   AWSXRayRecorder recorder = AWSXRayRecorder.Instance;

2. 文字列キー、およびブール値、Int32、Int64、Double、文字列値を使用して addAnnotation を呼び出します。

   recorder.AddAnnotation("mykey", "my value");

   次の例は、ドット、ブール値、数値、または文字列値を含む文字列キーputAnnotationを使用して を呼び出す方法を示しています。

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

AWS Lambda 関数内に注釈を記録するには

Lambda 関数内のセグメントとサブセグメントの両方が Lambda ランタイム環境によって管理されます。Lambda 関数内のセグメントまたはサブセグメントに注釈を追加する場合は、次の操作を行う必要があります。

1. Lambda 関数内にセグメントまたはサブセグメントを作成します。

2. セグメントまたはサブセグメントに注釈を追加します。

3. セグメントまたはサブセグメントを終了します。

次のコード例は、Lambda 関数内のサブセグメントに注釈を追加する方法を示しています。

#Create the subsegment
AWSXRayRecorder.Instance.BeginSubsegment("custom method");
#Add an annotation
AWSXRayRecorder.Instance.AddAnnotation("My", "Annotation");
try
{
  YourProcess(); #Your function
}
catch (Exception e)
{
  AWSXRayRecorder.Instance.AddException(e);
}
finally #End the subsegment
{
  AWSXRayRecorder.Instance.EndSubsegment();
}

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

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

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

メタデータを使用して、検索内で使用するためにインデックスを作成する必要がないセグメントまたはサブセグメントの情報を記録します。メタデータ値は、文字列、数値、ブール値、またはオブジェクトや配列にシリアル化できるその他のJSONオブジェクトです。

メタデータを記録するには

1. 次のコード例に示すようにAWSXRayRecorder、 のインスタンスを取得します。

   using Amazon.XRay.Recorder.Core;
   ...
   AWSXRayRecorder recorder = AWSXRayRecorder.Instance;

2. 次のコード例に示すように、AddMetadata文字列名前空間、文字列キー、およびオブジェクト値を使用して を呼び出します。

   recorder.AddMetadata("my namespace", "my key", "my value");

   次のコード例に示すように、キーと値のペアのみを使用して AddMetadataオペレーションを呼び出すこともできます。

   recorder.AddMetadata("my key", "my value");

名前空間の値を指定しない場合、X-Ray は SDKを使用しますdefault。同じキーで AddMetadataオペレーションを 2 回呼び出すと、同じセグメントまたはサブセグメントで以前に記録された値が上書きされます。