feat: CLOUDP-380505 Update Alert Configuration Resource (#1585)

Co-authored-by: Rakhul S Prakash <rakhul.s.prakash@peerislands.io>

Author: rakhul-mongo

.github/workflows/contract-testing.yaml

@@ -206,7 +206,7 @@ jobs:
           cd cfn-resources/alert-configuration
           make create-test-resources
 
-          cat inputs/inputs_1_create.json
+          cat inputs/*
 
           make run-contract-testing
           make delete-test-resources

cfn-resources/alert-configuration/README.md

@@ -15,4 +15,8 @@ See the [resource docs](docs/README.md).
 
 ## CloudFormation Examples
 
-See the examples [CFN Template](/examples/alert-configuration/alert-configuration.json) for example resource.
+See the example CFN templates in the [examples directory](/examples/alert-configuration/):
+
+- [alert-configuration-email.json](/examples/alert-configuration/alert-configuration-email.json) - Email alert for host metrics
+- [alert-configuration-microsoft-teams.json](/examples/alert-configuration/alert-configuration-microsoft-teams.json) - Microsoft Teams alert for host metrics
+- [alert-configuration-stream-processor.json](/examples/alert-configuration/alert-configuration-stream-processor.json) - Email alert for Stream Processor metrics

cfn-resources/alert-configuration/cmd/resource/model.go

@@ -291,9 +291,11 @@ func expandAlertConfigurationThreshold(threshold *IntegerThresholdView) *admin.S
 		return nil
 	}
 	return &admin.StreamProcessorMetricThreshold{
-		Operator:  threshold.Operator,
-		Threshold: threshold.Threshold,
-		Units:     threshold.Units,
+		MetricName: threshold.MetricName,
+		Mode:       threshold.Mode,
+		Operator:   threshold.Operator,
+		Threshold:  threshold.Threshold,
+		Units:      threshold.Units,
 	}
 }
 

cfn-resources/alert-configuration/cmd/resource/resource.go

@@ -8,6 +8,8 @@ To declare this entity in your AWS CloudFormation template, use the following sy
 
 <pre>
 {
+    "<a href="#metricname" title="MetricName">MetricName</a>" : <i>String</i>,
+    "<a href="#mode" title="Mode">Mode</a>" : <i>String</i>,
     "<a href="#operator" title="Operator">Operator</a>" : <i>String</i>,
     "<a href="#threshold" title="Threshold">Threshold</a>" : <i>Double</i>,
     "<a href="#units" title="Units">Units</a>" : <i>String</i>
@@ -17,13 +19,35 @@ To declare this entity in your AWS CloudFormation template, use the following sy
 ### YAML
 
 <pre>
+<a href="#metricname" title="MetricName">MetricName</a>: <i>String</i>
+<a href="#mode" title="Mode">Mode</a>: <i>String</i>
 <a href="#operator" title="Operator">Operator</a>: <i>String</i>
 <a href="#threshold" title="Threshold">Threshold</a>: <i>Double</i>
 <a href="#units" title="Units">Units</a>: <i>String</i>
 </pre>
 
 ## Properties
 
+#### MetricName
+
+Human-readable label that identifies the metric against which MongoDB Cloud checks the configured threshold.
+
+_Required_: No
+
+_Type_: String
+
+_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
+
+#### Mode
+
+Indicates how MongoDB Cloud computes the current metric value (e.g., AVERAGE).
+
+_Required_: No
+
+_Type_: String
+
+_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
+
 #### Operator
 
 Comparison operator to apply when checking the current metric value.

cfn-resources/alert-configuration/docs/integerthresholdview.md

@@ -194,6 +194,14 @@
     "IntegerThresholdView": {
       "type": "object",
       "properties": {
+        "MetricName": {
+          "type": "string",
+          "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured threshold."
+        },
+        "Mode": {
+          "type": "string",
+          "description": "Indicates how MongoDB Cloud computes the current metric value (e.g., AVERAGE)."
+        },
         "Operator": {
           "type": "string",
           "description": "Comparison operator to apply when checking the current metric value.",

cfn-resources/alert-configuration/mongodb-atlas-alertconfiguration.json

@@ -49,4 +49,14 @@ jq --arg group_id "$projectId" \
 	'.ProjectId?|=$group_id | .Profile?|=$profile' \
 	"$(dirname "$0")/inputs_1_update.template.json" >"inputs/inputs_1_update.json"
 
+jq --arg group_id "$projectId" \
+	--arg profile "$profile" \
+	'.ProjectId?|=$group_id | .Profile?|=$profile' \
+	"$(dirname "$0")/inputs_2_create.template.json" >"inputs/inputs_2_create.json"
+
+jq --arg group_id "$projectId" \
+	--arg profile "$profile" \
+	'.ProjectId?|=$group_id | .Profile?|=$profile' \
+	"$(dirname "$0")/inputs_2_update.template.json" >"inputs/inputs_2_update.json"
+
 ls -l inputs

cfn-resources/alert-configuration/test/cfn-test-create-inputs.sh

@@ -1,7 +1,7 @@
 {
   "Profile": "default",
   "ProjectId": "",
-  "Enabled": true,
+  "Enabled": "true",
   "EventTypeName": "OUTSIDE_METRIC_THRESHOLD",
   "SeverityOverride": "WARNING",
   "MetricThreshold": {

cfn-resources/alert-configuration/test/inputs_1_create.template.json

@@ -1,7 +1,7 @@
 {
   "Profile": "default",
   "ProjectId": "",
-  "Enabled": true,
+  "Enabled": "false",
   "EventTypeName": "OUTSIDE_METRIC_THRESHOLD",
   "SeverityOverride": "WARNING",
   "MetricThreshold": {

cfn-resources/alert-configuration/test/inputs_1_update.template.json

@@ -0,0 +1,29 @@
+{
+  "Profile": "default",
+  "ProjectId": "",
+  "Enabled": "true",
+  "EventTypeName": "OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD",
+  "SeverityOverride": "WARNING",
+  "Threshold": {
+    "MetricName": "STREAM_PROCESSOR_KAFKA_LAG",
+    "Mode": "AVERAGE",
+    "Operator": "LESS_THAN",
+    "Threshold": "42",
+    "Units": "RAW"
+  },
+  "Matchers": [
+    {
+      "FieldName": "INSTANCE_NAME",
+      "Operator": "EQUALS",
+      "Value": "event-replica-set"
+    }
+  ],
+  "Notifications": [
+    {
+      "TypeName": "EMAIL",
+      "DelayMin": "0",
+      "EmailAddress": "test@example.com",
+      "IntervalMin": "15"
+    }
+  ]
+}