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

REST API の分散呼び出しを分析する場合は、X-Ray トレースを有効にします。

説明

provider.tracing.apiGateway は、Serverless Framework が作成した REST API の X-Ray トレースを制御します。無効にすると、その API のサンプリングされたリクエスト経路や遅延情報を収集できません。

想定される影響

サービス間の呼び出しで、エラーや性能低下が発生した箇所を特定しにくくなります。

対処方法

provider.tracing.apiGateway: true を設定し、必要な Lambda やバックエンドの計測も構成してください。サンプリングされたトレースは、全リクエストのアクセスログを代替しません。

例

provider.apiGateway.restApiId で外部 REST API を取り込む場合は、この設定ではなく、その API ステージのトレースを別途設定してください。

変更前

yaml
provider:
  name: aws
  tracing:
    apiGateway: false

変更後

yaml
provider:
  name: aws
  tracing:
    apiGateway: true

参考資料