@exabugs/dynamodb-client 1.8.0 → 1.10.0

package/terraform/README.md

@@ -82,12 +82,14 @@ module "lambda_records" {
 
 ### オプション変数
 
-| 変数名               | 型     | デフォルト値 | 説明                                |
-| -------------------- | ------ | ------------ | ----------------------------------- |
-| `log_retention_days` | number | 7            | CloudWatch Logsの保持期間（日）     |
-| `log_level`          | string | "info"       | ログレベル（debug/info/warn/error） |
-| `lambda_timeout`     | number | 900          | Lambda関数のタイムアウト（秒）      |
-| `lambda_memory`      | number | 512          | Lambda関数のメモリサイズ（MB）      |
+| 変数名                       | 型           | デフォルト値 | 説明                                                                                                   |
+| ---------------------------- | ------------ | ------------ | ------------------------------------------------------------------------------------------------------ |
+| `log_retention_days`         | number       | 7            | CloudWatch Logsの保持期間（日）                                                                        |
+| `log_level`                  | string       | "info"       | ログレベル（debug/info/warn/error）                                                                    |
+| `scan_warn_threshold`        | number       | 5000         | 疎な検索(SPARSE_SCAN)の警告を出す閾値（1リクエストで読む件数）。打ち切りはしない。docs/SCAN_WARNING.md |
+| `scan_warning_alarm_actions` | list(string) | []           | SPARSE_SCAN アラームの通知先（SNS トピック ARN）。空だと誰にも通知されない                             |
+| `lambda_timeout`             | number       | 900          | Lambda関数のタイムアウト（秒）                                                                         |
+| `lambda_memory`              | number       | 512          | Lambda関数のメモリサイズ（MB）                                                                         |
 
 ## 出力
 

package/terraform/main.tf

@@ -80,6 +80,43 @@ resource "aws_cloudwatch_log_group" "lambda_records" {
   }
 }
 
+# 疎な検索（SPARSE_SCAN）の警告を検知する
+# Lambda は、1リクエストで読んだ件数が SCAN_WARN_THRESHOLD を超えると event=SPARSE_SCAN の警告ログを出す。
+# 結果を壊さないため検索は打ち切らない。警告に気づいて、インデックス・スキーマ・ロジックの
+# 見直しに着手できるよう、メトリクスとアラームにする（対応手順: docs/SCAN_WARNING.md）
+resource "aws_cloudwatch_log_metric_filter" "sparse_scan" {
+  name           = "${var.project_name}-${var.environment}-records-sparse-scan"
+  log_group_name = aws_cloudwatch_log_group.lambda_records.name
+  pattern        = "{ $.event = \"SPARSE_SCAN\" }"
+
+  metric_transformation {
+    name          = "SparseScanCount"
+    namespace     = "${var.project_name}/${var.environment}/Records"
+    value         = "1"
+    default_value = "0"
+  }
+}
+
+resource "aws_cloudwatch_metric_alarm" "sparse_scan" {
+  alarm_name          = "${var.project_name}-${var.environment}-records-sparse-scan"
+  alarm_description   = "疎な検索(SPARSE_SCAN)の警告が出ています。ログの actions に従って、インデックス・スキーマ・ロジックを見直してください（docs/SCAN_WARNING.md）"
+  namespace           = aws_cloudwatch_log_metric_filter.sparse_scan.metric_transformation[0].namespace
+  metric_name         = aws_cloudwatch_log_metric_filter.sparse_scan.metric_transformation[0].name
+  statistic           = "Sum"
+  period              = 300
+  evaluation_periods  = 1
+  threshold           = 1
+  comparison_operator = "GreaterThanOrEqualToThreshold"
+  treat_missing_data  = "notBreaching"
+
+  alarm_actions = var.scan_warning_alarm_actions
+  ok_actions    = var.scan_warning_alarm_actions
+
+  tags = {
+    Name = "${var.project_name}-${var.environment}-records-sparse-scan"
+  }
+}
+
 # Lambda関数のZIPファイルを作成
 data "archive_file" "lambda_records" {
   type        = "zip"
@@ -118,6 +155,8 @@ resource "aws_lambda_function" "records" {
       COGNITO_USER_POOL_ID = var.cognito_user_pool_id
       COGNITO_CLIENT_ID    = var.cognito_client_id
       LOG_LEVEL            = var.log_level
+      # 疎な検索(SPARSE_SCAN)の警告閾値（1リクエストで読む件数）
+      SCAN_WARN_THRESHOLD = var.scan_warn_threshold
       # シャドウ設定（環境変数ベース）
       SHADOW_CREATED_AT_FIELD = var.shadow_created_at_field
       SHADOW_UPDATED_AT_FIELD = var.shadow_updated_at_field
@@ -215,7 +254,7 @@ module "parameter_store" {
   records_iam_function_url = aws_lambda_function_url.records_iam.function_url
   # IAM URL は常に同じ apply で作るため true を明示する（未確定の値の有無で count を決めない）
   create_records_iam_url_parameter = true
-  records_function_arn     = aws_lambda_function.records.arn
+  records_function_arn             = aws_lambda_function.records.arn
 
   # Cognito設定
   cognito_user_pool_id = var.cognito_user_pool_id

package/terraform/outputs.tf

@@ -59,3 +59,16 @@ output "iam_alias_arn" {
   description = "AWS_IAM認証用エイリアスのARN。呼び出し元IAMロールのlambda:InvokeFunctionUrl権限のResourceに指定する"
   value       = aws_lambda_alias.iam.arn
 }
+
+output "sparse_scan_alarm_name" {
+  description = "疎な検索(SPARSE_SCAN)の CloudWatch アラーム名"
+  value       = aws_cloudwatch_metric_alarm.sparse_scan.alarm_name
+}
+
+output "sparse_scan_metric" {
+  description = "疎な検索(SPARSE_SCAN)のメトリクス（namespace / name）"
+  value = {
+    namespace = aws_cloudwatch_log_metric_filter.sparse_scan.metric_transformation[0].namespace
+    name      = aws_cloudwatch_log_metric_filter.sparse_scan.metric_transformation[0].name
+  }
+}

package/terraform/variables.tf

@@ -55,6 +55,23 @@ variable "log_level" {
   }
 }
 
+variable "scan_warn_threshold" {
+  description = "疎な検索(SPARSE_SCAN)の警告を出す閾値（1リクエストで読むレコード件数）。超えても検索は打ち切らず、警告のみ記録する"
+  type        = number
+  default     = 5000
+
+  validation {
+    condition     = var.scan_warn_threshold >= 1 && floor(var.scan_warn_threshold) == var.scan_warn_threshold
+    error_message = "scan_warn_threshold は 1 以上の整数である必要があります。"
+  }
+}
+
+variable "scan_warning_alarm_actions" {
+  description = "SPARSE_SCAN アラームの通知先（SNS トピック ARN の配列）。空ならアラーム状態の記録のみ"
+  type        = list(string)
+  default     = []
+}
+
 # シャドウ設定（環境変数ベース）
 variable "shadow_created_at_field" {
   description = "作成日時フィールド名"