feat: Add alert group name (#190)

Author: arturodilecce

sysdig/internal/client/monitor/models.go

@@ -49,6 +49,7 @@ type Alert struct {
 	Name                   string              `json:"name"`
 	Description            string              `json:"description"`
 	Enabled                bool                `json:"enabled"`
+	GroupName              string              `json:"groupName,omitempty"`
 	NotificationChannelIds []int               `json:"notificationChannelIds"`
 	Filter                 string              `json:"filter"`
 	Severity               int                 `json:"severity"` // 6 == INFO, 4 == LOW, 2 == MEDIUM, 0 == HIGH // NOT USED

sysdig/resource_sysdig_monitor_alert_common.go

@@ -3,6 +3,7 @@ package sysdig
 import (
 	"errors"
 	"regexp"
+	"strings"
 	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -42,6 +43,14 @@ func createAlertSchema(original map[string]*schema.Schema) map[string]*schema.Sc
 			Type:     schema.TypeInt,
 			Computed: true,
 		},
+		"group_name": {
+			Type:     schema.TypeString,
+			Optional: true,
+			Default:  "default",
+			DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
+				return strings.EqualFold(old, new)
+			},
+		},
 		"team": {
 			Type:     schema.TypeInt,
 			Computed: true,
@@ -148,6 +157,9 @@ func alertFromResourceData(d *schema.ResourceData) (alert *monitor.Alert, err er
 	if description, ok := d.GetOk("description"); ok {
 		alert.Description = description.(string)
 	}
+	if groupName, ok := d.GetOk("group_name"); ok {
+		alert.GroupName = strings.ToLower(groupName.(string))
+	}
 	if version, ok := d.GetOk("version"); ok {
 		alert.Version = version.(int)
 	}
@@ -197,6 +209,7 @@ func alertToResourceData(alert *monitor.Alert, data *schema.ResourceData) (err e
 	_ = data.Set("description", alert.Description)
 	_ = data.Set("scope", alert.Filter)
 	_ = data.Set("trigger_after_minutes", int(trigger_after_minutes.Minutes()))
+	_ = data.Set("group_name", alert.GroupName)
 	_ = data.Set("team", alert.TeamID)
 	_ = data.Set("enabled", alert.Enabled)
 	_ = data.Set("severity", alert.Severity)

sysdig/resource_sysdig_monitor_alert_metric_test.go

@@ -30,6 +30,9 @@ func TestAccAlertMetric(t *testing.T) {
 			{
 				Config: alertMetricWithName(rText()),
 			},
+			{
+				Config: alertMetricWithGroupName(rText()),
+			},
 			{
 				Config: alertMetricWithoutScopeWithName(rText()),
 			},
@@ -69,6 +72,30 @@ resource "sysdig_monitor_alert_metric" "sample" {
 `, name, name)
 }
 
+func alertMetricWithGroupName(name string) string {
+	return fmt.Sprintf(`
+resource "sysdig_monitor_alert_metric" "sample" {
+	name = "TERRAFORM TEST - METRIC %s"
+	description = "TERRAFORM TEST - METRIC %s"
+	severity = 3
+
+	metric = "avg(avg(cpu.used.percent)) > 50"
+	scope = "agent.id in (\"foo\")"
+	
+	trigger_after_minutes = 10
+	group_name = "sample_group_name"
+	enabled = false
+
+	multiple_alerts_by = ["kubernetes.deployment.name"]
+
+	capture {
+		filename = "TERRAFORM_TEST.scap"
+		duration = 15
+	}
+}
+`, name, name)
+}
+
 func alertMetricWithoutScopeWithName(name string) string {
 	return fmt.Sprintf(`
 resource "sysdig_monitor_alert_metric" "sample2" {

sysdig/resource_sysdig_monitor_alert_promql_test.go

@@ -30,6 +30,9 @@ func TestAccAlertPromql(t *testing.T) {
 			{
 				Config: alertPromqlWithName(rText()),
 			},
+			{
+				Config: alertPromqlWithGroupName(rText()),
+			},
 			{
 				ResourceName:      "sysdig_monitor_alert_promql.sample",
 				ImportState:       true,
@@ -54,3 +57,19 @@ resource "sysdig_monitor_alert_promql" "sample" {
 }
 `, name, name)
 }
+
+func alertPromqlWithGroupName(name string) string {
+	return fmt.Sprintf(`
+resource "sysdig_monitor_alert_promql" "sample" {
+	name = "TERRAFORM TEST - PROMQL %s"
+	description = "TERRAFORM TEST - PROMQL %s"
+	severity = 3
+	group_name = "sample_group_name"
+	promql = "(elasticsearch_jvm_memory_used_bytes{area=\"heap\"} / elasticsearch_jvm_memory_max_bytes{area=\"heap\"}) * 100 > 80"
+
+	trigger_after_minutes = 10
+
+	enabled = false
+}
+`, name, name)
+}

website/docs/r/monitor_alert_anomaly.md

@@ -44,6 +44,7 @@ These arguments are common to all alerts in Sysdig Monitor.
 * `trigger_after_minutes` - (Required) Threshold of time for the status to stabilize until the alert is fired.
 * `scope` - (Optional) Part of the infrastructure where the alert is valid. Defaults to the entire infrastructure. 
 * `enabled` - (Optional) Boolean that defines if the alert is enabled or not. Defaults to true.
+* `group_name` - (Optional) Lowercase string to group alerts in the UI
 * `notification_channels` - (Optional) List of notification channel IDs where an alert must be sent to once fired.
 * `renotification_minutes` - (Optional) Number of minutes for the alert to re-notify until the status is solved.
 * `capture` - (Optional) Enables the creation of a capture file of the syscalls during the event.

website/docs/r/monitor_alert_downtime.md

@@ -40,6 +40,7 @@ These arguments are common to all alerts in Sysdig Monitor.
 * `trigger_after_minutes` - (Required) Threshold of time for the status to stabilize until the alert is fired.
 * `scope` - (Optional) Part of the infrastructure where the alert is valid. Defaults to the entire infrastructure. 
 * `enabled` - (Optional) Boolean that defines if the alert is enabled or not. Defaults to true.
+* `group_name` - (Optional) Lowercase string to group alerts in the UI
 * `notification_channels` - (Optional) List of notification channel IDs where an alert must be sent to once fired.
 * `renotification_minutes` - (Optional) Number of minutes for the alert to re-notify until the status is solved.
 * `capture` - (Optional) Enables the creation of a capture file of the syscalls during the event.

website/docs/r/monitor_alert_event.md

@@ -46,6 +46,7 @@ These arguments are common to all alerts in Sysdig Monitor.
 * `trigger_after_minutes` - (Required) Threshold of time for the status to stabilize until the alert is fired.
 * `scope` - (Optional) Part of the infrastructure where the alert is valid. Defaults to the entire infrastructure. 
 * `enabled` - (Optional) Boolean that defines if the alert is enabled or not. Defaults to true.
+* `group_name` - (Optional) Lowercase string to group alerts in the UI
 * `notification_channels` - (Optional) List of notification channel IDs where an alert must be sent to once fired.
 * `renotification_minutes` - (Optional) Number of minutes for the alert to re-notify until the status is solved.
 * `capture` - (Optional) Enables the creation of a capture file of the syscalls during the event.

website/docs/r/monitor_alert_group_outlier.md

@@ -44,6 +44,7 @@ These arguments are common to all alerts in Sysdig Monitor.
 * `trigger_after_minutes` - (Required) Threshold of time for the status to stabilize until the alert is fired.
 * `scope` - (Optional) Part of the infrastructure where the alert is valid. Defaults to the entire infrastructure. 
 * `enabled` - (Optional) Boolean that defines if the alert is enabled or not. Defaults to true.
+* `group_name` - (Optional) Lowercase string to group alerts in the UI
 * `notification_channels` - (Optional) List of notification channel IDs where an alert must be sent to once fired.
 * `renotification_minutes` - (Optional) Number of minutes for the alert to re-notify until the status is solved.
 * `capture` - (Optional) Enables the creation of a capture file of the syscalls during the event.

website/docs/r/monitor_alert_metric.md

@@ -48,6 +48,7 @@ These arguments are common to all alerts in Sysdig Monitor.
 * `trigger_after_minutes` - (Required) Threshold of time for the status to stabilize until the alert is fired.
 * `scope` - (Optional) Part of the infrastructure where the alert is valid. Defaults to the entire infrastructure. 
 * `enabled` - (Optional) Boolean that defines if the alert is enabled or not. Defaults to true.
+* `group_name` - (Optional) Lowercase string to group alerts in the UI
 * `notification_channels` - (Optional) List of notification channel IDs where an alert must be sent to once fired.
 * `renotification_minutes` - (Optional) Number of minutes for the alert to re-notify until the status is solved.
 * `capture` - (Optional) Enables the creation of a capture file of the syscalls during the event.

website/docs/r/monitor_alert_promql.md

@@ -37,6 +37,7 @@ These arguments are common to all alerts in Sysdig Monitor.
                with 0 being the most critical and 7 the less critical. Defaults to 4.
 * `trigger_after_minutes` - (Required) Threshold of time for the status to stabilize until the alert is fired.
 * `enabled` - (Optional) Boolean that defines if the alert is enabled or not. Defaults to true.
+* `group_name` - (Optional) Lowercase string to group alerts in the UI
 * `notification_channels` - (Optional) List of notification channel IDs where an alert must be sent to once fired.
 * `renotification_minutes` - (Optional) Number of minutes for the alert to re-notify until the status is solved.
 * `custom_notification` - (Optional) Allows to define a custom notification title, prepend and append text.