适用于 Go 的 AWS X-Ray 开发工具包 - AWS X-Ray
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

适用于 Go 的 AWS X-Ray 开发工具包

X-Ray SDK for Go是一组面向 Go 应用程序的库,可提供类和方法来生成跟踪数据并将跟踪数据发送给 X-Ray 守护程序。跟踪数据包括由应用程序提供服务的传入 HTTP 请求的相关信息,以及应用程序使用 AWS 开发工具包、HTTP 客户端或 SQL 数据库连接器对下游服务进行的调用。您还可以手动创建分段并在注释和元数据中添加调试信息。

使用 go getGitHub 存储库下载开发工具包:

$ go get -u github.com/aws/aws-xray-sdk-go/...

对于 Web 应用程序,首先使用 xray.Handler 功能跟踪传入请求。消息处理程序为每个被跟踪的请求创建一个分段并在发送响应时完成该分段。当分段打开时,您可以使用开发工具包客户端的方法将信息添加到分段,并创建子分段以跟踪下游调用。开发工具包还会自动记录在分段打开时应用程序引发的异常。

对于由已分析应用程序或服务调用的 Lambda 函数,Lambda 自动读取跟踪标头并跟踪采样的请求。对于其他函数,您可以配置 Lambda 以采样和跟踪传入请求。无论哪种情况,Lambda 都会创建分段并将其提供给 X-Ray 开发工具包。

注意

在 Lambda 上,X-Ray 开发工具包是可选的。如果您不将它用于您的函数,则您的服务地图仍将为 Lambda 服务包含节点,每个 Lambda 函数各一个。通过添加开发工具包,您可以分析您的函数代码,以将子分段添加到 Lambda 所记录的函数分段。请参阅 AWS Lambda 和 AWS X-Ray 以了解更多信息。

接下来,使用对 AWS 函数的调用包装您的客户端。此步骤可确保 X-Ray 分析对任何客户端方法的调用。您还可以分析对 SQL 数据库的调用

在开始使用开发工具包后,通过配置记录器和中间件来自定义其行为。您可以添加插件来记录有关应用程序上运行的计算资源的数据,通过定义采样规则来自定义采样行为,设置日志级别以在应用程序日志中查看来自开发工具包的更多或更少的信息。

记录有关请求以及应用程序在注释和元数据中所做的工作的其他信息。注释是简单的键值对,已为这些键值对编制索引以用于筛选条件表达式,以便您能够搜索包含特定数据的跟踪。元数据条目的限制性较低,并且可以记录整个对象和数组 — 可序列化为 JSON 的任何项目。

注释和元数据

注释和元数据是您用 X-Ray 开发工具包添加到分段中的任意文本。会对注释编制索引,用于与筛选表达式一同使用。不会对元数据编制索引,但是可以在原始分段中通过 X-Ray 控制台或 API 查看。您授予对 X-Ray 读取权限的人都可以查看此数据。

当代码中具有大量分析的客户端时,一个请求分段可包含大量子分段,分析的客户端发起的每个调用均对应一个子分段。您可以通过将客户端调用包含在自定义子分段中来整理子分段并为其分组。您可以为整个函数或任何代码部分创建自定义子分段,并记录子分段的元数据和注释,而不是编写父分段的所有内容。

要求

X-Ray SDK for Go需要 Go 1.7 或更高版本。

开发工具包在编译和运行时依赖于以下库:

  • 适用于 Go 的 AWS 开发工具包版本 1.10.0 或更新版本

这些依赖项在开发工具包的 README.md 文件中声明。

参考文档

在下载开发工具包后,本地构建和托管文档以便在 Web 浏览器中查看文档。

查看参考文档

  1. 导航到 $GOPATH/src/github.com/aws/aws-xray-sdk-go (Linux 或 Mac) 目录或 %GOPATH%\src\github.com\aws\aws-xray-sdk-go (Windows) 文件夹

  2. 运行 godoc 命令。

    $ godoc -http=:6060
  3. 打开浏览器,定位到 http://localhost:6060/pkg/github.com/aws/aws-xray-sdk-go/