使用适用于 Go 的 X-Ray 开发工具包向分段添加注释和元数据 - Amazon X-Ray
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

使用适用于 Go 的 X-Ray 开发工具包向分段添加注释和元数据

您可以使用记录有关请求、环境或应用程序的其他信息以及注释和元数据。您可以将注释和元数据添加到 X-Ray 开发工具包创建的分段或您创建的自定义子分段。

注释是带字符串、数字或布尔值的键-值对。注释编制索引,以便与筛选项表达式。使用注释记录要用于对控制台中的跟踪进行分组的数据或在调用 GetTraceSummaries API 时使用的数据。

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

除了注释和元数据之外,您还可以记录用户 ID 字符串分段。用户 ID 记录在分段的单独字段中,并且不会为其编制索引以用于搜索。

使用适用于 Go 的 X-Ray 开发工具包记录注

使用注释记录有关要为其编制索引以进行搜索的分段的信息。

注释要求

  • — 最多 500 个字母数字字符。无空格或符号,下划线除外。

  • — 最多 1000 个 Unicode 字符。

  • Entries— 每个跟踪最多 50 个注释。

要记录注释,请使用一个包含您要与分段关联的元数据的字符串来调用 AddAnnotation

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

开发工具包将注释以键-值对的形式记录在annotations对象中的区段文档。使用相同键调用两次 AddAnnotation 将覆盖同一分段上之前记录的值。

要查找具有带特定值的注释的跟踪,请在annotations.key筛选表达式中使用 关键字。

使用适用于 Go 的 X-Ray 开发工具包记录元

使用元数据记录有关您无需为其编制索引以进行搜索的分段的信息。

要记录元数据,请使用一个包含您要与分段关联的元数据的字符串来调用 AddMetadata

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

使用适用于 Go 的 X-Ray 开发工具包记录用户 ID

记录请求分段上的用户 ID 以标识发送请求的用户。

记录用户 ID

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

    import ( "context" "github.com/aws/aws-xray-sdk-go/xray" ) mySegment := xray.GetSegment(context)
  2. 使用发送请求的用户的字符串 ID 调用 setUser

    mySegment.User = "U12345"

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