Merge pull request #267 from SumoLogic/avijit-release-trigger-conditions-and-deprecate-triggers

Avijit release trigger conditions and deprecate triggers

Author: kumar-avijit

CHANGELOG.md

@@ -3,6 +3,9 @@
 FEATURES:
 
 * **New Resource:** sumologic_hierarchy (GH-260)
+DEPRECATIONS:
+
+* resource/sumologic_monitor: Deprecated `triggers` in favor of `trigger_conditions` (GH-267)
 
 ## 2.9.10 (August 24, 2021)
 

sumologic/resource_sumologic_monitors_library_monitor.go

@@ -85,8 +85,9 @@ func resourceSumologicMonitorsLibraryMonitor() *schema.Resource {
 			},
 
 			"triggers": {
-				Type:     schema.TypeList,
-				Optional: true,
+				Type:       schema.TypeList,
+				Optional:   true,
+				Deprecated: "The field `triggers` is deprecated and will be removed in a future release of the provider -- please use `trigger_conditions` instead.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"trigger_type": {

website/docs/r/monitor.html.markdown

@@ -24,23 +24,21 @@ resource "sumologic_monitor" "tf_logs_monitor_1" {
     row_id = "A"
     query  = "_sourceCategory=event-action info"
   }
-  triggers {
-    threshold_type   = "GreaterThan"
-    threshold        = 40.0
-    time_range       = "15m"
-    occurrence_type  = "ResultCount"
-    trigger_source   = "AllResults"
-    trigger_type     = "Critical"
-    detection_method = "StaticCondition"
+  trigger_conditions {
+    logs_static_condition {
+      critical {
+        time_range = "15m"
+        alert {
+          threshold      = 40.0
+          threshold_type = "GreaterThan"
+        }
+        resolution {
+          threshold      = 40.0
+          threshold_type = "LessThanOrEqual"
+        }
+      }
+    }
   }
-  triggers {
-    threshold_type   = "LessThanOrEqual"
-    threshold        = 40.0
-    time_range       = "15m"
-    occurrence_type  = "ResultCount"
-    trigger_source   = "AllResults"
-    trigger_type     = "ResolvedCritical"
-    detection_method = "StaticCondition"  }
   notifications {
     notification {
       connection_type = "Email"
@@ -78,23 +76,21 @@ resource "sumologic_monitor" "tf_metrics_monitor_1" {
     row_id = "A"
     query  = "metric=CPU_Idle _sourceCategory=event-action"
   }
-  triggers {
-    threshold_type   = "GreaterThan"
-    threshold        = 40.0
-    time_range       = "15m"
-    occurrence_type  = "ResultCount"
-    trigger_source   = "AllResults"
-    trigger_type     = "Critical"
-    detection_method = "StaticCondition"
-  }
-  triggers {
-    threshold_type   = "LessThanOrEqual"
-    threshold        = 40.0
-    time_range       = "15m"
-    occurrence_type  = "ResultCount"
-    trigger_source   = "AllResults"
-    trigger_type     = "ResolvedCritical"
-    detection_method = "StaticCondition"
+  trigger_conditions {
+    metrics_static_condition {
+      critical {
+        time_range = "15m"
+        occurrence_type = "AtLeastOnce"
+        alert {
+          threshold      = 40.0
+          threshold_type = "GreaterThan"
+        }
+        resolution {
+          threshold      = 40.0
+          threshold_type = "LessThanOrEqual"
+        }
+      }
+    }
   }
   notifications {
     notification {
@@ -146,23 +142,20 @@ resource "sumologic_monitor" "tf_logs_monitor_2" {
     row_id = "A"
     query  = "_sourceCategory=event-action info"
   }
-  triggers {
-    threshold_type   = "GreaterThan"
-    threshold        = 40.0
-    time_range       = "15m"
-    occurrence_type  = "ResultCount"
-    trigger_source   = "AllResults"
-    trigger_type     = "Critical"
-    detection_method = "StaticCondition"
-  }
-  triggers {
-    threshold_type   = "LessThanOrEqual"
-    threshold        = 40.0
-    time_range       = "15m"
-    occurrence_type  = "ResultCount"
-    trigger_source   = "AllResults"
-    trigger_type     = "ResolvedCritical"
-    detection_method = "StaticCondition"
+  trigger_conditions {
+    logs_static_condition {
+      critical {
+        time_range = "15m"
+        alert {
+          threshold      = 40.0
+          threshold_type = "GreaterThan"
+        }
+        resolution {
+          threshold      = 40.0
+          threshold_type = "LessThanOrEqual"
+        }
+      }
+    }
   }
   notifications {
     notification {
@@ -215,8 +208,8 @@ The following arguments are supported:
   - `Logs`: A logs query monitor.
   - `Metrics`: A metrics query monitor.
 - `queries` - (Required) All queries from the monitor.
-- `trigger_conditions` - (Beta) (Required if not using `triggers`) Defines the conditions of when to send notifications. NOTE: `trigger_conditions` supplants the `triggers` argument. 
-- `triggers` - Defines the conditions of when to send notifications.
+- `trigger_conditions` - (Required if not using `triggers`) Defines the conditions of when to send notifications. NOTE: `trigger_conditions` supplants the `triggers` argument. 
+- `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.
 - `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.
@@ -231,7 +224,7 @@ Additional data provided in state:
   - `Normal`
   - `Disabled`
 
-## The `trigger_conditions` block (Beta)
+## The `trigger_conditions` block
 A `trigger_conditions` block configures conditions for sending notifications.
 ### Example
 ```hcl
@@ -340,6 +333,62 @@ Here is a summary of arguments for each condition type (fields which are not mar
   - `time_range` (Required)
   - `trigger_source` (Required)
 
+## The `triggers` block
+The `triggers` block is deprecated. Please use `trigger_conditions` to specify notification conditions.
+
+Here's an example logs monitor that uses `triggers` to specify trigger conditions:
+```hcl
+resource "sumologic_monitor" "tf_logs_monitor_1" {
+  name         = "Terraform Logs Monitor"
+  description  = "tf logs monitor"
+  type         = "MonitorsLibraryMonitor"
+  is_disabled  = false
+  content_type = "Monitor"
+  monitor_type = "Logs"
+  queries {
+    row_id = "A"
+    query  = "_sourceCategory=event-action info"
+  }
+  triggers {
+    threshold_type   = "GreaterThan"
+    threshold        = 40.0
+    time_range       = "15m"
+    occurrence_type  = "ResultCount"
+    trigger_source   = "AllResults"
+    trigger_type     = "Critical"
+    detection_method = "StaticCondition"
+  }
+  triggers {
+    threshold_type   = "LessThanOrEqual"
+    threshold        = 40.0
+    time_range       = "15m"
+    occurrence_type  = "ResultCount"
+    trigger_source   = "AllResults"
+    trigger_type     = "ResolvedCritical"
+    detection_method = "StaticCondition"
+  }
+  notifications {
+    notification {
+      connection_type = "Email"
+      recipients = [
+        "[email protected]",
+      ]
+      subject      = "Monitor Alert: {{TriggerType}} on {{Name}}"
+      time_zone    = "PST"
+      message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}"
+    }
+    run_for_trigger_types = ["Critical", "ResolvedCritical"]
+  }
+  notifications {
+    notification {
+      connection_type = "Webhook"
+      connection_id   = "0000000000ABC123"
+    }
+    run_for_trigger_types = ["Critical", "ResolvedCritical"]
+  }
+}
+```
+
 ## Import
 
 Monitors can be imported using the monitor ID, such as: