Amazon X-Ray 适用于 Ruby 的 SDK

X-Ray 开发工具包是一个面向 Ruby Web 应用程序的库，该库提供用于生成跟踪数据并将其发送到 X-Ray 进程守护程序的类和方法。跟踪数据包括有关应用程序处理的传入 HTTP 请求的信息，以及应用程序使用 Amazon SDK、HTTP 客户端或活动记录客户端对下游服务进行的调用的信息。您还可以手动创建分段并在注释和元数据中添加调试信息。

您可以通过将开发工具包添加到 gemfile 并运行 bundle install 来下载开发工具包。

gem 'aws-sdk'

如果您使用了 Rails，请首先添加 X-Ray 开发工具包中间件来跟踪传入请求。请求筛选器将创建一个分段。当分段打开时，您可以使用开发工具包客户端的方法将信息添加到分段，并创建子分段以跟踪下游调用。开发工具包还会自动记录在分段打开时应用程序引发的异常。对于非 Rails 应用程序，您可以手动创建分段。

接下来，使用 X-Ray SDK 通过配置记录器来修补关联的库，从而检测您 Amazon SDK for Ruby的、HTTP 和 SQL 客户端。每当您使用已检测的客户端调用下游 Amazon Web Service 或资源时，SDK 都会在子分段中记录有关该调用的信息。 Amazon Web Services 您在服务中访问的资源将作为下游节点显示在跟踪地图上，以帮助您识别各个连接上的错误和限制问题。

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

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

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

有关开发工具包的类和方法的参考文档，请参阅适用于 Ruby API 的Amazon X-Ray 开发工具包参考。

要求

X-Ray 开发工具包需要 Ruby 2.3 或更高版本，并且与以下库兼容：