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

説明

SAM REST API で TracingEnabled を有効にすると、X-Ray でサンプリングしたリクエストの処理経路や遅延を確認できます。無効にすると、その API のトレース情報を収集できません。

想定される影響

分散した呼び出しの中で、エラーや遅延が発生した箇所を特定しにくくなります。

対処方法

TracingEnabled: true を設定してください。呼び出し全体を追う場合は、Lambda や他のバックエンドもトレースするよう設定してください。トレースはサンプリングされるため、全リクエストの監査記録を代替しません。

例

この抜粋は REST API ステージのトレースだけを有効にします。バックエンドの計測とトレースデータへのアクセス権限は別途設定してください。

変更前

Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: prod
      TracingEnabled: false

変更後

Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: prod
      TracingEnabled: true

参考資料

• CWE-778
• SAM API のトレース設定