RepoMirrors/alertmanager
1
0
Fork 0
mirror of https://github.com/prometheus/alertmanager synced 2025-01-11 16:29:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add config docs

Browse Source 
Signed-off-by: Tyler Reid <tyler.reid@grafana.com>
This commit is contained in:
Tyler Reid 2021-06-15 18:03:02 -05:00
parent b509a5bdbb
commit 8d3b1b5896
1 changed files with 57 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
docs/configuration.md
View File

@ -691,6 +691,63 @@ value: <tmpl_string>
[ short: <boolean> | default = slack_config.short_fields ]
```
## `<sns_configs>`
```yaml
# Whether or not to notify about resolved alerts.
[ send_resolved: <boolean> | default = false ]
# The SNS API URL i.e. https://sns.us-east-2.amazonaws.com
[api_url: <tmpl_string>]
# The SNS API version i.e.
[ api_version: <tmpl_string> | default = sns.default.api_version ]
# Configures AWS's Signature Verification 4 signing process to sign requests.
sigv4:
[ <sigv4_config> ]
# SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic
# If you don't specify this value, you must specify a value for the phone_number or target_arn.
[ topic_arn: <tmpl_string>]
# Subject line when the message is delivered to email endpoints.
[ subject: <tmpl_string> | default = '{{ template "sns.default.subject" .}}' ]
# Phone number if message is delivered via SMS in E.164 format.
# If you don't specify this value, you must specify a value for the topic_arn or target_arn.
[ phone_number: <tmpl_string> ]
# The mobile platform endpoint ARN if message is delivered via mobile notifications.
# If you don't specify this value, you must specify a value for the topic_arn or phone_number.
[ target_arn: <tmpl_string> ]
# The message content of the SNS notification.
[ message: <tmpl_string> | default = '{{ template "sns.default.message" .}}' ]
# SNS message attributes.
attributes:
[key : value]
# The HTTP client's configuration.
[ http_config: <http_config> | default = global.http_config ]
```
###`<sigv4_config>`
```yaml
# The AWS region. If blank, the region from the default credentials chain is used.
[ region: <string> ]
# The AWS API keys. Both access_key and secret_key must be supplied or both must be blank.
# If blank the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are used.
[ access_key: <string> ]
[ secret_key: <secret> ]
# Named AWS profile used to authenticate.
[ profile: <string> ]
# AWS Role ARN, an alternative to using AWS API keys.
[ role_arn: <string> ]
```
## `<matcher>`
A matcher is a string with a syntax inspired by PromQL and OpenMetrics. The syntax of a matcher consists of three tokens: