Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

借助 API Gateway 使用 AWS X-Ray 服务地图和跟踪视图

在本节中,您可以找到有关如何借助 API Gateway 使用 AWS X-Ray 服务映射和跟踪视图的详细信息。

有关服务地图和跟踪视图以及如何对其进行解析的详细信息,请参阅 AWS X-Ray 控制台

示例 X-Ray 服务地图

AWS X-Ray 服务地图显示有关您的 API 及其所有下游服务的信息。在 API Gateway 中为 API 阶段启用 X-Ray 时,在服务地图中,您将看到一个包含有关 API Gateway 服务耗费的全部时间的节点。您可以获取有关响应状态和直方图所选时间范围的 API 响应时间。对于 API 集成 AWS 服务(如 AWS Lambda 和 Amazon DynamoDB),您将看到更多节点提供这些服务相关的性能指标。每个 API 阶段将有一个服务地图。

以下示例显示了名为 xray API 的 test 阶段的一个服务地图。此 API 具有集成了 Lambda 授权方函数和 Lambda 后端函数的 Lambda。这些节点代表 API Gateway 服务、Lambda 服务及两个 Lambda 函数。

有关服务地图结构的详细说明,请参阅查看服务地图


                API Gateway API 阶段的服务地图示例

您可以在服务地图中进行放大,查看您的 API 阶段的跟踪视图。跟踪将显示与您的 API 相关的深度信息,以分段和子分段的方式显示。例如,上面所示的服务地图跟踪包括 Lambda 服务和 Lambda 函数分段。有关更多信息,请参阅作为 AWS X-Ray 跟踪的 Lambda

如果您在 X-Ray 服务地图上选择一个节点或边缘时,X-Ray 控制台会显示一个延迟分布直方图。您可以使用延迟直方图查看一项服务所需的时长以完成其请求。下面是 API Gateway 阶段的直方图,在之前的服务地图中名为 xray/test。有关延迟分配直方图的详细说明,请参阅在 AWS X-Ray 控制台中使用延迟直方图


                API Gateway API 阶段的 X-Ray 直方图

示例 X-Ray 跟踪视图

下图显示了为上述的示例 API 生成的跟踪视图,其中具有 Lambda 后端函数和 Lambda 授权方函数。成功的 API 方法请求的响应代码显示为 200。

有关跟踪视图的详细说明,请参阅查看跟踪


                启用了活动跟踪的 API Gateway