使用适用于 Python 中间件的 X-Ray 开发工具包跟踪传入请求 - Amazon X-Ray
将中间件添加到应用程序 (Django)将中间件添加到应用程序 (Flask)将中间件添加到应用程序 (Bottle)手动分析 Python 代码配置分段命名策略
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 Amazon Web Services 服务入门。

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

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

在您将中间件添加到应用程序并配置分段名称时，适用于 Python 的 X-Ray 开发工具包会为每个采样请求创建一个分段。此分段包括 HTTP 请求的计时、方法和处置。其他分析会在此分段上创建子分段。

适用于 Python 的 X-Ray 软件开发工具包支持以下中间件来分析传入的 HTTP 请求：

  • Django

  • Flask

  • Bottle

注意

适用于Amazon Lambda函数时，Lambda 会为每个采样请求创建一个分段。参阅 Amazon Lambda 和 Amazon X-Ray 了解更多信息。

请参阅Worker以了解在 Lambda 中分析过的示例 Python 函数。

对于其他框架上的脚本或 Python 应用程序，您可以手动创建分段。

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

转发的请求

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

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

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

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

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

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

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

  • User agent—user-agent从请求中。

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

将中间件添加到应用程序 (Django)

将中间件添加到 MIDDLEWARE 文件中的 settings.py 列表。X-Ray 中间件应位于 settings.py 文件中的第一行，以确保在其他中间件失败的请求得到记录。

例 settings.py-适用于 Python 中间件的 X-Ray 软件开发工具包

MIDDLEWARE = [
    'aws_xray_sdk.ext.django.middleware.XRayMiddleware',
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware'
]

将 X-Ray 开发工具包添加到INSTALLED_APPS列出settings.py文件。这将允许在应用程序启动期间配置 X-Ray 记录仪。

例 settings.py-适用于 Python 的 Python Django 应用程序

INSTALLED_APPS = [
    'aws_xray_sdk.ext.django',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

在 settings.py 文件中配置分段名称。

例 settings.py — 分段名称

XRAY_RECORDER = {
    'AWS_XRAY_TRACING_NAME': 'My application',
    'PLUGINS': ('EC2Plugin'),
}

这告知 X-Ray 记录器使用默认采样率跟踪您的 Django 应用程序处理的请求。您可以在您的 Django 设置文件中配置记录器，以便应用自定义采样规则或更改其他设置。

将中间件添加到应用程序 (Flask)

要分析您的 Flask 应用程序，请先在 xray_recorder 上配置分段名称。然后，在代码中使用 XRayMiddleware 函数来修补您的 Flask 应用程序。

例 app.py

from aws_xray_sdk.core import xray_recorder
from aws_xray_sdk.ext.flask.middleware import XRayMiddleware

app = Flask(__name__)

xray_recorder.configure(service='My application')
XRayMiddleware(app, xray_recorder)

这告知 X-Ray 记录器使用默认采样率跟踪您的 Flask 应用程序处理的请求。您可以在代码中配置记录器，以便应用自定义采样规则或更改其他设置。

将中间件添加到应用程序 (Bottle)

要分析您的 Bottle 应用程序，请先在 xray_recorder 上配置分段名称。然后，在代码中使用 XRayMiddleware 函数来修补您的 Bottle 应用程序。

例 app.py

from aws_xray_sdk.core import xray_recorder
from aws_xray_sdk.ext.bottle.middleware import XRayMiddleware
 
app = Bottle()
 
xray_recorder.configure(service='fallback_name', dynamic_naming='My application')
app.install(XRayMiddleware(xray_recorder))

这告知 X-Ray 记录器使用默认采样率跟踪您的 Bottle 应用程序处理的请求。您可以在代码中配置记录器，以便应用自定义采样规则或更改其他设置。

手动分析 Python 代码

如果您不使用 Django 或 Flask，则可以手动创建分段。您可以为每个传入请求创建一个分段，或围绕经修补的 HTTP 或AmazonSDK 客户端，为记录器添加子段提供上下文。

例 main.py — 手动分析

from aws_xray_sdk.core import xray_recorder

# Start a segment
segment = xray_recorder.begin_segment('segment_name')
# Start a subsegment
subsegment = xray_recorder.begin_subsegment('subsegment_name')

# Add metadata and annotations
segment.put_metadata('key', dict, 'namespace')
subsegment.put_annotation('key', 'value')

# Close the subsegment and segment
xray_recorder.end_subsegment()
xray_recorder.end_segment()

配置分段命名策略

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

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

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

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

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

动态命名策略定义一个主机名应匹配的模式和一个在 HTTP 请求中的主机名与该模式不匹配时要使用的默认名称。要在 Django 中动态命名分段，请将 DYNAMIC_NAMING 设置添加到您的 settings.py 文件。

例 settings.py — 动态命名

XRAY_RECORDER = {
    'AUTO_INSTRUMENT': True,
    'AWS_XRAY_TRACING_NAME': 'My application',
    'DYNAMIC_NAMING': '*.example.com',
    'PLUGINS': ('ElasticBeanstalkPlugin', 'EC2Plugin')
}

您可以在模式中使用“*”来匹配任何字符串，或使用“?”来匹配任意单个字符。对于 Flask，在代码中配置记录器。

例 main.py — 分段名称

from aws_xray_sdk.core import xray_recorder
xray_recorder.configure(service='My application')
xray_recorder.configure(dynamic_naming='*.example.com')
注意

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