Add Frequency.

Author: adcoelho

examples/resources/elasticstack_kibana_alerting_rule/resource_rule_action_frequency.tf

@@ -0,0 +1,38 @@
+provider "elasticstack" {
+  kibana {}
+}
+
+resource "elasticstack_kibana_alerting_rule" "example_with_action_frequency" {
+  name     = "%s"
+  consumer = "alerts"
+  params = jsonencode({
+    aggType             = "avg"
+    groupBy             = "top"
+    termSize            = 10
+    timeWindowSize      = 10
+    timeWindowUnit      = "s"
+    threshold           = [10]
+    thresholdComparator = ">"
+    index               = ["test-index"]
+    timeField           = "@timestamp"
+    aggField            = "version"
+    termField           = "name"
+  })
+  rule_type_id = ".index-threshold"
+  interval     = "1m"
+  enabled      = true
+
+  actions {
+    # Should be the id of a MS Teams connector
+    id    = elasticstack_kibana_action_connector.index_example.connector_id
+    group = "threshold met"
+    params = jsonencode({
+      "message" : "foobar"
+    })
+
+    frequency {
+      summary     = false
+      notify_when = "onActionGroupChange"
+    }
+  }
+}

internal/clients/kibana/alerting.go

@@ -35,7 +35,7 @@ func ruleResponseToModel(spaceID string, res *alerting.RuleResponseProperties) *
 			a.Frequency = &models.AlertingRuleActionFrequency{
 				Summary:    frequency.Summary,
 				NotifyWhen: (string)(frequency.NotifyWhen),
-				Throttle:   *frequency.Throttle.Get(),
+				Throttle:   frequency.Throttle.Get(),
 			}
 		}
 
@@ -92,11 +92,16 @@ func ruleActionsToActionsInner(ruleActions []models.AlertingRuleAction) []alerti
 		if alerting.IsNil(action.Frequency) {
 			actionToAppend.Frequency = nil
 		} else {
-			actionToAppend.Frequency = &alerting.ActionsInnerFrequency{
+			frequency := alerting.ActionsInnerFrequency{
 				Summary:    action.Frequency.Summary,
 				NotifyWhen: (alerting.NotifyWhen)(action.Frequency.NotifyWhen),
-				Throttle:   *alerting.NewNullableString(&action.Frequency.Throttle),
 			}
+
+			if action.Frequency.Throttle != nil {
+				frequency.Throttle = *alerting.NewNullableString(action.Frequency.Throttle)
+			}
+
+			actionToAppend.Frequency = &frequency
 		}
 
 		actions = append(actions, actionToAppend)

internal/clients/kibana/alerting_test.go

@@ -81,6 +81,15 @@ func Test_ruleResponseToModel(t *testing.T) {
 						Group:  "group-2",
 						Id:     "id",
 						Params: map[string]interface{}{},
+						Frequency: makePtr(alerting.ActionsInnerFrequency{
+							Summary:    true,
+							NotifyWhen: "onActionGroupChange",
+						}),
+					},
+					{
+						Group:  "group-3",
+						Id:     "id",
+						Params: map[string]interface{}{},
 					},
 				},
 				ExecutionStatus: alerting.RuleResponsePropertiesExecutionStatus{
@@ -121,13 +130,22 @@ func Test_ruleResponseToModel(t *testing.T) {
 						Frequency: &models.AlertingRuleActionFrequency{
 							Summary:    true,
 							NotifyWhen: "onThrottleInterval",
-							Throttle:   "10s",
+							Throttle:   makePtr("10s"),
 						},
 					},
 					{
 						Group:  "group-2",
 						ID:     "id",
 						Params: map[string]interface{}{},
+						Frequency: &models.AlertingRuleActionFrequency{
+							Summary:    true,
+							NotifyWhen: "onActionGroupChange",
+						},
+					},
+					{
+						Group:  "group-3",
+						ID:     "id",
+						Params: map[string]interface{}{},
 					},
 				},
 				AlertDelay: makePtr(float32(4)),

internal/kibana/alerting.go

@@ -282,11 +282,16 @@ func getActionsFromResourceData(d *schema.ResourceData, serverVersion *version.V
 					}
 				}
 
-				a.Frequency = &models.AlertingRuleActionFrequency{
+				frequency := models.AlertingRuleActionFrequency{
 					Summary:    d.Get(currentAction + ".frequency.0.summary").(bool),
 					NotifyWhen: d.Get(currentAction + ".frequency.0.notify_when").(string),
-					Throttle:   d.Get(currentAction + ".frequency.0.throttle").(string),
 				}
+
+				if throttle := getOrNilString(currentAction+".frequency.0.throttle", d); throttle != nil && *throttle != "" {
+					frequency.Throttle = throttle
+				}
+
+				a.Frequency = &frequency
 			}
 
 			actions = append(actions, a)

internal/kibana/alerting_test.go

@@ -63,7 +63,7 @@ func TestAccResourceAlertingRule(t *testing.T) {
 					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "name", ruleName),
 					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "rule_id", "af22bd1c-8fb3-4020-9249-a4ac5471624b"),
 					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "consumer", "alerts"),
-					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "notify_when", "onActiveAlert"),
+					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "notify_when", ""),
 					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "rule_type_id", ".index-threshold"),
 					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "interval", "1m"),
 					resource.TestCheckResourceAttr("elasticstack_kibana_alerting_rule.test_rule", "enabled", "true"),

internal/models/alert_rule.go

@@ -42,5 +42,5 @@ type AlertingRuleExecutionStatus struct {
 type AlertingRuleActionFrequency struct {
 	Summary    bool
 	NotifyWhen string
-	Throttle   string
+	Throttle   *string
 }