説明
API Gateway の REST API ステージで X-Ray トレースが無効な場合、リクエストの遅延やエラーが発生した区間を特定しにくくなります。分散トレースはサービス間の呼び出しを関連付けますが、サンプリングされるため、全リクエストを記録する監査ログの代わりにはなりません。
想定される影響
- サービス間の遅延やエラーの原因特定に時間がかかる可能性があります。
- 障害対応や性能分析に必要なリクエスト経路の情報が不足する可能性があります。
対処方法
トレースが必要な REST API ステージに xray_tracing_enabled = true を設定してください。必要な X-Ray 権限とサンプリング設定を確認し、ログやメトリクスと併用してください。デプロイ後に実際のトレース収集を確認してください。
例
REST API ステージ設定の抜粋です。参照する API とデプロイは別途構成してください。
変更前
hcl
resource "aws_api_gateway_stage" "example" {
stage_name = "prod"
rest_api_id = aws_api_gateway_rest_api.test.id
deployment_id = aws_api_gateway_deployment.test.id
xray_tracing_enabled = false
}
変更後
hcl
resource "aws_api_gateway_stage" "example" {
stage_name = "prod"
rest_api_id = aws_api_gateway_rest_api.test.id
deployment_id = aws_api_gateway_deployment.test.id
xray_tracing_enabled = true
}
変更後はステージの X-Ray トレースが有効になります。バックエンドの流れを確認するため、連携サービスのトレース設定も確認してください。