Merge pull request #786 from SumoLogic/aman_tf_monitor_playbooks

Adding support for linking playbooks to monitors

Author: aman-sumo

CHANGELOG.md

@@ -1,6 +1,9 @@
 ## X.Y.Z (Unreleased)
 * Add new change notes here
 
+FEATURES:
+* **Updated sumologic_monitor resource:** Added support for automated playbooks in monitors
+
 ## 3.1.1 (July 8, 2025)
 
 ENHANCEMENTS:

sumologic/resource_sumologic_monitors_library_monitor.go

@@ -208,6 +208,14 @@ func getMonitorBaseSchema() map[string]*schema.Schema {
 			Optional: true,
 		},
 
+		"automated_playbook_ids": {
+			Type:     schema.TypeList,
+			Optional: true,
+			Elem: &schema.Schema{
+				Type: schema.TypeString,
+			},
+		},
+
 		"slo_id": {
 			Type:     schema.TypeString,
 			Optional: true,
@@ -897,6 +905,7 @@ func resourceSumologicMonitorsLibraryMonitorRead(d *schema.ResourceData, meta in
 	d.Set("status", monitor.Status)
 	d.Set("group_notifications", monitor.GroupNotifications)
 	d.Set("playbook", monitor.Playbook)
+	d.Set("automated_playbook_ids", monitor.AutomatedPlaybookIds)
 	d.Set("alert_name", monitor.AlertName)
 	d.Set("slo_id", monitor.SloID)
 	d.Set("notification_group_fields", monitor.NotificationGroupFields)
@@ -1759,6 +1768,12 @@ func resourceToMonitorsLibraryMonitor(d *schema.ResourceData) MonitorsLibraryMon
 		notificationGroupFields[i] = rawGroupFields[i].(string)
 	}
 
+	rawPlaybookIds := d.Get("automated_playbook_ids").([]interface{})
+	automatedPlaybookIds := make([]string, len(rawPlaybookIds))
+	for i := range rawPlaybookIds {
+		automatedPlaybookIds[i] = rawPlaybookIds[i].(string)
+	}
+
 	return MonitorsLibraryMonitor{
 		CreatedBy:               d.Get("created_by").(string),
 		Name:                    d.Get("name").(string),
@@ -1784,6 +1799,7 @@ func resourceToMonitorsLibraryMonitor(d *schema.ResourceData) MonitorsLibraryMon
 		Status:                  status,
 		GroupNotifications:      d.Get("group_notifications").(bool),
 		Playbook:                d.Get("playbook").(string),
+		AutomatedPlaybookIds:    automatedPlaybookIds,
 		AlertName:               d.Get("alert_name").(string),
 		SloID:                   d.Get("slo_id").(string),
 		NotificationGroupFields: notificationGroupFields,

sumologic/resource_sumologic_monitors_library_monitor_test.go

@@ -190,6 +190,36 @@ func TestAccSumologicMonitorsLibraryMonitor_basic(t *testing.T) {
 		},
 	})
 }
+
+func TestAccSumologicMonitorsLibraryMonitor_create_monitor_with_linked_playbook(t *testing.T) {
+	var monitorsLibraryMonitor MonitorsLibraryMonitor
+	testNameSuffix := acctest.RandString(16)
+
+	testName := "terraform_test_monitor_" + testNameSuffix
+
+	// NOTE: This playbook ID refers to a static playbook `[Do Not Delete] Playbook Used in Terraform Tests`. Replace with a valid playbook ID in your environment.
+	playbook_id := "6877cae1fb301f15fca89f67"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckMonitorsLibraryMonitorDestroy(),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccSumologicMonitorWithLinkedPlaybook(testName, playbook_id),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckMonitorsLibraryMonitorExists("sumologic_monitor.test", &monitorsLibraryMonitor),
+					resource.TestCheckResourceAttr("sumologic_monitor.test", "automated_playbook_ids.0", playbook_id)),
+			},
+			{
+				ResourceName:      "sumologic_monitor.test",
+				ImportState:       true,
+				ImportStateVerify: false,
+			},
+		},
+	})
+}
+
 func TestAccSumologicMonitorsLibraryMonitor_create(t *testing.T) {
 	var monitorsLibraryMonitor MonitorsLibraryMonitor
 	testNameSuffix := acctest.RandString(16)
@@ -796,6 +826,56 @@ func testAccCheckMonitorsLibraryMonitorAttributes(name string) resource.TestChec
 	}
 }
 
+func testAccSumologicMonitorWithLinkedPlaybook(testName, playbookId string) string {
+	return fmt.Sprintf(`
+resource "sumologic_monitor" "test" {
+	name = "terraform_test_monitor_%s"
+	description = "terraform_test_monitor_description"
+	type = "MonitorsLibraryMonitor"
+	is_disabled = false
+	content_type = "Monitor"
+	monitor_type = "Logs"
+	evaluation_delay = "60m"
+	time_zone = "America/New_York"
+	queries {
+		row_id = "A"
+		query = "_sourceCategory=monitor-manager error"
+	  }
+	triggers  {
+		threshold_type = "GreaterThan"
+		threshold = 40.0
+		time_range = "-60m"
+		occurrence_type = "ResultCount"
+		trigger_source = "AllResults"
+		trigger_type = "Critical"
+		detection_method = "StaticCondition"
+	  }
+	triggers  {
+		threshold_type = "LessThanOrEqual"
+		threshold = 40.0
+		time_range = "-60m"
+		occurrence_type = "ResultCount"
+		trigger_source = "AllResults"
+		trigger_type = "ResolvedCritical"
+		detection_method = "StaticCondition"
+		resolution_window = "5m"
+	  }
+	notifications {
+		notification {
+			connection_type = "Email"
+			recipients = ["[email protected]"]
+			subject = "test tf monitor"
+			time_zone = "PST"
+			message_body = "test"
+		  }
+		run_for_trigger_types = ["Critical", "ResolvedCritical"]
+	  }
+	playbook = "This is a test playbook"
+	automated_playbook_ids = ["%s"]
+	alert_name =  "Alert from {{Name}}"
+}`, testName, playbookId)
+}
+
 func testAccSumologicMonitorsLibraryMonitor(testName string) string {
 	return fmt.Sprintf(`
 resource "sumologic_monitor" "test" {

sumologic/sumologic_monitors_library_monitor.go

@@ -146,6 +146,7 @@ type MonitorsLibraryMonitor struct {
 	Status                  []string               `json:"status"`
 	GroupNotifications      bool                   `json:"groupNotifications"`
 	Playbook                string                 `json:"playbook,omitempty"`
+	AutomatedPlaybookIds    []string               `json:"automatedPlaybookIds,omitempty"`
 	AlertName               string                 `json:"alertName,omitempty"`
 	SloID                   string                 `json:"sloId,omitempty"`
 	NotificationGroupFields []string               `json:"notificationGroupFields,omitempty"`

website/docs/r/monitor.html.markdown

@@ -417,6 +417,59 @@ resource "sumologic_monitor" "tf_example_metrics_anomaly_monitor" {
 }
 ```
 
+## Example Monitor with linked Playbook
+```hcl
+resource "sumologic_monitor" "tf_monitor_with_playbook" {
+  name         = "Terraform Monitor with Playbook"
+  description  = "tf monitor with Playbook"
+  type         = "MonitorsLibraryMonitor"
+  is_disabled  = false
+  content_type = "Monitor"
+  monitor_type = "Metrics"
+  evaluation_delay = "1m"
+  tags = {
+    "team" = "monitoring"
+    "application" = "sumologic"
+  }
+
+  queries {
+    row_id = "A"
+    query  = "metric=CPU* _sourceCategory=event-action"
+  }
+
+  trigger_conditions {
+    metrics_static_condition {
+      critical {
+        time_range = "15m"
+        occurrence_type = "Always"
+        alert {
+          threshold      = 40.0
+          threshold_type = "GreaterThan"
+          min_data_points = 5
+        }
+        resolution {
+          threshold      = 40.0
+          threshold_type = "LessThanOrEqual"
+        }
+      }
+    }
+  }
+  notifications {
+    notification {
+      connection_type = "Email"
+      recipients      = ["[email protected]"]
+      subject         = "Triggered {{TriggerType}} Alert on Monitor {{Name}}"
+      time_zone       = "PST"
+      message_body    = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}"
+    }
+    run_for_trigger_types = ["Critical", "ResolvedCritical"]
+  }
+  playbook = "test playbook"
+  automated_playbook_ids = ["683a60a123ad6099e4d1333e"]
+  notification_group_fields = ["metric"]
+}
+```
+
 ## Monitor Folders
 
 NOTE: Monitor folders are considered a different resource from Library content folders. See [sumologic_monitor_folder][2] for more details.