説明
API Gatewayのmetrics_enabledは、リソースとメソッド別の詳細メトリクスを制御します。無効でも、APIとステージ単位の基本メトリクスは利用できます。
想定される影響
詳細メトリクスがないと、特定のメソッドで発生した遅延やエラーの増加を切り分け、そのメソッド向けのアラームを設定しにくくなる場合があります。
対処方法
メソッド単位の監視が必要な箇所にmetrics_enabled = trueを設定してください。詳細メトリクスには追加料金がかかるため、必要な範囲を選んでください。
例
以下は、パスが単一セグメントのリソースに対するメソッド設定の例です。実行ログの設定を維持し、詳細メトリクスだけを有効にします。
変更前
hcl
resource "aws_api_gateway_method_settings" "example" {
rest_api_id = aws_api_gateway_rest_api.test.id
stage_name = aws_api_gateway_stage.test.stage_name
method_path = "${aws_api_gateway_resource.test.path_part}/${aws_api_gateway_method.test.http_method}"
settings {
metrics_enabled = false
logging_level = "INFO"
}
}
変更後
hcl
resource "aws_api_gateway_method_settings" "example" {
rest_api_id = aws_api_gateway_rest_api.test.id
stage_name = aws_api_gateway_stage.test.stage_name
method_path = "${aws_api_gateway_resource.test.path_part}/${aws_api_gateway_method.test.http_method}"
settings {
metrics_enabled = true
logging_level = "INFO"
}
}