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

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

您可以使用 X-Ray 开发工具包,跟踪您的应用程序在 Amazon EC2、AWS Elastic Beanstalk 或 Amazon ECS 中的 EC2 实例上提供服务的传入 HTTP 请求。

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

每个段都有在服务地图中标识您的应用程序的名称。可以静态命名段,也可将 SDK 配置为基于传入请求中的主机标头动态命名段。通过动态命名,您可根据请求中的域名对跟踪进行分组,并在名称与预期模式 (例如,如果主机标头是伪造的) 不匹配时应用默认名称。

转发的请求

如果负载均衡器或者其他中介向您的应用程序转发了请求,则 X-Ray 会从请求的 X-Forwarded-For 标头中提取客户端 IP,而不是从 IP 数据包中的源 IP 提取。为转发的请求记录的客户端 IP 可以伪造,所以不应该信任。

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

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

  • HTTP 方法 – GET、POST、PUT、DELETE 等。

  • 客户端地址 – 发送请求的客户端的 IP 地址。

  • 响应代码 – 已完成请求的 HTTP 响应代码。

  • 时间 – 开始时间(收到请求时)和结束时间(发送响应时)。

  • 用户代理 — 请求中的 user-agent

  • 内容长度 — 响应中的 content-length

使用 Rails 中间件

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

例 Gemfile - rails

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

要使用中间件,您还必须使用在服务地图中表示应用程序的名称来配置记录器

例 config/initializers/aws_xray.rb

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

手动分析代码

如果您未使用 Rails,请手动创建分段。您可以为每个传入请求创建一个分段,或围绕经修补的 HTTP 或 AWS 开发工具包客户端创建分段以便为记录器提供上下文来添加子分段。

# 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

配置分段命名策略

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

X-Ray 开发工具包可以 HTTP 请求标头中的主机名为分段命名。但是,此标头可伪造,这可能导致您的服务地图中出现意外节点。为防止对伪造的主机标头的请求导致 SDK 不正确地命名分段,您必须为传入请求指定默认名称。

如果您的应用程序处理对多个域的请求,您可以将开发工具包配置为使用动态命名策略以在分段名称中反映此行为。通过动态命名策略,开发工具包可将主机名用于与预期模式匹配的请求,并将默认名称应用于与预期模式不匹配的请求。

例如,您可能有一个处理对三个子域(www.example.comapi.example.comstatic.example.com)的请求的应用程序。您可以将动态命名策略用于模式 *.example.com 以使用不同的名称标识每个子域的分段,从而在服务地图上生成三个服务节点。如果您的应用程序收到具有与该模式不匹配的主机名的请求,您将在服务地图上看到具有您指定的回退名称的第四个节点。

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

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

例 main.rb – 动态命名

config = { naming_pattern: '*mydomain*', name: 'my app', } XRay.recorder.configure(config)

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

注意

您可以使用 AWS_XRAY_TRACING_NAME 环境变量覆盖您在代码中定义的默认服务名称。