Merge pull request #264 from SumoLogic/sli-SUMO-172431-monitor-playbook

SUM-172431 add monitor playbook support

Author: stevenxqli

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 FEATURES:
 
+* Add a new optional field `playbook` to resource/sumologic_monitor.
 * Add a new optional field `evaluation_delay` to resource/sumologic_monitor.
 
 ## 2.9.9 (August 12, 2021)

sumologic/resource_sumologic_monitors_library_monitor.go

@@ -311,13 +311,19 @@ func resourceSumologicMonitorsLibraryMonitor() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 			},
+
 			"post_request_map": {
 				Type:     schema.TypeMap,
 				Optional: true,
 				Elem: &schema.Schema{
 					Type: schema.TypeString,
 				},
 			},
+
+			"playbook": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
 		},
 	}
 }
@@ -526,6 +532,7 @@ func resourceSumologicMonitorsLibraryMonitorRead(d *schema.ResourceData, meta in
 	d.Set("is_disabled", monitor.IsDisabled)
 	d.Set("status", monitor.Status)
 	d.Set("group_notifications", monitor.GroupNotifications)
+	d.Set("playbook", monitor.Playbook)
 	// set notifications
 	notifications := make([]interface{}, len(monitor.Notifications))
 	for i, n := range monitor.Notifications {
@@ -1109,6 +1116,7 @@ func resourceToMonitorsLibraryMonitor(d *schema.ResourceData) MonitorsLibraryMon
 		IsDisabled:         d.Get("is_disabled").(bool),
 		Status:             status,
 		GroupNotifications: d.Get("group_notifications").(bool),
+		Playbook:           d.Get("playbook").(string),
 	}
 }
 

sumologic/resource_sumologic_monitors_library_monitor_test.go

@@ -251,6 +251,7 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 	testType := "MonitorsLibraryMonitor"
 	testContentType := "Monitor"
 	testMonitorType := "Logs"
+	testPlaybook := "This is a test playbook"
 	testIsDisabled := false
 	testEvaluationDelay := "5m"
 	testQueries := []MonitorQuery{
@@ -309,6 +310,7 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 	testUpdatedType := "MonitorsLibraryMonitor"
 	testUpdatedContentType := "Monitor"
 	testUpdatedMonitorType := "Logs"
+	testUpdatedPlaybook := "This is an updated test playbook"
 	testUpdatedIsDisabled := true
 	testUpdatedEvaluationDelay := "8m"
 	testUpdatedQueries := []MonitorQuery{
@@ -382,6 +384,7 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "triggers.0.trigger_type", testTriggers[0].TriggerType),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "triggers.0.time_range", testTriggers[0].TimeRange),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "notifications.0.notification.0.connection_type", testNotifications[0].Notification.(EmailNotification).ConnectionType),
+					resource.TestCheckResourceAttr("sumologic_monitor.test", "playbook", testPlaybook),
 				),
 			},
 			{
@@ -398,6 +401,7 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "triggers.0.trigger_type", testUpdatedTriggers[0].TriggerType),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "triggers.0.time_range", testUpdatedTriggers[0].TimeRange),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "notifications.0.notification.0.connection_type", testUpdatedNotifications[0].Notification.(EmailNotification).ConnectionType),
+					resource.TestCheckResourceAttr("sumologic_monitor.test", "playbook", testUpdatedPlaybook),
 				),
 			},
 		},
@@ -511,6 +515,7 @@ resource "sumologic_monitor" "test" {
 		  }
 		run_for_trigger_types = ["Critical", "ResolvedCritical"]
 	  }
+	playbook = "This is a test playbook"  
 }`, testName)
 }
 
@@ -556,6 +561,7 @@ resource "sumologic_monitor" "test" {
 		}
 		run_for_trigger_types = ["Critical", "ResolvedCritical"]
 	  }
+	playbook = "This is an updated test playbook"
 }`, testName)
 }
 
@@ -591,6 +597,7 @@ resource "sumologic_monitor" "test" {
 		  }
 		run_for_trigger_types = [%s]
 	  }
+	playbook = "This is a test playbook"
 }`, testName, monitorType, query, trigger, triggerTysStr)
 }
 

sumologic/sumologic_monitors_library_monitor.go

@@ -137,6 +137,7 @@ type MonitorsLibraryMonitor struct {
 	IsDisabled         bool                  `json:"isDisabled"`
 	Status             []string              `json:"status"`
 	GroupNotifications bool                  `json:"groupNotifications"`
+	Playbook           string                `json:"playbook,omitempty"`
 }
 
 type MonitorQuery struct {

website/docs/r/monitor.html.markdown

@@ -219,6 +219,7 @@ The following arguments are supported:
 - `triggers` - Defines the conditions of when to send notifications.
 - `notifications` - (Optional) The notifications the monitor will send when the respective trigger condition is met.
 - `group_notifications` - (Optional) Whether or not to group notifications for individual items that meet the trigger condition. Defaults to true.
+- `playbook` - (Optional - Beta) Notes such as links and instruction to help you resolve alerts triggered by this monitor. {{Markdown}} supported. It will be enabled only if available for your organization. Please contact your Sumo Logic account team to learn more.
 
 Additional data provided in state: