Add some documentation and examples

messagebird · Sep 25, 2018 · d73859e · d73859e
1 parent cf8e41c
commit d73859e
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,38 @@ receivers:
   - url: 'http://localhost:9876/alert'
 ```
 
+## Message templating
+
+Sachet supports Alertmanager-like templates for message content. You can do that by simply copying Alertmanager templates to Sachet. Some templates examples can be found in [the Alertmanager documentation](https://prometheus.io/docs/alerting/notification_examples/) as well as [available variables](https://prometheus.io/docs/alerting/notifications/).
+
+sachet.yml:
+```yaml
+templates:
+- /etc/sachet/notifications.tmpl
+
+receivers:
+- name: 'team-telegram'
+  provider: telegram
+  text: '{{ template "telegram_message" . }}'
+```
+notifications.tmpl:
+```
+{{ define "telegram_title" }}[{{ .Status | toUpper }}{{ if eq .Status "firing" }}:{{ .Alerts.Firing | len }}{{ end }}] {{ .CommonLabels.alertname }} @ {{ .CommonLabels.identifier }} {{ end }}
+
+{{ define "telegram_message" }}
+{{ if gt (len .Alerts.Firing) 0 }}
+*Alerts Firing:*
+{{ range .Alerts.Firing }}• {{ .Labels.instance }}: {{ .Annotations.description }}
+{{ end }}{{ end }}
+{{ if gt (len .Alerts.Resolved) 0 }}
+*Alerts Resolved:*
+{{ range .Alerts.Resolved }}• {{ .Labels.instance }}: {{ .Annotations.description }}
+{{ end }}{{ end }}{{ end }}
+
+{{ define "telegram_text" }}{{ template "telegram_title" .}}
+{{ template "telegram_message" . }}{{ end }}
+```
+
 ## License
 
 Sachet is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2016, MessageBird
diff --git a/examples/config.yaml b/examples/config.yaml
@@ -38,6 +38,9 @@ providers:
     username: 'username'
     password: 'password'
 
+templates:
+  - telegram.tmpl
+
 receivers:
   - name: 'team-sms'
     provider: 'messagebird'
@@ -48,4 +51,5 @@ receivers:
     provider: 'telegram'
     to:
       - '164451814' # the chat id of a user. Get yours at https://telegram.me/userinfobot
+    text: '{{ .GroupLabels.alertname }} @ {{ .Labels.instance }}: {{ .Status | toUpper }}'
 
diff --git a/examples/telegram.tmpl b/examples/telegram.tmpl
@@ -0,0 +1,14 @@
+{{ define "telegram_title" }}[{{ .Status | toUpper }}{{ if eq .Status "firing" }}:{{ .Alerts.Firing | len }}{{ end }}] {{ .CommonLabels.alertname }} @ {{ .CommonLabels.identifier }} {{ end }}
+
+{{ define "telegram_message" }}
+{{ if gt (len .Alerts.Firing) 0 }}
+*Alerts Firing:*
+{{ range .Alerts.Firing }}• {{ .Labels.instance }}: {{ .Annotations.description }}
+{{ end }}{{ end }}
+{{ if gt (len .Alerts.Resolved) 0 }}
+*Alerts Resolved:*
+{{ range .Alerts.Resolved }}• {{ .Labels.instance }}: {{ .Annotations.description }}
+{{ end }}{{ end }}{{ end }}
+
+{{ define "telegram_text" }}{{ template "telegram_title" .}}
+{{ template "telegram_message" . }}{{ end }}