Update docs and samples to reflect alarm ID becoming string (#12)

kentik · Jul 31, 2024 · 8b81dc6 · 8b81dc6
1 parent 7e63121
commit 8b81dc6
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/docs/TEMPLATING_REFERENCE.md b/docs/TEMPLATING_REFERENCE.md
@@ -311,7 +311,7 @@ Example:
 [{
   "Label": "ID",
   "Name": "AlarmID",
-  "Value": "216148908",
+  "Value": "0190db1d-5d37-70a8-95bd-4092c918ecbe",
 },
 {
   "Label": "Severity",
@@ -580,7 +580,7 @@ This will result in the following JSON payload on render:
 {
   "custom": {
     "AlarmBaselineSource": "ACT_BASELINE_MISSING_DEFAULT_INSTEAD_OF_LOWEST",
-    "AlarmID": 197790253,
+    "AlarmID": "0190db1d-5d37-70a8-95bd-4092c918ecbe",
     "AlarmPolicyID": 297,
     "AlarmPolicyName": "DDoS Protect Policy",
     "AlarmSeverity": "critical",
@@ -635,7 +635,7 @@ This will result in the following JSON payload on render:
 ```json
 {
   "AlarmBaselineSource": "ACT_BASELINE_MISSING_DEFAULT_INSTEAD_OF_LOWEST",
-  "AlarmID": 197790253,
+  "AlarmID": "0190db1d-5d37-70a8-95bd-4092c918ecbe",
   "AlarmPolicyID": 297,
   "AlarmPolicyName": "DDoS Protect Policy",
   "AlarmSeverity": "critical",

diff --git a/pkg/samples.go b/pkg/samples.go
@@ -236,7 +236,7 @@ var TestAlarm = &NotificationViewModel{
 				&EventViewModelDetail{
 					Name:  "AlarmID",
 					Label: "ID",
-					Value: 197790252,
+					Value: "0190db1d-5d37-70a8-95bd-4092c918ecbe",
 					Tag:   "",
 				},
 				&EventViewModelDetail{
@@ -402,7 +402,7 @@ var TestSynth = &NotificationViewModel{
 				&EventViewModelDetail{
 					Name:  "AlarmID",
 					Label: "",
-					Value: 1222228,
+					Value: "0190db1d-5d37-70a8-95bd-4092c918ecbe",
 					Tag:   "",
 				},
 				&EventViewModelDetail{
@@ -565,7 +565,7 @@ var TestMitigation = &NotificationViewModel{
 				&EventViewModelDetail{
 					Name:  "MitigationAlarmID",
 					Label: "Alarm ID",
-					Value: 197790252,
+					Value: "0190db1d-5d37-70a8-95bd-4092c918ecbe",
 					Tag:   "",
 				},
 				&EventViewModelDetail{

diff --git a/templates/json-legacy.tmpl b/templates/json-legacy.tmpl
@@ -9,10 +9,10 @@ See template documentation here: https://golang.org/pkg/text/template/
   {{- with .Event -}}
     {{- if .IsAlarm -}}
       "EventType":        "ALARM_STATE_CHANGE",
-      "AlarmID":          {{ .Details.GetValue "AlarmID" }},
+      "AlarmID":          "{{ .Details.GetValue "AlarmID" }}",
       "AlarmState":       "{{ .CurrentState }}",
-      "PolicyID":         {{ .Details.GetValue "AlarmPolicyID" }},
-      "ThresholdID":      {{ .Details.GetValue "AlarmThresholdID" }},
+      "PolicyID":         "{{ .Details.GetValue "AlarmPolicyID" }}",
+      "ThresholdID":      "{{ .Details.GetValue "AlarmThresholdID" }}",
       "MitigationID":     "0",
       "ActivateSeverity": "{{.Details.GetValue "AlarmSeverity"}}",
       "AlarmStart":       "{{ timeRfc3339 .StartTime }}",
@@ -76,19 +76,19 @@ See template documentation here: https://golang.org/pkg/text/template/
         }
       },
     {{- else if .IsMitigation -}}
-      "EventType": "MITIGATION_STATE_CHANGE",
-      "MitigationID":   {{ .Details.GetValue "MitigationID" }},
-      "MitigationStart": "{{timeRfc3339 .StartTime}}",
-      "MitigationEnd": "{{timeRfc3339 .EndTime}}",
-      "MitigationStateNew": "{{.CurrentState}}",
-      "MitigationState": "{{.CurrentState}}",
-      "MitigationStateOld": "{{.PreviousState}}",
-      "MitigationMethodID": {{.Details.GetValue "MitigationMethodID"}},
-      "MitigationPlatformID": {{.Details.GetValue "MitigationPlatformID"}},
-      "MitigationPolicyID":         {{ .Details.GetValue "MitigationPolicyID" }},
-      "MitigationMethodName": "{{.Details.GetValue "MitigationMethodName"}}",
+      "EventType":              "MITIGATION_STATE_CHANGE",
+      "MitigationID":           "{{ .Details.GetValue "MitigationID" }}",
+      "MitigationStart":        "{{timeRfc3339 .StartTime}}",
+      "MitigationEnd":          "{{timeRfc3339 .EndTime}}",
+      "MitigationStateNew":     "{{.CurrentState}}",
+      "MitigationState":        "{{.CurrentState}}",
+      "MitigationStateOld":     "{{.PreviousState}}",
+      "MitigationMethodID":     "{{.Details.GetValue "MitigationMethodID"}}",
+      "MitigationPlatformID":   "{{.Details.GetValue "MitigationPlatformID"}}",
+      "MitigationPolicyID":     "{{ .Details.GetValue "MitigationPolicyID" }}",
+      "MitigationMethodName":   "{{.Details.GetValue "MitigationMethodName"}}",
       "MitigationPlatformName": "{{.Details.GetValue "MitigationPlatformName"}}",
-      "MitigationAlertIP": "{{.Details.GetValue "MitigationAlertIP"}}",
+      "MitigationAlertIP":      "{{.Details.GetValue "MitigationAlertIP"}}",
     {{- else -}}
       {{- . | toJSON | explodeJSONKeys -}},
       {{- .Details.General.ToMap | toJSON | explodeJSONKeys -}},