本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
使用X-Ray SDK for Go将注释和元数据添加到分段中
您可以记录有关请求、环境或具有注释和元数据的应用程序的其他信息。您可以向 X-Ray 开发工具包创建的分段或您创建的自定义子分段添加注释和元数据。
注释是带字符串、数字或布尔值的键值对。系统会对注释编制索引,以便与筛选表达式一起使用。使用注释记录要用于对控制台中的跟踪进行分组的数据或在调用 GetTraceSummaries
API 时使用的数据。
元数据是可以拥有有任意类型值的密钥值对,包括对象和列表,但未编制索引以便与筛选表达式一同使用。使用元数据记录要存储在跟踪中但不需要用于搜索的其他数据。
除了注释和元数据之外,您还可以在分段上记录用户 ID 字符串。用户 ID 记录在分段的单独字段中,并且不会为其编制索引以用于搜索。
使用X-Ray SDK for Go记录注释
使用注释记录有关要为其编制索引以进行搜索的分段的信息。
注释要求
-
密钥 – 最多 500 个字母数字字符。无空格或符号,下划线除外。
-
值 – 最多 1,000 个 Unicode 字符。
-
条目 – 每个跟踪最多 50 条注释。
要记录注释,请使用一个包含您要与分段关联的元数据的字符串来调用 AddAnnotation
。
xray.AddAnnotation(key string
, value interface{}
)
开发工具包将注释以键-值对的形式记录在分段文档的 annotations
对象中。使用相同键调用两次 AddAnnotation
将覆盖同一分段上之前记录的值。
要查找具有带特定值的注释的跟踪,请在筛选条件表达式中使用 annotations.
关键字。
key
使用X-Ray SDK for Go记录元数据
使用元数据记录有关您无需为其编制索引以进行搜索的分段的信息。
要记录元数据,请使用一个包含您要与分段关联的元数据的字符串来调用 AddMetadata
。
xray.AddMetadata(key string
, value interface{}
)
使用X-Ray SDK for Go记录用户 ID
记录请求分段上的用户 ID 以标识发送请求的用户。
记录用户 ID
-
从
AWSXRay
获取对当前分段的引用。import ( "context" "github.com/aws/aws-xray-sdk-go/xray" ) mySegment := xray.GetSegment(
context
) -
使用发送请求的用户的字符串 ID 调用
setUser
。mySegment.User = "
U12345
"
要查找用户 ID 的跟踪,请在筛选条件表达式中使用 user
关键字。