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

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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

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

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

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

转发的请求

如果负载均衡器或其他中介机构将请求转发到您的应用程序,则 X-Ray 会从X-Forwarded-For标头,而不是来自 IP 数据包中的源 IP。为转发请求记录的客户端 IP 可能是伪造的,因此不应该被信任。

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

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

  • HTTP method (HTTP 方法)— GET、POST、PUT、DELETE 等。

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

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

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

  • User agentuser-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 或AmazonSDK 客户端,为记录器添加子段提供上下文。

# 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 SDK 为传入请求生成数据段时,它会将应用程序的服务名称记录在数据段的名称字段名称

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

如果应用程序为多个域提供请求,则可以将 SDK 配置为使用动态命名策略在段名称中反映这一点。动态命名策略允许 SDK 对与预期模式匹配的请求使用主机名,并将默认名称应用于不匹配的请求。

例如,您可能有一个应用程序,为三个子域提供服务 —www.example.comapi.example.com, 和static.example.com。您可以将动态命名策略与模式*.example.com为每个子域标识具有不同名称的区段,从而在服务图上生成三个服务节点。如果您的应用程序收到的主机名与模式不匹配的请求,您将在服务映射上看到第四个节点,其中包含您指定的备用名称。

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

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

例 主 .rb — 动态命名

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

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

注意

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