Merge pull request #64 from OpenSLO/sumo-agaurav

[sumologic] add support to override email msg body & connection payload

libs/monitor.go

@@ -27,13 +27,15 @@ func giveDefaultTriggers() []string {
 }
 
 type Notification struct {
-	TriggerFor     []string `yaml:"triggerFor,omitempty"`
-	ConnectionType string   `yaml:"connectionType"`
-	ConnectionID   string   `yaml:"connectionID,omitempty"`
-	Subject        string   `yaml:"subject,omitempty"`
-	Recipients     []string `yaml:"recipients,omitempty"`
-	MessageBody    string   `yaml:"messageBody,omitempty"`
-	TimeZone       string   `yaml:"timeZone,omitempty"`
+	TriggerFor                []string `yaml:"triggerFor,omitempty"`
+	ConnectionType            string   `yaml:"connectionType"`
+	ConnectionID              string   `yaml:"connectionID,omitempty"`
+	Subject                   string   `yaml:"subject,omitempty"`
+	Recipients                []string `yaml:"recipients,omitempty"`
+	MessageBody               string   `yaml:"messageBody,omitempty"`
+	TimeZone                  string   `yaml:"timeZone,omitempty"`
+	PayloadOverride           string   `yaml:"payload_override,omitempty"`
+	ResolutionPayloadOverride string   `yaml:"resolution_payload_override,omitempty"`
 }
 
 type SLOObjective struct {

libs/sumologic/native.go

@@ -18,19 +18,21 @@ const (
 )
 
 const (
-	AnnotationMonitorFolderID  = "sumologic/monitor-folder-id"
-	AnnotationSLOFolderID      = "sumologic/slo-folder-id"
-	AnnotationTFResourceName   = "sumologic/tf-resource-name"
-	AnnotationSignalType       = "sumologic/signal-type"
-	AnnotationEmailRecipients  = "recipients"
-	AnnotationEmailSubject     = "subject"
-	AnnotationEmailBody        = "body"
-	AnnotationEmailTimeZone    = "timezone"
-	AnnotationRunForTriggers   = "run_for_triggers"
-	AnnotationConnectionID     = "connection_id"
-	AnnotationConnectionType   = "connection_type"
-	AlertConditionTypeBurnRate = "burnrate"
-	AlertConditionTypeSLI      = "sli"
+	AnnotationMonitorFolderID           = "sumologic/monitor-folder-id"
+	AnnotationSLOFolderID               = "sumologic/slo-folder-id"
+	AnnotationTFResourceName            = "sumologic/tf-resource-name"
+	AnnotationSignalType                = "sumologic/signal-type"
+	AnnotationEmailRecipients           = "recipients"
+	AnnotationEmailSubject              = "subject"
+	AnnotationEmailBody                 = "message_body"
+	AnnotationEmailTimeZone             = "timezone"
+	AnnotationRunForTriggers            = "run_for_triggers"
+	AnnotationConnectionID              = "connection_id"
+	AnnotationConnectionType            = "connection_type"
+	AnnotationPayloadOverride           = "payload_override"
+	AnnotationResolutionPayloadOverride = "resolution_payload_override"
+	AlertConditionTypeBurnRate          = "burnrate"
+	AlertConditionTypeSLI               = "sli"
 )
 
 const (
@@ -66,9 +68,11 @@ type NotifyEmail struct {
 }
 
 type NotifyConnection struct {
-	ID             string
-	Type           string
-	RunForTriggers []string
+	ID                        string
+	Type                      string
+	RunForTriggers            []string
+	PayloadOverride           string
+	ResolutionPayloadOverride string
 }
 
 type SLO struct {
@@ -325,15 +329,24 @@ func giveNotifyTargets(ap oslo.AlertPolicy, notifyMap map[string]oslo.AlertNotif
 				TimeZone:       annotations[AnnotationEmailTimeZone],
 				RunForTriggers: strings.Split(annotations[AnnotationRunForTriggers], ","),
 			}
+			if notifyMail.TimeZone == "" {
+				notifyMail.TimeZone = "PST"
+			}
+
+			if notifyMail.Body == "" {
+				notifyMail.Body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}"
+			}
 
 			emailTargets = append(emailTargets, notifyMail)
 		}
 
 		if strings.ToLower(target.Spec.Target) == "connection" {
 			notifyConn := NotifyConnection{
-				Type:           annotations[AnnotationConnectionType],
-				ID:             annotations[AnnotationConnectionID],
-				RunForTriggers: strings.Split(annotations[AnnotationRunForTriggers], ","),
+				Type:                      annotations[AnnotationConnectionType],
+				ID:                        annotations[AnnotationConnectionID],
+				RunForTriggers:            strings.Split(annotations[AnnotationRunForTriggers], ","),
+				PayloadOverride:           annotations[AnnotationPayloadOverride],
+				ResolutionPayloadOverride: annotations[AnnotationResolutionPayloadOverride],
 			}
 			connTargets = append(connTargets, notifyConn)
 		}

libs/sumologic/templates/slo-monitors.tf.gotf

@@ -52,7 +52,9 @@ resource "sumologic_monitor" "{{ $m.TFResourceName }}" {
             ]
             subject      = "{{$n.Subject}}"
             time_zone    = "{{$n.TimeZone}}"
+            {{- if ne $n.Body ""}}
             message_body = "{{$n.Body}}"
+            {{- end}}
         }
         run_for_trigger_types = [
             {{- range $t := $n.RunForTriggers}}
@@ -67,6 +69,16 @@ resource "sumologic_monitor" "{{ $m.TFResourceName }}" {
         notification {
             connection_type = "{{$n.Type}}"
             connection_id   = "{{$n.ID}}"
+            {{- if ne $n.PayloadOverride ""}}
+            payload_override = <<JSON
+{{$n.PayloadOverride}}
+JSON
+            {{- end}}
+            {{- if ne $n.ResolutionPayloadOverride ""}}
+            resolution_payload_override = <<JSON
+{{$n.ResolutionPayloadOverride}}
+JSON
+            {{- end}}
         }
         run_for_trigger_types = [
             {{- range $t := $n.RunForTriggers}}

libs/templates/terraform/sumologic/monitor.tf.gotf

@@ -55,11 +55,27 @@ QUERY
                 {{end}}
             ]
             subject         = "SLO breach alert: {{$.Service}} - {{$.Name}}"
-            time_zone       = {{if ne $n.TimeZone "" }}"{{$n.TimeZone}}"{{else}}"PST"{{end}}
+            time_zone       = {{ if ne $n.TimeZone "" }} "{{$n.TimeZone}}" {{ else }} {{"PST"}} {{ end }}
+                {{- if ne $n.MessageBody "" }}
+            message_body    =   <<MESSAGE
+{{$n.MessageBody}}
+MESSAGE
+                {{ else }}
             message_body    = "{{`{{Description}} \n Result : {{ResultsJson}}\n Alert: {{AlertResponseURL}}`}}"
-            {{else}}
+                {{- end }}
+            {{ else }}
             connection_id   = "{{$n.ConnectionID}}"
-            {{end}}
+                {{- if ne $n.PayloadOverride ""}}
+            payload_override = <<JSON
+{{$n.PayloadOverride}}
+JSON
+                {{- end}}
+                {{- if ne $n.ResolutionPayloadOverride ""}}
+            resolution_payload_override = <<JSON
+{{$n.ResolutionPayloadOverride}}
+JSON
+                {{- end}}
+            {{- end}}
         }
         run_for_trigger_types = [
             {{range $t := $n.TriggerFor}}

samples/sumologic/logs/drift-calculation.yaml

@@ -34,9 +34,31 @@ alerts:
       longLimit: 14
       notifications:
         - connectionType: 'Email'
+          messageBody: "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}"
           recipients:
             - '[email protected]'
           timeZone: 'PST'
           triggerFor:
             - Warning
             - ResolvedWarning
+        - connectionType: 'PagerDuty'
+          connectionID: '000000000001ABCD'  # id of pagerduty connection created in Sumo Logic
+          triggerFor:
+            - Warning
+            - ResolvedWarning
+          payload_override: |
+            {
+              "service_key": "your_pagerduty_api_integration_key",
+              "event_type": "trigger",
+              "description": "Alert: Triggered {{TriggerType}} for Monitor {{Name}}",
+              "client": "Sumo Logic",
+              "client_url": "{{QueryUrl}}"
+            }
+          resolution_payload_override: |
+            {
+              "service_key": "your_pagerduty_api_integration_key",
+              "event_type": "resolve",
+              "description": "Alert: Resolved {{TriggerType}} for Monitor {{Name}}",
+              "client": "Sumo Logic",
+              "client_url": "{{QueryUrl}}"
+            } 

samples/sumologic/v1/logs-req-calendar.yaml

@@ -5,7 +5,6 @@ metadata:
   displayName: DriftGen SLO Calendar
   annotations:
     sumologic/signal-type: Latency
-    sumologic/slo-folder-id: 0000000000000ABC
 spec:
   description: test slo created from slogen
   service: tsat

samples/sumologic/v1/notification-target/email.yaml

@@ -8,6 +8,6 @@ metadata:
   annotations:
     recipients: "[email protected]"
     subject: "Monitor Alert: {{TriggerType}} on {{Name}}"
-    message_body: "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}"
+    message_body: "Triggered {{TriggerType}} Alert on the {{Name}}: {{QueryURL}}"
     time_zone: "PST"
     run_for_triggers: "Critical,ResolvedCritical"

samples/sumologic/v1/notification-target/pagerduty.yaml

@@ -9,3 +9,19 @@ metadata:
     connection_type : "PagerDuty"
     connection_id: "000000000000ABCD"
     run_for_triggers: "Critical,ResolvedCritical"
+    payload_override: |
+      {
+        "service_key": "your_pagerduty_api_integration_key",
+        "event_type": "trigger",
+        "description": "Alert: Triggered {{TriggerType}} for Monitor {{Name}}",
+        "client": "Sumo Logic",
+        "client_url": "{{QueryUrl}}"
+      }
+    resolution_payload_override: |
+      {
+        "service_key": "your_pagerduty_api_integration_key",
+        "event_type": "resolve",
+        "description": "Alert: Resolved {{TriggerType}} for Monitor {{Name}}",
+        "client": "Sumo Logic",
+        "client_url": "{{QueryUrl}}"
+      }