API GatewayのX-Rayトレースが無効

REST APIの分散トレース要件に合わせてX-Rayを設定してください。

説明

API GatewayのREST APIステージでX-Rayトレースが無効な場合、そのステージはリクエストのトレースを能動的に開始しません。トレースは、サービス間の遅延やエラーの調査に役立ちます。

想定される影響

他のトレース手段もなければ、リクエストのボトルネックや失敗箇所の特定に時間がかかることがあります。

対処方法

X-Rayトレースが必要なステージにTracingEnabled: trueを設定し、バックエンドの計装とサンプリング設定を確認してください。

例

同じREST APIステージでトレース設定だけを変更する抜粋です。参照するAPIとデプロイリソースは別途定義してください。

変更前

yaml
Resources:
  ProdStage:
    Type: AWS::ApiGateway::Stage
    Properties:
      StageName: Prod
      RestApiId: !Ref MyRestApi
      DeploymentId: !Ref MyDeployment
      TracingEnabled: false

変更後

yaml
Resources:
  ProdStage:
    Type: AWS::ApiGateway::Stage
    Properties:
      StageName: Prod
      RestApiId: !Ref MyRestApi
      DeploymentId: !Ref MyDeployment
      TracingEnabled: true

参考資料