Merge pull request #418 from SumoLogic/feature/SUMO-191578-monitor-configurable-resolution-window-support

SUMO-191578, Added configurable resolution window field on triggers a…

Author: rmamilla-sumo

CHANGELOG.md

@@ -1,4 +1,6 @@
 ## 2.19.1 (Unreleased)
+FEATURES:
+* Add new optional `resolution_window` field to resource/sumologic_monitor (GH-418)
 
 ## 2.19.0 (September 20, 2022)
 FEATURES:

sumologic/resource_sumologic_monitors_library_monitor.go

@@ -127,6 +127,11 @@ func resourceSumologicMonitorsLibraryMonitor() *schema.Resource {
 								"LogsMissingDataCondition", "MetricsMissingDataCondition", "SloSliCondition",
 								"SloBurnRateCondition"}, false),
 						},
+						"resolution_window": {
+							Type:         schema.TypeString,
+							Optional:     true,
+							ValidateFunc: validation.StringMatch(regexp.MustCompile(`-?(\d)+[smhd]`), "Time range must be in the format '-?\\d+[smhd]'. Examples: -15m, 1d, etc."),
+						},
 					},
 				},
 			},
@@ -381,8 +386,9 @@ var logsStaticTriggerConditionSchema = map[string]*schema.Schema{
 			"threshold_type": &thresholdTypeSchema,
 		}),
 		"resolution": nested(false, schemaMap{
-			"threshold":      &thresholdSchema,
-			"threshold_type": &thresholdTypeSchema,
+			"threshold":         &thresholdSchema,
+			"threshold_type":    &thresholdTypeSchema,
+			"resolution_window": &timeRangeSchema,
 		}),
 	}),
 	"warning": nested(true, schemaMap{
@@ -392,8 +398,9 @@ var logsStaticTriggerConditionSchema = map[string]*schema.Schema{
 			"threshold_type": &thresholdTypeSchema,
 		}),
 		"resolution": nested(false, schemaMap{
-			"threshold":      &thresholdSchema,
-			"threshold_type": &thresholdTypeSchema,
+			"threshold":         &thresholdSchema,
+			"threshold_type":    &thresholdTypeSchema,
+			"resolution_window": &timeRangeSchema,
 		}),
 	}),
 }
@@ -642,6 +649,7 @@ func resourceSumologicMonitorsLibraryMonitorRead(d *schema.ResourceData, meta in
 	d.Set("alert_name", monitor.AlertName)
 	d.Set("slo_id", monitor.SloID)
 	d.Set("notification_group_fields", monitor.NotificationGroupFields)
+
 	// set notifications
 	notifications := make([]interface{}, len(monitor.Notifications))
 	for i, n := range monitor.Notifications {
@@ -706,13 +714,14 @@ func resourceSumologicMonitorsLibraryMonitorRead(d *schema.ResourceData, meta in
 		triggers := make([]interface{}, len(monitor.Triggers))
 		for i, t := range monitor.Triggers {
 			triggers[i] = map[string]interface{}{
-				"time_range":       t.PositiveTimeRange(),
-				"trigger_type":     t.TriggerType,
-				"threshold":        t.Threshold,
-				"threshold_type":   t.ThresholdType,
-				"occurrence_type":  t.OccurrenceType,
-				"trigger_source":   t.TriggerSource,
-				"detection_method": t.DetectionMethod,
+				"time_range":        t.PositiveTimeRange(),
+				"trigger_type":      t.TriggerType,
+				"threshold":         t.Threshold,
+				"threshold_type":    t.ThresholdType,
+				"occurrence_type":   t.OccurrenceType,
+				"trigger_source":    t.TriggerSource,
+				"detection_method":  t.DetectionMethod,
+				"resolution_window": t.PositiveResolutionWindow(),
 			}
 		}
 		if err := d.Set("triggers", triggers); err != nil {
@@ -862,13 +871,14 @@ func getTriggers(d *schema.ResourceData) []TriggerCondition {
 		for i := range rawTriggers {
 			triggerDict := rawTriggers[i].(map[string]interface{})
 			triggers[i] = TriggerCondition{
-				TriggerType:     triggerDict["trigger_type"].(string),
-				Threshold:       triggerDict["threshold"].(float64),
-				ThresholdType:   triggerDict["threshold_type"].(string),
-				TimeRange:       triggerDict["time_range"].(string),
-				OccurrenceType:  triggerDict["occurrence_type"].(string),
-				TriggerSource:   triggerDict["trigger_source"].(string),
-				DetectionMethod: triggerDict["detection_method"].(string),
+				TriggerType:      triggerDict["trigger_type"].(string),
+				Threshold:        triggerDict["threshold"].(float64),
+				ThresholdType:    triggerDict["threshold_type"].(string),
+				TimeRange:        triggerDict["time_range"].(string),
+				OccurrenceType:   triggerDict["occurrence_type"].(string),
+				TriggerSource:    triggerDict["trigger_source"].(string),
+				DetectionMethod:  triggerDict["detection_method"].(string),
+				ResolutionWindow: triggerDict["resolution_window"].(string),
 			}
 		}
 		return triggers
@@ -1073,6 +1083,7 @@ func jsonToLogsStaticConditionBlock(conditions []TriggerCondition) map[string]in
 			criticalDict["time_range"] = condition.PositiveTimeRange()
 			criticalRslv["threshold"] = condition.Threshold
 			criticalRslv["threshold_type"] = condition.ThresholdType
+			criticalRslv["resolution_window"] = condition.PositiveResolutionWindow()
 		case "Warning":
 			hasWarning = true
 			warningDict["time_range"] = condition.PositiveTimeRange()
@@ -1083,6 +1094,7 @@ func jsonToLogsStaticConditionBlock(conditions []TriggerCondition) map[string]in
 			warningDict["time_range"] = condition.PositiveTimeRange()
 			warningRslv["threshold"] = condition.Threshold
 			warningRslv["threshold_type"] = condition.ThresholdType
+			warningRslv["resolution_window"] = condition.PositiveResolutionWindow()
 		}
 	}
 	if !hasCritical {
@@ -1443,6 +1455,8 @@ func (condition *TriggerCondition) readFrom(block map[string]interface{}) {
 			condition.SLIThreshold = v.(float64)
 		case "burn_rate_threshold":
 			condition.BurnRateThreshold = v.(float64)
+		case "resolution_window":
+			condition.ResolutionWindow = v.(string)
 		default:
 		}
 	}
@@ -1574,5 +1588,9 @@ func (t *TriggerCondition) PositiveBaselineWindow() string {
 	return strings.TrimPrefix(t.BaselineWindow, "-")
 }
 
+func (t *TriggerCondition) PositiveResolutionWindow() string {
+	return strings.TrimPrefix(t.ResolutionWindow, "-")
+}
+
 type schemaMap = map[string]*schema.Schema
 type dict = map[string]interface{}

sumologic/resource_sumologic_monitors_library_monitor_test.go

@@ -156,13 +156,14 @@ func TestAccSumologicMonitorsLibraryMonitor_create(t *testing.T) {
 			DetectionMethod: "StaticCondition",
 		},
 		{
-			ThresholdType:   "LessThanOrEqual",
-			Threshold:       40.0,
-			TimeRange:       "15m",
-			OccurrenceType:  "ResultCount",
-			TriggerSource:   "AllResults",
-			TriggerType:     "ResolvedCritical",
-			DetectionMethod: "StaticCondition",
+			ThresholdType:    "LessThanOrEqual",
+			Threshold:        40.0,
+			TimeRange:        "15m",
+			OccurrenceType:   "ResultCount",
+			TriggerSource:    "AllResults",
+			TriggerType:      "ResolvedCritical",
+			DetectionMethod:  "StaticCondition",
+			ResolutionWindow: "5m",
 		},
 	}
 	recipients := []string{"[email protected]"}
@@ -211,6 +212,7 @@ func TestAccSumologicMonitorsLibraryMonitor_create(t *testing.T) {
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "queries.0.row_id", testQueries[0].RowID),
 					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", "triggers.1.resolution_window", testTriggers[1].ResolutionWindow),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "notifications.0.notification.0.connection_type", testNotifications[0].Notification.(EmailNotification).ConnectionType),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "alert_name", testAlertName),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "notification_group_fields.0", testGroupFields[0]),
@@ -278,13 +280,14 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 			DetectionMethod: "StaticCondition",
 		},
 		{
-			ThresholdType:   "LessThanOrEqual",
-			Threshold:       40.0,
-			TimeRange:       "15m",
-			OccurrenceType:  "ResultCount",
-			TriggerSource:   "AllResults",
-			TriggerType:     "ResolvedCritical",
-			DetectionMethod: "StaticCondition",
+			ThresholdType:    "LessThanOrEqual",
+			Threshold:        40.0,
+			TimeRange:        "15m",
+			OccurrenceType:   "ResultCount",
+			TriggerSource:    "AllResults",
+			TriggerType:      "ResolvedCritical",
+			DetectionMethod:  "StaticCondition",
+			ResolutionWindow: "5m",
 		},
 	}
 	recipients := []string{"[email protected]"}
@@ -339,13 +342,14 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 			DetectionMethod: "StaticCondition",
 		},
 		{
-			ThresholdType:   "LessThanOrEqual",
-			Threshold:       40.0,
-			TimeRange:       "30m",
-			OccurrenceType:  "ResultCount",
-			TriggerSource:   "AllResults",
-			TriggerType:     "ResolvedCritical",
-			DetectionMethod: "StaticCondition",
+			ThresholdType:    "LessThanOrEqual",
+			Threshold:        40.0,
+			TimeRange:        "30m",
+			OccurrenceType:   "ResultCount",
+			TriggerSource:    "AllResults",
+			TriggerType:      "ResolvedCritical",
+			DetectionMethod:  "StaticCondition",
+			ResolutionWindow: "15m",
 		},
 	}
 	updatedRecipients := []string{"[email protected]"}
@@ -394,6 +398,7 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "queries.0.row_id", testQueries[0].RowID),
 					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", "triggers.1.resolution_window", testTriggers[1].ResolutionWindow),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "notifications.0.notification.0.connection_type", testNotifications[0].Notification.(EmailNotification).ConnectionType),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "playbook", testPlaybook),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "alert_name", testAlertName),
@@ -416,6 +421,7 @@ func TestAccSumologicMonitorsLibraryMonitor_update(t *testing.T) {
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "queries.0.row_id", testUpdatedQueries[0].RowID),
 					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", "triggers.1.resolution_window", testUpdatedTriggers[1].ResolutionWindow),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "notifications.0.notification.0.connection_type", testUpdatedNotifications[0].Notification.(EmailNotification).ConnectionType),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "playbook", testUpdatedPlaybook),
 					resource.TestCheckResourceAttr("sumologic_monitor.test", "alert_name", testUpdatedAlertName),
@@ -482,7 +488,7 @@ func TestAccSumologicMonitorsLibraryMonitor_driftingCorrectionFGP(t *testing.T)
 	})
 }
 
-func TestAccSumologicMonitorsLibraryMonitor_update_folder(t *testing.T) {
+func TestAccSumologicMonitorsLibraryMonitor_folder_update(t *testing.T) {
 	var monitorsLibraryMonitor MonitorsLibraryMonitor
 	testNameSuffix := acctest.RandString(16)
 
@@ -670,6 +676,7 @@ resource "sumologic_monitor" "test" {
 		trigger_source = "AllResults"
 		trigger_type = "ResolvedCritical"
 		detection_method = "StaticCondition"
+		resolution_window = "5m"
 	  }
 	notifications {
 		notification {
@@ -755,6 +762,7 @@ resource "sumologic_monitor" "test" {
 		trigger_source = "AllResults"
 		trigger_type = "ResolvedCritical"
 		detection_method = "StaticCondition"
+		resolution_window = "15m"
 	  }
 	notifications {
 		notification {
@@ -960,6 +968,7 @@ var exampleLogsStaticTriggerConditionBlock = `
        resolution {
          threshold = 90
          threshold_type = "LessThanOrEqual"
+		 resolution_window = "15m"
        }
      }
      field = "field"

sumologic/sumologic_monitors_library_folder.go

@@ -3,7 +3,6 @@ package sumologic
 import (
 	"encoding/json"
 	"fmt"
-	"log"
 )
 
 // ---------- ENDPOINTS ----------
@@ -26,7 +25,7 @@ func (s *Client) CreateMonitorsLibraryFolder(monitorsLibraryFolder MonitorsLibra
 	if err != nil {
 		return "", err
 	}
-	log.Printf("created monitor response: %v", data)
+	//log.Printf("created monitor response: %v", data)
 
 	var createdMonitorsLibraryFolder MonitorsLibraryFolder
 

sumologic/sumologic_monitors_library_monitor.go

@@ -3,7 +3,6 @@ package sumologic
 import (
 	"encoding/json"
 	"fmt"
-	"log"
 )
 
 // ---------- ENDPOINTS ----------
@@ -26,8 +25,7 @@ func (s *Client) CreateMonitorsLibraryMonitor(monitorsLibraryMonitor MonitorsLib
 	if err != nil {
 		return "", err
 	}
-	log.Printf("created monitor response: %v", data)
-
+	
 	var createdMonitorsLibraryMonitor MonitorsLibraryMonitor
 
 	err = json.Unmarshal(data, &createdMonitorsLibraryMonitor)
@@ -166,6 +164,7 @@ type TriggerCondition struct {
 	OccurrenceType    string  `json:"occurrenceType"`
 	TriggerSource     string  `json:"triggerSource"`
 	DetectionMethod   string  `json:"detectionMethod"`
+	ResolutionWindow  string  `json:"resolutionWindow,omitempty"`
 	Field             string  `json:"field,omitempty"`
 	Window            int     `json:"window,omitempty"`
 	BaselineWindow    string  `json:"baselineWindow,omitempty"`

website/docs/r/monitor.html.markdown

@@ -259,6 +259,7 @@ resource "sumologic_monitor" "tf_logs_monitor_2" {
         resolution {
           threshold      = 40.0
           threshold_type = "LessThanOrEqual"
+          resolution_window = "5m"
         }
       }
     }
@@ -317,6 +318,7 @@ The following arguments are supported:
 - `slo_id` - (Optional) Identifier of the SLO definition for the monitor. This is only applicable & required for Slo `monitor_type`.
 - `queries` - (Required) All queries from the monitor.
 - `trigger_conditions` - (Required if not using `triggers`) Defines the conditions of when to send notifications. NOTE: `trigger_conditions` supplants the `triggers` argument. 
+  - `resolution_window` - The resolution window that the recovery condition must be met in each evaluation that happens within this entire duration before the alert is recovered (resolved). If not specified, the time range of your trigger will be used.
 - `triggers` - (Deprecated) 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.
@@ -360,6 +362,7 @@ trigger_conditions {
       resolution {
         threshold = 90
         threshold_type = "LessThanOrEqual"
+        resolution_window = "5m"
       }
     }
     warning {
@@ -371,6 +374,7 @@ trigger_conditions {
       resolution {
         threshold = 75
         threshold_type = "LessThanOrEqual"
+        resolution_window = "5m"
       }
     }
   }
@@ -403,6 +407,7 @@ Here is a summary of arguments for each condition type (fields which are not mar
     - `resolution` (Required)
       - `threshold`
       - `threshold_type`
+      - `resolution_window`
   - `warning`
     - `time_range` (Required)
     - `alert` (Required)
@@ -411,6 +416,7 @@ Here is a summary of arguments for each condition type (fields which are not mar
     - `resolution` (Required)
       - `threshold`
       - `threshold_type`
+      - `resolution_window`
 #### metrics_static_condition
   - `critical`
     - `time_range` (Required)
@@ -501,6 +507,7 @@ resource "sumologic_monitor" "tf_logs_monitor_1" {
     trigger_source   = "AllResults"
     trigger_type     = "ResolvedCritical"
     detection_method = "StaticCondition"
+    resolution_window = "5m"
   }
   notifications {
     notification {