diff --git a/docs/configuration.md b/docs/configuration.md index 6ba89a8d..fd82817f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -435,18 +435,20 @@ name: # Configurations for several notification integrations. email_configs: [ - , ... ] +opsgenie_configs: + [ - , ... ] pagerduty_configs: [ - , ... ] pushover_configs: [ - , ... ] slack_configs: [ - , ... ] -opsgenie_configs: - [ - , ... ] -webhook_configs: - [ - , ... ] +sns_configs: + [ - , ... ] victorops_configs: [ - , ... ] +webhook_configs: + [ - , ... ] wechat_configs: [ - , ... ] ``` @@ -454,7 +456,7 @@ wechat_configs: ## `` ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = false ] # The email address to send notifications to. @@ -493,13 +495,74 @@ tls_config: [ headers: { : , ... } ] ``` +## `` + +OpsGenie notifications are sent via the [OpsGenie API](https://docs.opsgenie.com/docs/alert-api). + +```yaml +# Whether to notify about resolved alerts. +[ send_resolved: | default = true ] + +# The API key to use when talking to the OpsGenie API. +[ api_key: | default = global.opsgenie_api_key ] + +# The host to send OpsGenie API requests to. +[ api_url: | default = global.opsgenie_api_url ] + +# Alert text limited to 130 characters. +[ message: ] + +# A description of the alert. +[ description: | default = '{{ template "opsgenie.default.description" . }}' ] + +# A backlink to the sender of the notification. +[ source: | default = '{{ template "opsgenie.default.source" . }}' ] + +# A set of arbitrary key/value pairs that provide further detail +# about the alert. +# All common labels are included as details by default. +[ details: { : , ... } ] + +# List of responders responsible for notifications. +responders: + [ - ... ] + +# Comma separated list of tags attached to the notifications. +[ tags: ] + +# Additional alert note. +[ note: ] + +# Priority level of alert. Possible values are P1, P2, P3, P4, and P5. +[ priority: ] + +# Whether to update message and description of the alert in OpsGenie if it already exists +# By default, the alert is never updated in OpsGenie, the new message only appears in activity log. +[ update_alerts: | default = false ] + +# The HTTP client's configuration. +[ http_config: | default = global.http_config ] +``` + +### `` + +```yaml +# Exactly one of these fields should be defined. +[ id: ] +[ name: ] +[ username: ] + +# "team", "user", "escalation" or "schedule". +type: +``` + ## `` PagerDuty notifications are sent via the [PagerDuty API](https://developer.pagerduty.com/documentation/integration/events). PagerDuty provides [documentation](https://www.pagerduty.com/docs/guides/prometheus-integration-guide/) on how to integrate. There are important differences with Alertmanager's v0.11 and greater support of PagerDuty's Events API v2. ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = true ] # The following two options are mutually exclusive. @@ -576,7 +639,7 @@ text: Pushover notifications are sent via the [Pushover API](https://pushover.net/api). ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = true ] # The recipient user's user key. @@ -618,7 +681,7 @@ webhooks](https://api.slack.com/incoming-webhooks). The notification contains an [attachment](https://api.slack.com/docs/message-attachments). ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = false ] # The Slack webhook URL. Either api_url or api_url_file should be set. @@ -693,9 +756,9 @@ value: [ short: | default = slack_config.short_fields ] ``` -## `` +## `` ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = true ] # The SNS API URL i.e. https://sns.us-east-2.amazonaws.com. @@ -734,7 +797,7 @@ attributes: [ http_config: | default = global.http_config ] ``` -###`` +### `` ```yaml # The AWS region. If blank, the region from the default credentials chain is used. [ region: ] @@ -801,74 +864,12 @@ matchers: {quote=~"She said: \"Hi, all!( How're you…)?\""} ``` - -## `` - -OpsGenie notifications are sent via the [OpsGenie API](https://docs.opsgenie.com/docs/alert-api). - -```yaml -# Whether or not to notify about resolved alerts. -[ send_resolved: | default = true ] - -# The API key to use when talking to the OpsGenie API. -[ api_key: | default = global.opsgenie_api_key ] - -# The host to send OpsGenie API requests to. -[ api_url: | default = global.opsgenie_api_url ] - -# Alert text limited to 130 characters. -[ message: ] - -# A description of the alert. -[ description: | default = '{{ template "opsgenie.default.description" . }}' ] - -# A backlink to the sender of the notification. -[ source: | default = '{{ template "opsgenie.default.source" . }}' ] - -# A set of arbitrary key/value pairs that provide further detail -# about the alert. -# All common labels are included as details by default. -[ details: { : , ... } ] - -# List of responders responsible for notifications. -responders: - [ - ... ] - -# Comma separated list of tags attached to the notifications. -[ tags: ] - -# Additional alert note. -[ note: ] - -# Priority level of alert. Possible values are P1, P2, P3, P4, and P5. -[ priority: ] - -# Whether or not to update message and description of the alert in OpsGenie if it already exists -# By default, the alert is never updated in OpsGenie, the new message only appears in activity log. -[ update_alerts: | default = false ] - -# The HTTP client's configuration. -[ http_config: | default = global.http_config ] -``` - -### `` - -```yaml -# Exactly one of these fields should be defined. -[ id: ] -[ name: ] -[ username: ] - -# "team", "user", "escalation" or "schedule". -type: -``` - ## `` VictorOps notifications are sent out via the [VictorOps API](https://help.victorops.com/knowledge-base/victorops-restendpoint-integration/) ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = true ] # The API key to use when talking to the VictorOps API. @@ -901,7 +902,7 @@ routing_key: The webhook receiver allows configuring a generic receiver. ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = true ] # The endpoint to send HTTP POST requests to. @@ -956,7 +957,7 @@ WeChat notifications are sent via the [WeChat API](http://admin.wechat.com/wiki/index.php?title=Customer_Service_Messages). ```yaml -# Whether or not to notify about resolved alerts. +# Whether to notify about resolved alerts. [ send_resolved: | default = false ] # The API key to use when talking to the WeChat API.