针对 AWS X-Ray 的 Amazon API Gateway 活动跟踪支持 - AWS X-Ray
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

针对 AWS X-Ray 的 Amazon API Gateway 活动跟踪支持

用户请求通过您的 Amazon API Gateway API 传输到底层服务时,您可以使用 X-Ray 来跟踪和分析用户请求。API 网关 支持针对所有 API 网关 终端节点类型进行 X-Ray 跟踪:区域、边缘优化和私有。借助 Amazon API Gateway,您可以在 X-Ray 可用的所有 AWS 区域使用 X-Ray。有关更多信息,请参阅《Amazon API Gateway 开发人员指南》中的使用 AWS X-Ray 监控 API 网关 API 执行

Amazon API Gateway 为 AWS X-Ray 提供活动跟踪支持。在 API 阶段启用活动跟踪以对传入请求进行采样,并将跟踪发送到 X-Ray。

在 API 阶段启用活动跟踪

  1. 通过以下网址打开 API 网关 控制台:https://console.amazonaws.cn/apigateway/

  2. 选择一个 API。

  3. 选择一个阶段。

  4. Logs/Tracing (日志/跟踪) 选项卡上,选择 Enable X-Ray Tracing (启用 X-Ray 跟踪)

  5. 选择左侧导航面板中的 Resources (资源)

  6. 要使用新设置重新部署 API,请依次选择 Actions (操作)Deploy API (部署 API)

API 网关 使用您在 X-Ray 控制台中定义的采样规则来确定要记录的请求。您可以创建仅适用于 API 的规则,或者仅适用于包含特定标题的请求的规则。API 网关 将记录分段上属性中的标头以及有关阶段和请求的详细信息。有关更多信息,请参阅在 X-Ray 控制台中配置采样规则

对于所有传入请求,API 网关 将跟踪标头添加到还没有跟踪标头的传入 HTTP 请求。

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793

跟踪 ID 格式

trace_id 由以连字符分隔的三组数字组成。例如:1-58406520-a006649127e371903a2de979。这包括:

  • 版本号,即 1

  • 原始请求的时间,采用 Unix 纪元时间,为 8 个十六进制数字

    例如,2016 年 12 月 1 日上午 10:00 (太平洋标准时间) 采用纪元时间为 1480615200,或者是十六进制数字 58406520

  • 跟踪的 96 位标识符,全局唯一,使用 24 个十六进制数字

如果禁用活动跟踪,则当请求来自采样请求并启动跟踪的服务时,阶段仍会记录分段。例如,已检测的 Web 应用程序可通过 HTTP 客户端调用 API 网关 API。当您使用 X-Ray 开发工具包检测 HTTP 客户端时,将向包含采样决策的传出请求添加跟踪标头。API 网关 将读取跟踪标头并为已采样的请求创建一个分段。

如果您使用 API 网关 为 API 生成 Java 开发工具包,则可以通过向客户端生成器添加一个请求处理程序来检测开发工具包客户端,这与您手动检测 AWS 开发工具包客户端的方式相同。有关说明,请参阅使用X-Ray SDK for Java跟踪 AWS 开发工具包调用