使用 API Gateway REST API 设置 AWS X-Ray

在本节中，您可以找到有关如何使用 API Gateway REST API 设置 AWS X-Ray 的详细信息。

API Gateway 的 X-Ray 跟踪模式

通过跟踪 ID 来跟踪请求在您的应用程序中传输的路径。跟踪会收集单个请求（通常是 HTTP GET 或 POST 请求）生成的所有分段。

API Gateway API 的跟踪有两种模式：

您可以使用 API Gateway 管理控制台、API Gateway CLI 或AWS开发工具包更改 API 的跟踪模式。

X-Ray 跟踪的权限

当您在一个阶段上启用 X-Ray 跟踪时，如果服务相关角色不存在，则 API Gateway 会在您的账户中创建该角色。该角色被命名为 AWSServiceRoleForAPIGateway，且将 APIGatewayServiceRolePolicy 托管策略附加于此。有关服务相关角色的更多信息，请参阅使用服务相关角色。

在 API Gateway 控制台中启用 X-Ray 跟踪

您可以使用 Amazon API Gateway 控制台在 API 阶段上启用活动的跟踪。

这些步骤假设您已将 API 部署到阶段。

一旦您已为 API 阶段启用了 X-Ray，则可以使用 X-Ray 管理控制台查看跟踪和服务地图。

使用 API Gateway CLI 启用 AWS X-Ray 跟踪

使用以下 create-stage 命令创建具有活动 X-Ray 跟踪的阶段：

aws apigateway create-stage \
    --rest-api-id rest-api-id \
    --stage-name stage-name \
    --deployment-id deployment-id \
    --region region \
    --tracing-enabled=true

输出将与以下内容类似：

{
    "tracingEnabled": true, 
    "stageName": stage-name, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": deployment-id, 
    "lastUpdatedDate": 1533849811, 
    "createdDate": 1533849811, 
    "methodSettings": {}
}

使用以下 create-stage 命令创建没有活动 X-Ray 跟踪的阶段：

aws apigateway create-stage \
    --rest-api-id rest-api-id \
    --stage-name stage-name \
    --deployment-id deployment-id \
    --region region \
    --tracing-enabled=false

输出将与以下内容类似：

{
    "tracingEnabled": false, 
    "stageName": stage-name, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": deployment-id, 
    "lastUpdatedDate": 1533849811, 
    "createdDate": 1533849811, 
    "methodSettings": {}
}

使用以下 update-stage 为已部署 API 启用活动 X-Ray 跟踪：

aws apigateway update-stage \
    --rest-api-id rest-api-id \
    --stage-name stage-name \
    --patch-operations op=replace,path=/tracingEnabled,value=true

使用以下 update-stage 为已部署 API 停用活动 X-Ray 跟踪：

aws apigateway update-stage \
    --rest-api-id rest-api-id \
    --stage-name stage-name \
    --region region \
    --patch-operations op=replace,path=/tracingEnabled,value=false

输出将与以下内容类似：

{
    "tracingEnabled": false, 
    "stageName": stage-name, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": deployment-id, 
    "lastUpdatedDate": 1533850033, 
    "createdDate": 1533849811, 
    "methodSettings": {}
}

一旦您已为 API 阶段启用了 X-Ray，请使用 X-Ray CLI 检索跟踪信息。有关更多信息，请参阅将 API 与 AWS CLI 一起使用。