RepoMirrors
/
alertmanager
mirror of https://github.com/prometheus/alertmanager
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
alertmanager/template/default.tmpl

219 lines
7.9 KiB
Cheetah
Raw Normal View History

Corrected Template Username Casing (#2345) * Corrected Template Username Casing Signed-off-by: midnightconman <midnightconman@gmail.com> * Added assets_vfsdata Signed-off-by: midnightconman <midnightconman@gmail.com>
2020-08-12 15:53:56 +00:00
{{ define "__alertmanager" }}Alertmanager{{ end }}
Allow slashes in receivers (#2011) * do not split receiver by slash I'm not sure why this was originally done, because a slash seems to be perfectly valid in a receiver definition. The only issue i encountered was that linking from a fired alert was not working, because of the splitting performed here. Signed-off-by: Tim Reddehase <tim.reddehase@xing.com> * urlquery escape Receiver by default for URL If Receiver is allowed to contain slashes and other special characters we need to percent encode them properly. Signed-off-by: Tim Reddehase <tim.reddehase@xing.com> * rerun make asset/assets_vfsdata.go Signed-off-by: Tim Reddehase <tim.reddehase@xing.com>
2019-08-28 08:01:47 +00:00
{{ define "__alertmanagerURL" }}{{ .ExternalURL }}/#/alerts?receiver={{ .Receiver | urlquery }}{{ end }}
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
Transfer template functions into types+methods
2015-11-30 17:00:38 +00:00
{{ define "__subject" }}[{{ .Status | toUpper }}{{ if eq .Status "firing" }}:{{ .Alerts.Firing | len }}{{ end }}] {{ .GroupLabels.SortedPairs.Values | join " " }} {{ if gt (len .CommonLabels) (len .GroupLabels) }}({{ with .CommonLabels.Remove .GroupLabels.Names }}{{ .Values | join " " }}{{ end }}){{ end }}{{ end }}
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
{{ define "__description" }}{{ end }}
add hipchat room notifier
2016-01-05 19:52:08 +00:00
{{ define "__text_alert_list" }}{{ range . }}Labels:
Transfer template functions into types+methods
2015-11-30 17:00:38 +00:00
{{ range .Labels.SortedPairs }} - {{ .Name }} = {{ .Value }}
add hipchat room notifier
2016-01-05 19:52:08 +00:00
{{ end }}Annotations:
Transfer template functions into types+methods
2015-11-30 17:00:38 +00:00
{{ range .Annotations.SortedPairs }} - {{ .Name }} = {{ .Value }}
Include generatorURL in PD and emails
2016-02-16 14:58:18 +00:00
{{ end }}Source: {{ .GeneratorURL }}
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
{{ end }}{{ end }}
Add msteams (#3324) * Add msteams Signed-off-by: Jack Zhang <jack4zhang@gmail.com> --------- Signed-off-by: Jack Zhang <jack4zhang@gmail.com> Signed-off-by: Jack <jack4zhang@gmail.com>
2023-06-08 15:27:56 +00:00
{{ define "__text_alert_list_markdown" }}{{ range . }}
Labels:
{{ range .Labels.SortedPairs }} - {{ .Name }} = {{ .Value }}
{{ end }}
Annotations:
{{ range .Annotations.SortedPairs }} - {{ .Name }} = {{ .Value }}
{{ end }}
Source: {{ .GeneratorURL }}
{{ end }}
{{ end }}
Add default templates
2015-10-11 11:32:34 +00:00
Iterate over templating
2015-11-25 14:49:26 +00:00
{{ define "slack.default.title" }}{{ template "__subject" . }}{{ end }}
Improve Slack integration
2015-11-30 12:52:41 +00:00
{{ define "slack.default.username" }}{{ template "__alertmanager" . }}{{ end }}
{{ define "slack.default.fallback" }}{{ template "slack.default.title" . }} | {{ template "slack.default.titlelink" . }}{{ end }}
Slack notifier missing callback_id parameter (#1592) * fix callback id in slack attachments Signed-off-by: Arno Uhlig <arno.uhlig@sap.com>
2018-10-23 09:22:23 +00:00
{{ define "slack.default.callbackid" }}{{ end }}
First-pass at improving template system. - Cut back to bare minimum to make the rest simpler - Consistency in config naming - Have one data strucutre that's the same for all templates - Pass in common labels to templates - Support templates almost everywhere - Support multiple SMTP recipients - Support non-ASCII SMTP headers - Handle colour logic via templates - Make $subjects have consistent output, go maps aren't sorted. - Make tests pass when v6 is disabled
2015-10-29 13:34:24 +00:00
{{ define "slack.default.pretext" }}{{ end }}
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
{{ define "slack.default.titlelink" }}{{ template "__alertmanagerURL" . }}{{ end }}
Adding support for slack icon_emoji in slack config. ``` slack_configs: - send_resolved: true username: 'Prometheus' channel: '#monitoring' icon_emoji: ':prometheus:' api_url: 'https://hooks.slack.com/services/<token>' ```
2016-02-16 10:54:30 +00:00
{{ define "slack.default.iconemoji" }}{{ end }}
Add support for overriding the icon_url slack parameter
2016-05-12 18:51:22 +00:00
{{ define "slack.default.iconurl" }}{{ end }}
Improve Slack integration
2015-11-30 12:52:41 +00:00
{{ define "slack.default.text" }}{{ end }}
Add footer field for slack messages (#1141)
2017-12-12 21:50:41 +00:00
{{ define "slack.default.footer" }}{{ end }}
Add default templates
2015-10-11 11:32:34 +00:00
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
First-pass at improving template system. - Cut back to bare minimum to make the rest simpler - Consistency in config naming - Have one data strucutre that's the same for all templates - Pass in common labels to templates - Support templates almost everywhere - Support multiple SMTP recipients - Support non-ASCII SMTP headers - Handle colour logic via templates - Make $subjects have consistent output, go maps aren't sorted. - Make tests pass when v6 is disabled
2015-10-29 13:34:24 +00:00
{{ define "pagerduty.default.description" }}{{ template "__subject" . }}{{ end }}
Iterate over templating
2015-11-25 14:49:26 +00:00
{{ define "pagerduty.default.client" }}{{ template "__alertmanager" . }}{{ end }}
{{ define "pagerduty.default.clientURL" }}{{ template "__alertmanagerURL" . }}{{ end }}
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
{{ define "pagerduty.default.instances" }}{{ template "__text_alert_list" . }}{{ end }}
First-pass at improving template system. - Cut back to bare minimum to make the rest simpler - Consistency in config naming - Have one data strucutre that's the same for all templates - Pass in common labels to templates - Support templates almost everywhere - Support multiple SMTP recipients - Support non-ASCII SMTP headers - Handle colour logic via templates - Make $subjects have consistent output, go maps aren't sorted. - Make tests pass when v6 is disabled
2015-10-29 13:34:24 +00:00
Add default templates
2015-10-11 11:32:34 +00:00
OpsGenie Notifier, fixes and additions: - OpsGenie notifier confused the description and message fields - Also added the notes field.
2016-07-12 12:36:20 +00:00
{{ define "opsgenie.default.message" }}{{ template "__subject" . }}{{ end }}
{{ define "opsgenie.default.description" }}{{ .CommonAnnotations.SortedPairs.Values | join " " }}
{{ if gt (len .Alerts.Firing) 0 -}}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{- end }}
{{ if gt (len .Alerts.Resolved) 0 -}}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{- end }}
{{- end }}
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
{{ define "opsgenie.default.source" }}{{ template "__alertmanagerURL" . }}{{ end }}
Add opsgenie notifier
2015-11-24 22:29:25 +00:00
Improve PagerDuty templating
2015-11-26 17:19:46 +00:00
Add notify support for Chinese User wechat (#1059) * WECHAT support by ybyang2/berlinsaint * correct the whitespace * add some TestFile and modify some naming errors by ybyang2/berlinsaint * modify wechat retry test expect * template error * add newline Signed-off-by: yb_home <berlinsaint@126.com> * fmt some pr code * use the @stuartnelson3 the test-ci-wechat bingdata.go * notify go add wechat
2017-12-09 15:20:22 +00:00
{{ define "wechat.default.message" }}{{ template "__subject" . }}
{{ .CommonAnnotations.SortedPairs.Values | join " " }}
{{ if gt (len .Alerts.Firing) 0 -}}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{- end }}
{{ if gt (len .Alerts.Resolved) 0 -}}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{- end }}
AlertmanagerUrl:
{{ template "__alertmanagerURL" . }}
{{- end }}
notify: catch templating errors for Wechat Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-06-24 12:02:21 +00:00
{{ define "wechat.default.to_user" }}{{ end }}
{{ define "wechat.default.to_party" }}{{ end }}
{{ define "wechat.default.to_tag" }}{{ end }}
{{ define "wechat.default.agent_id" }}{{ end }}
Add notify support for Chinese User wechat (#1059) * WECHAT support by ybyang2/berlinsaint * correct the whitespace * add some TestFile and modify some naming errors by ybyang2/berlinsaint * modify wechat retry test expect * template error * add newline Signed-off-by: yb_home <berlinsaint@126.com> * fmt some pr code * use the @stuartnelson3 the test-ci-wechat bingdata.go * notify go add wechat
2017-12-09 15:20:22 +00:00
Add entity_display_name for VictorOps, use better state_message (#769) * Add entity_display_name for VictorOps, use better state_message * Reuse existing long-form templates for state_message * Rebuild binaries * Limit state_message to 20K
2017-07-03 09:44:53 +00:00
{{ define "victorops.default.state_message" }}{{ .CommonAnnotations.SortedPairs.Values | join " " }}
{{ if gt (len .Alerts.Firing) 0 -}}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{- end }}
{{ if gt (len .Alerts.Resolved) 0 -}}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{- end }}
{{- end }}
{{ define "victorops.default.entity_display_name" }}{{ template "__subject" . }}{{ end }}
Renamed from and message options for VictorOps to monitoring_tool and state_message as per the VictorOps documentation (#667)
2017-03-24 14:06:39 +00:00
{{ define "victorops.default.monitoring_tool" }}{{ template "__alertmanager" . }}{{ end }}
Add VictorOps Notifier Add default VictorOpsAPIURL Add VictorOps default config Add VictorOpsConfig struct in notifiers Add new template tags for victorops Add notifications logic for victorops Compiled template tags with make assets Remove common labels from entity_id template Set messageType default value to CRITICAL Recovery messageType is not configurable anymore. Firing state only allows specific keys Make assets Using log.Debugf EntityID should not be configureable Remove entity_id from template Use GroupKey(ctx) as entity_id Improve debug logging Fix type of entity_id
2016-07-03 15:33:44 +00:00
Re-implement pushover notifications This feature was dropped during the rewrite, but I use and like Pushover. fixes #107
2016-02-26 08:35:00 +00:00
{{ define "pushover.default.title" }}{{ template "__subject" . }}{{ end }}
{{ define "pushover.default.message" }}{{ .CommonAnnotations.SortedPairs.Values | join " " }}
Add resolved alerts to pushover template The pushover notification of resolved alerts can end up in an empty message (only a newline). I've fixed the check for an empty message with trimming the whitespace. But I also thought that adding the resolved alerts to the message would be helpful.
2016-04-27 08:46:17 +00:00
{{ if gt (len .Alerts.Firing) 0 }}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{ end }}
{{ end }}
Re-implement pushover notifications This feature was dropped during the rewrite, but I use and like Pushover. fixes #107
2016-02-26 08:35:00 +00:00
{{ define "pushover.default.url" }}{{ template "__alertmanagerURL" . }}{{ end }}
WIP - SNS receiver Signed-off-by: Tyler Reid <tyler.reid@grafana.com>
2021-06-10 02:13:26 +00:00
Add subject template for subject field. Better check for supplied creds, use GetTopicAttributes to check fifo Signed-off-by: Tyler Reid <tyler.reid@grafana.com>
2021-06-15 22:24:52 +00:00
{{ define "sns.default.subject" }}{{ template "__subject" . }}{{ end }}
WIP - SNS receiver Signed-off-by: Tyler Reid <tyler.reid@grafana.com>
2021-06-10 02:13:26 +00:00
{{ define "sns.default.message" }}{{ .CommonAnnotations.SortedPairs.Values | join " " }}
{{ if gt (len .Alerts.Firing) 0 }}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{ end }}
{{ end }}
Adding telegram support (#2827) * added telegram config in notifiers Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added telegram config to config.go Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added package telegram to notify and initialization in cmd Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added telegram.default.message Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added telegram template to notifiers.go Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added message rendering from template to telegram integration Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * documentation for telegram_configs Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added tests for telegram Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * fixed config_test.go Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added valid parse_mode list to the error log Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * made use of httpconfig, moved telegram client creation to New func, changed message truncation to 4096 chars Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * changed supported values for telegram config Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added mock url for telegram tests to pass Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * added api_url check to telegram config Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * changed bot_token type to secret Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * removed extra emptyline Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * convert bot_token to string in telegram client creation Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * updated configuration.md Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * fixed mixed up errors Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com> * check telegram api url without conversion to string Signed-off-by: timmilesdw <tuktamyshev.t0308@gmail.com>
2022-02-22 16:51:02 +00:00
{{ define "telegram.default.message" }}
{{ if gt (len .Alerts.Firing) 0 }}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{ end }}
notify/discord: Create Discord integration Signed-off-by: Matthias Loibl <mail@matthiasloibl.com>
2022-06-10 14:17:14 +00:00
{{ end }}
{{ define "discord.default.title" }}{{ template "__subject" . }}{{ end }}
{{ define "discord.default.message" }}
{{ if gt (len .Alerts.Firing) 0 }}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{ end }}
{{ end }}
Notifier: Webex Cisco's Webex has been one of the most requested notifiers on Grafana for a while now, please see: https://github.com/grafana/grafana/issues/11750#issue-318358659 Given it's straightforward implementation, low maintance overhead and request demand, I think it's worth including this directly in the Alertmanager. Signed-off-by: gotjosh <josue.abreu@gmail.com>
2022-11-08 12:54:38 +00:00
{{ define "webex.default.message" }}{{ .CommonAnnotations.SortedPairs.Values | join " " }}
{{ if gt (len .Alerts.Firing) 0 }}
Alerts Firing:
{{ template "__text_alert_list" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
Alerts Resolved:
{{ template "__text_alert_list" .Alerts.Resolved }}
{{ end }}
{{ end }}
Add msteams (#3324) * Add msteams Signed-off-by: Jack Zhang <jack4zhang@gmail.com> --------- Signed-off-by: Jack Zhang <jack4zhang@gmail.com> Signed-off-by: Jack <jack4zhang@gmail.com>
2023-06-08 15:27:56 +00:00
Add summary to msteams notification (#3616) * Add summary to msteams notification Signed-off-by: Roman Kubu <Roman.Kubu@airbank.cz> --------- Signed-off-by: Roman Kubu <Roman.Kubu@airbank.cz> Signed-off-by: romankubu <112698283+romankubu@users.noreply.github.com> Co-authored-by: Jack <jack4zhang@gmail.com>
2023-11-24 08:58:57 +00:00
{{ define "msteams.default.summary" }}{{ template "__subject" . }}{{ end }}
Add msteams (#3324) * Add msteams Signed-off-by: Jack Zhang <jack4zhang@gmail.com> --------- Signed-off-by: Jack Zhang <jack4zhang@gmail.com> Signed-off-by: Jack <jack4zhang@gmail.com>
2023-06-08 15:27:56 +00:00
{{ define "msteams.default.title" }}{{ template "__subject" . }}{{ end }}
{{ define "msteams.default.text" }}
{{ if gt (len .Alerts.Firing) 0 }}
# Alerts Firing:
{{ template "__text_alert_list_markdown" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
# Alerts Resolved:
{{ template "__text_alert_list_markdown" .Alerts.Resolved }}
{{ end }}
{{ end }}
jira integration (#3590) * Initial jira integration Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de> Signed-off-by: Jan-Otto Kröpke <github@jkroepke.de> Signed-off-by: Jan-Otto Kröpke <joe@cloudeteer.de> Co-authored-by: Simon Pasquier <spasquie@redhat.com> Co-authored-by: Ben Kochie <superq@gmail.com>
2024-07-31 15:15:26 +00:00
feat(3920): add msteamsv2 receiver (#4024) * feat(3920): add msteamsv2 receiver Signed-off-by: Simon Schneider <github@simon-schneider.eu> * Don't use `fmt.Errorf` when there's no formatting required on `config/config.go` Signed-off-by: gotjosh <josue.abreu@gmail.com> * Don't use `fmt.Errorf` when there's no formatting required on `config/notifiers.go` Signed-off-by: gotjosh <josue.abreu@gmail.com> * Remove additional documentation steps Signed-off-by: gotjosh <josue.abreu@gmail.com> * add more info to the documentation Signed-off-by: gotjosh <josue.abreu@gmail.com> * Change documentation links to convey the message better Signed-off-by: gotjosh <josue.abreu@gmail.com> --------- Signed-off-by: Simon Schneider <github@simon-schneider.eu> Signed-off-by: gotjosh <josue.abreu@gmail.com> Co-authored-by: gotjosh <josue.abreu@gmail.com>
2024-10-23 10:31:27 +00:00
{{ define "msteamsv2.default.title" }}{{ template "__subject" . }}{{ end }}
{{ define "msteamsv2.default.text" }}
{{ if gt (len .Alerts.Firing) 0 }}
# Alerts Firing:
{{ template "__text_alert_list_markdown" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
# Alerts Resolved:
{{ template "__text_alert_list_markdown" .Alerts.Resolved }}
{{ end }}
{{ end }}
jira integration (#3590) * Initial jira integration Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de> Signed-off-by: Jan-Otto Kröpke <github@jkroepke.de> Signed-off-by: Jan-Otto Kröpke <joe@cloudeteer.de> Co-authored-by: Simon Pasquier <spasquie@redhat.com> Co-authored-by: Ben Kochie <superq@gmail.com>
2024-07-31 15:15:26 +00:00
{{ define "jira.default.summary" }}{{ template "__subject" . }}{{ end }}
{{ define "jira.default.description" }}
{{ if gt (len .Alerts.Firing) 0 }}
# Alerts Firing:
{{ template "__text_alert_list_markdown" .Alerts.Firing }}
{{ end }}
{{ if gt (len .Alerts.Resolved) 0 }}
# Alerts Resolved:
{{ template "__text_alert_list_markdown" .Alerts.Resolved }}
{{ end }}
{{ end }}
{{- define "jira.default.priority" -}}
{{- $priority := "" }}
{{- range .Alerts.Firing -}}
{{- $severity := index .Labels "severity" -}}
{{- if (eq $severity "critical") -}}
{{- $priority = "High" -}}
{{- else if (and (eq $severity "warning") (ne $priority "High")) -}}
{{- $priority = "Medium" -}}
{{- else if (and (eq $severity "info") (eq $priority "")) -}}
{{- $priority = "Low" -}}
{{- end -}}
{{- end -}}
{{- if eq $priority "" -}}
{{- range .Alerts.Resolved -}}
{{- $severity := index .Labels "severity" -}}
{{- if (eq $severity "critical") -}}
{{- $priority = "High" -}}
{{- else if (and (eq $severity "warning") (ne $priority "High")) -}}
{{- $priority = "Medium" -}}
{{- else if (and (eq $severity "info") (eq $priority "")) -}}
{{- $priority = "Low" -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- $priority -}}
{{- end -}}
feat: add rocketchat notifier (#3600) * feat: add rocketchat notifier Signed-off-by: Christoph Maser <christoph.maser+github@gmail.com> Co-authored-by: George Robinson <george.robinson@grafana.com> * Update notify/rocketchat/rocketchat.go Co-authored-by: George Robinson <george.robinson@grafana.com> Signed-off-by: gotjosh <josue.abreu@gmail.com> --------- Signed-off-by: Christoph Maser <christoph.maser+github@gmail.com> Signed-off-by: gotjosh <josue.abreu@gmail.com> Co-authored-by: George Robinson <george.robinson@grafana.com> Co-authored-by: gotjosh <josue.abreu@gmail.com>
2024-10-23 14:38:22 +00:00
{{ define "rocketchat.default.title" }}{{ template "__subject" . }}{{ end }}
{{ define "rocketchat.default.alias" }}{{ template "__alertmanager" . }}{{ end }}
{{ define "rocketchat.default.titlelink" }}{{ template "__alertmanagerURL" . }}{{ end }}
{{ define "rocketchat.default.emoji" }}{{ end }}
{{ define "rocketchat.default.iconurl" }}{{ end }}
{{ define "rocketchat.default.text" }}{{ end }}