X-Ray SDK for Ruby を使用してセグメントに注釈とメタデータを追加する - AWS X-Ray
X-Ray SDK for Ruby を使用した注釈の記録X-Ray SDK for Ruby を使用したメタデータの記録X-Ray SDK for Ruby IDsでユーザーを記録する

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

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

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

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

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

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

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

注釈の要件

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

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

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

注釈を記録するには

  1. xray_recorder から現在のセグメントまたはサブセグメントの参照を取得します。

    require 'aws-xray-sdk'
...
document = XRay.recorder.current_segment

    または

    require 'aws-xray-sdk'
...
document = XRay.recorder.current_subsegment

  2. ハッシュ値を使って update を呼び出します。

    my_annotations = { id: 12345 }
document.annotations.update my_annotations

    以下は、ドットを含む注釈キーupdateを使用して を呼び出す方法を示す例です。

    my_annotations = { testkey.test: 12345 }
document.annotations.update my_annotations

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

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

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

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

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

  1. xray_recorder から現在のセグメントまたはサブセグメントの参照を取得します。

    require 'aws-xray-sdk'
...
document = XRay.recorder.current_segment

    または

    require 'aws-xray-sdk'
...
document = XRay.recorder.current_subsegment

  2. 文字列キー、ブール値、数値、文字列値、オブジェクト値、文字列名前空間を使用して metadata を呼び出します。

    my_metadata = {
  my_namespace: {
    key: 'value'
  }
}
subsegment.metadata my_metadata

同じキーで metadata を 2 回呼び出すと、同じセグメントまたはサブセグメントに以前記録された値が上書きされます。

X-Ray SDK for Ruby IDsでユーザーを記録する

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

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

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

    require 'aws-xray-sdk'
...
document = XRay.recorder.current_segment

  2. セグメントのユーザーフィールドを、リクエストを送信したユーザーの文字列 ID に設定します。

    segment.user = 'U12345'

コントローラーでユーザーを設定し、アプリケーションがリクエストの処理を開始するとすぐに、ユーザー ID を記録できます。

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