使用适用于 Ruby 中间件的 X-Ray 开发工具包跟踪传入请求

您可以使用 X-Ray SDK 来跟踪您的应用程序在 Amazon EC2 或 Amazon ECS 的 EC2 实例上提供的 Amazon Elastic Beanstalk传入 HTTP 请求。

如果您使用的是 Rails，请使用 Rails 中间件检测传入 HTTP 请求。在您将中间件添加到应用程序并配置分段名称时，适用于 Ruby 的 X-Ray 开发工具包会为每个采样请求创建一个分段。由其他检测创建的任何分段成为请求级别分段的子分段，请求级别的分段提供有关 HTTP 请求和响应的信息。此信息包括请求的计时、方法和处置。

每个分段都有一个名称，用于在服务映射中标识您的应用程序。可以静态命名分段，也可以将开发工具包配置为根据传入请求中的主机标头对其进行动态命名。动态命名允许根据请求中的域名对跟踪进行分组，并且在名称不匹配预期模式时（例如，如果主机标头是伪造的）应用默认名称。

在转发请求时，开发工具包在分段中设置附加字段来指示此行为。如果分段包含设置为 x_forwarded_for 的字段 true，则从 HTTP 请求的 X-Forwarded-For 标头获取客户端 IP。

中间件使用包含以下信息的 http 块为每个传入请求创建一个分段：

使用 Rails 中间件

要使用中间件，请将 gemfile 更新为包含所需的 railtie。

gem 'aws-xray-sdk', require: ['aws-xray-sdk/facets/rails/railtie']

要使用中间件，还必须为记录器配置一个在跟踪图中代表应用程序的名称。

Rails.application.config.xray = {
  name: 'my app'
}

手动检测代码

如果您未使用 Rails，请手动创建分段。您可以为每个传入的请求创建区段，也可以围绕已修补的 HTTP 或 Amazon SDK 客户端创建区段，为录制器添加子分段提供上下文。

# Start a segment
segment = XRay.recorder.begin_segment 'my_service'
# Start a subsegment
subsegment = XRay.recorder.begin_subsegment 'outbound_call', namespace: 'remote'

# Add metadata or annotation here if necessary
my_annotations = {
  k1: 'v1',
  k2: 1024
}
segment.annotations.update my_annotations

# Add metadata to default namespace
subsegment.metadata[:k1] = 'v1'

# Set user for the segment (subsegment is not supported)
segment.user = 'my_name'

# End segment/subsegment
XRay.recorder.end_subsegment
XRay.recorder.end_segment

配置分段命名策略

Amazon X-Ray 使用服务名称来标识您的应用程序，并将其与您的应用程序使用的其他应用程序、数据库、外部 API 和 Amazon 资源区分开来。当 X-Ray 开发工具包为传入请求生成分段时，会将应用程序的服务名称记录在分段的名称字段中。

X-Ray 开发工具包可以用在 HTTP 请求标头中的 hostname 来命名分段。不过，此标头可以伪造，会导致服务地图中出现意料之外的节点。为防止开发工具包由于包含伪造的主机标头的请求而错误地命名分段，必须为传入请求指定一个默认名称。

如果应用程序为多个域的请求提供服务，则可以将开发工具包配置为使用动态命名策略以在分段名称中反映出这一点。动态命名策略允许开发工具包将主机名用于符合预期模式的请求，并将默认名称应用于不符合预期模式的请求。

例如，可能有一款应用程序为发送到三个子域的请求提供服务，分别为 www.example.com、api.example.com 和 static.example.com。可以使用格式 *.example.com 的动态命名策略以识别包含不同名称的子域的分段，服务地图上因此会显示三个服务节点。如果应用程序收到包含与该格式不匹配的 hostname 的请求，您将会在服务地图上看到第四个节点，以及您指定的回退名称。

要对所有请求分段使用相同名称，请在配置记录器时指定应用程序的名称，如前几节所示。

动态命名策略定义一个主机名应匹配的模式和一个在 HTTP 请求中的主机名与该模式不匹配时要使用的默认名称。要动态命名分段，请在 config 哈希中指定命名模式。

config = {
  naming_pattern: '*mydomain*',
  name: 'my app',
}

XRay.recorder.configure(config)

您可以在模式中使用“*”来匹配任何字符串，或使用“?”来匹配任意单个字符。