使用SDK适用于 Ruby 的 X-Ray 为区段添加注释和元数据

可以利用注释和元数据记录与请求、环境或应用程序相关的其他信息。您可以向 X-Ray 创建的区段或您SDK创建的自定义子分段添加注释和元数据。

注释是带字符串、数字或布尔值的键值对。系统会对注释编制索引，以便与筛选表达式一起使用。使用注解来记录要用于在控制台中或在调用时对跟踪进行分组的数据GetTraceSummariesAPI。

元数据是可以具有任何类型值的键-值对，包括对象和列表，但没有编制索引，无法与筛选条件表达式一起使用。使用元数据记录要存储在跟踪中但不需要用于搜索跟踪的其他数据。

除了注释和元数据之外，您还可以在分段上记录用户 ID 字符串。用户IDs被记录在区段的单独字段中，并编制索引以供搜索使用。

使用SDK适用于 Ruby 的 X-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]筛选表达式中使用 关键字。

使用SDK适用于 Ruby 的 X-Ray 录制元数据

使用元数据记录有关您无需为其编制索引以进行搜索的分段或子分段的信息。元数据值可以是字符串、数字、布尔值或任何可以序列化为对象或数组的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 将覆盖同一分段或子分段上之前记录的值。

使用SDK适用于 Rub IDs y 的 X-Ray 录制用户

记录请求细分中的用户，以识别发送请求的用户。IDs

要记录用户 IDs

1. 从 xray_recorder 获取对当前分段的引用。

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

2. 将分段上的用户字段设置为发送请求的用户的字符串 ID。

   segment.user = 'U12345'

您可以在控制器中设置用户以便在应用程序开始处理请求后立即记录用户 ID。

要查找用户 ID 的跟踪，请在user筛选表达式中使用 关键字。