使用 Ruby 的 X-SDK Ray 將註釋和中繼資料新增至區段

您可以使用註釋和中繼資料記錄有關請求、環境或應用程式的其他資訊。您可以將註釋和中繼資料新增至 X-Ray SDK 建立的區段，或新增至您建立的自訂子區段。

註釋是與字符串，數字或布爾值鍵-值對。註釋會編製索引以與篩選器運算式搭配使用 使用註釋來記錄您要用來在主控台中分組追蹤的資料，或在呼叫 GetTraceSummariesAPI.

中繼資料是索引鍵-值配對，可以具有任何類型的值 (包括物件和清單)，但不會編製索引以用於篩選運算式。使用元數據記錄要存儲在跟踪中但不需要與搜索一起使用的其他數據。

除了註釋和中繼資料，您也可以在區段上記錄使用者 ID 字串。使用者IDs會記錄在區段上的個別欄位中，並建立索引以供搜尋使用。

使用紅寶石的 X-SDK Ray 記錄註釋

針對您想要建立索引以用於搜尋的區段或子區段，請使用標註來記錄這些區段上的資訊。

註釋要求

• 按鍵 — 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

將註釋SDK記錄為段文檔中的對annotations象中的鍵-值對。若使用相同鍵呼叫 add_annotations 兩次，則會覆寫之前在相同區段或子區段上記錄的值。

若要尋找具有特定值之註釋的繪線，請在篩選器運算式中使用annotation[key]關鍵字。

使用 X-Ray SDK 進行 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 兩次，則會覆寫之前在相同區段或子區段上記錄的值。

使用紅寶石IDs的 X-Ray SDK 記錄使用者

記錄請求區段IDs上的使用者，以識別傳送請求的使用者。

記錄使用者 IDs

1. 從 xray_recorder 取得目前區段的參考。

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

2. 將區段上的使用者欄位設為傳送請求的使用者字串 ID。

   segment.user = 'U12345'

您可以在控制器中設定使用者，以在應用程式開始處理請求時馬上記錄使用者 ID。

若要尋找使用者 ID 的追蹤，請在篩選器運算式中使用user關鍵字。