• configuration 配置
    • 配置文件
      • 示例

    configuration 配置

    Alertmanager通过命令行和一个配置文件配置。命令行配置不可变的系统参数，而配置文件定义inhibiton规则，通知路由和通知接收者。

    可视化编辑器可以帮助构建路由树。

    如果想要查看所有命令，请使用命令alertmanager -h。

    Alertmanager能够在运行时动态加载配置文件。如果新的配置有错误，则配置中的变化不会生效，同时错误日志被输出到终端。通过发送SIGHUP信号量给这个进程，或者通过HTTP POST请求/-/reload，Alertmanager配置动态加载到内存。

    配置文件

    使用-config.file指定要加载的配置文件

    ./alertmanager -config.file=simple.yml

    这个配置文件使用yaml格式编写的，括号表示参数是可选的，对于非列表参数，该值将设置为指定的默认值。

    • <duration>: 与正则表达式匹配的持续时间[0-9]+(ms|[smhdwy])
    • <labeltime>: 与正则表达式匹配的字符串[a-zA-Z_][a-zA-Z0-9_]*
    • <filepath>: 当前工作目录下的有效路径
    • <boolean>: 布尔值： false 或者 true。
    • <string>: 常规字符串
    • <tmpl_string>: 一个在使用前被模板扩展的字符串

    其他占位符被分开指定， 一个有效的示例，点击这里

    全局配置指定的参数在所有其他上下文配置中是有效的。它们也作为其他区域的默认值。

    1. global:
    2.   # ResolveTimeout is the time after which an alert is declared resolved
    3.   # if it has not been updated.
    4.   [ resolve_timeout: <duration> | default = 5m ]
    6.   # The default SMTP From header field.
    7.   [ smtp_from: <tmpl_string> ]
    8.   # The default SMTP smarthost used for sending emails.
    9.   [ smtp_smarthost: <string> ]
    10.   # SMTP authentication information.
    11.   [ smtp_auth_username: <string> ]
    12.   [ smtp_auth_password: <string> ]
    13.   [ smtp_auth_secret: <string> ]
    14.   # The default SMTP TLS requirement.
    15.   [ smtp_require_tls: <bool> | default = true ]
    17.   # The API URL to use for Slack notifications.
    18.   [ slack_api_url: <string> ]
    20.   [ pagerduty_url: <string> | default = "https://events.pagerduty.com/generic/2010-04-15/create_event.json" ]
    21.   [ opsgenie_api_host: <string> | default = "https://api.opsgenie.com/" ]
    22.   [ hipchat_url: <string> | default = "https://api.hipchat.com/" ]
    23.   [ hipchat_auth_token: <string> ]
    25. # Files from which custom notification template definitions are read.
    26. # The last component may use a wildcard matcher, e.g. 'templates/*.tmpl'.
    27. templates:
    28.   [ - <filepath> ... ]
    30. # The root node of the routing tree.
    31. route: <route>
    33. # A list of notification receivers.
    34. receivers:
    35.   - <receiver> ...
    37. # A list of inhibition rules.
    38. inhibit_rules:
    39.   [ - <inhibit_rule> ... ]

    一个路由块在路由树和它的孩子中定义了一个节点。如果不设置，它的可选配置参数从父节点中继承其值。

    每个警报在已配置路由树的顶部节点，这个节点必须匹配所有警报。然后遍历所有的子节点。如果continue设置成false, 当匹配到第一个孩子时，它会停止下来；如果continue设置成true, 则警报将继续匹配后续的兄弟姐妹节点。如果一个警报不匹配一个节点的任何孩子，这个警报将会基于当前节点的配置参数来处理警报。

    1. [ receiver: <string> ]
    2. [ group_by: '[' <labelname>, ... ']' ]
    4. # Whether an alert should continue matching subsequent sibling nodes.
    5. [ continue: <boolean> | default = false ]
    7. # A set of equality matchers an alert has to fulfill to match the node.
    8. match:
    9.   [ <labelname>: <labelvalue>, ... ]
    11. # A set of regex-matchers an alert has to fulfill to match the node.
    12. match_re:
    13.   [ <labelname>: <regex>, ... ]
    15. # How long to initially wait to send a notification for a group
    16. # of alerts. Allows to wait for an inhibiting alert to arrive or collect
    17. # more initial alerts for the same group. (Usually ~0s to few minutes.)
    18. [ group_wait: <duration> ]
    20. # How long to wait before sending notification about new alerts that are
    21. # in are added to a group of alerts for which an initial notification
    22. # has already been sent. (Usually ~5min or more.)
    23. [ group_interval: <duration> ]
    25. # How long to wait before sending a notification again if it has already
    26. # been sent successfully for an alert. (Usually ~3h or more).
    27. [ repeat_interval: <duration> ]
    29. # Zero or more child routes.
    30. routes:
    31.   [ - <route> ... ]

    示例

    1. # The root route with all parameters, which are inherited by the child
    2. # routes if they are not overwritten.
    3. route:
    4.   receiver: 'default-receiver'
    5.   group_wait: 30s
    6.   group_interval: 5m
    7.   repeat_interval: 4h
    8.   group_by: [cluster, alertname]
    9.   # All alerts that do not match the following child routes
    10.   # will remain at the root node and be dispatched to 'default-receiver'.
    11.   routes:
    12.   # All alerts with service=mysql or service=cassandra
    13.   # are dispatched to the database pager.
    14.   - receiver: 'database-pager'
    15.     group_wait: 10s
    16.     match_re:
    17.       service: mysql|cassandra
    18.   # All alerts with the team=frontend label match this sub-route.
    19.   # They are grouped by product and environment rather than cluster
    20.   # and alertname.
    21.   - receiver: 'frontend-pager'
    22.     group_by: [product, environment]
    23.     match:
    24.       team: frontend

    一个inhibition规则是在与另一组匹配器匹配的警报存在的条件下，使匹配一组匹配器的警报失效的规则。两个警报必须具有一组相同的标签。

    1. # Matchers that have to be fulfilled in the alerts to be muted.
    2. target_match:
    3.   [ <labelname>: <labelvalue>, ... ]
    4. target_match_re:
    5.   [ <labelname>: <regex>, ... ]
    7. # Matchers for which one or more alerts have to exist for the
    8. # inhibition to take effect.
    9. source_match:
    10.   [ <labelname>: <labelvalue>, ... ]
    11. source_match_re:
    12.   [ <labelname>: <regex>, ... ]
    14. # Labels that must have an equal value in the source and target
    15. # alert for the inhibition to take effect.
    16. [ equal: '[' <labelname>, ... ']' ]

    接收者是一个或者多个通知集成的命名配置

    Alertmanager在v0.0.4中可用的其他接收器尚未实现。我们乐意接受任何贡献，并将其添加到新的实现中

    1. # The unique name of the receiver.
    2. name: <string>
    4. # Configurations for several notification integrations.
    5. email_configs:
    6.   [ - <email_config>, ... ]
    7. hipchat_configs:
    8.   [ - <hipchat_config>, ... ]
    9. pagerduty_configs:
    10.   [ - <pagerduty_config>, ... ]
    11. pushover_configs:
    12.   [ - <pushover_config>, ... ]
    13. slack_configs:
    14.   [ - <slack_config>, ... ]
    15. opsgenie_configs:
    16.   [ - <opsgenie_config>, ... ]
    17. webhook_configs:
    18.   [ - <webhook_config>, ... ]

    1. # Whether or not to notify about resolved alerts.
    2. [ send_resolved: <boolean> | default = false ]
    4. # The email address to send notifications to.
    5. to: <tmpl_string>
    6. # The sender address.
    7. [ from: <tmpl_string> | default = global.smtp_from ]
    8. # The SMTP host through which emails are sent.
    9. [ smarthost: <string> | default = global.smtp_smarthost ]
    10. # SMTP authentication information.
    11. [ auth_username: <string> ]
    12. [ auth_password: <string> ]
    13. [ auth_secret: <string> ]
    14. [ auth_identity: <string> ]
    16. [ require_tls: <bool> | default = global.smtp_require_tls ]
    18. # The HTML body of the email notification.
    19. [ html: <tmpl_string> | default = '{{ template "email.default.html" . }}' ]
    21. # Further headers email header key/value pairs. Overrides any headers
    22. # previously set by the notification implementation.
    23. [ headers: { <string>: <tmpl_string>, ... } ]

    1. # Whether or not to notify about resolved alerts.
    2. [ send_resolved: <boolean> | default = false ]
    4. # The HipChat Room ID.
    5. room_id: <tmpl_string>
    6. # The auth token.
    7. [ auth_token: <string> | default = global.hipchat_auth_token ]
    8. # The URL to send API requests to.
    9. [ url: <string> | default = global.hipchat_url ]
    11. # See https://www.hipchat.com/docs/apiv2/method/send_room_notification
    12. # A label to be shown in addition to the sender's name.
    13. [ from:  <tmpl_string> | default = '{{ template "hipchat.default.from" . }}' ]
    14. # The message body.
    15. [ message:  <tmpl_string> | default = '{{ template "hipchat.default.message" . }}' ]
    16. # Whether this message should trigger a user notification.
    17. [ notify:  <boolean> | default = false ]
    18. # Determines how the message is treated by the alertmanager and rendered inside HipChat. Valid values are 'text' and 'html'.
    19. [ message_format:  <string> | default = 'text' ]
    20. # Background color for message.
    21. [ color:  <tmpl_string> | default = '{{ if eq .Status "firing" }}red{{ else }}green{{ end }}' ]

    通过PagerDuty ApI发送通知：

    1. # Whether or not to notify about resolved alerts.
    2. [ send_resolved: <boolean> | default = true ]
    4. # The PagerDuty service key.
    5. service_key: <tmpl_string>
    6. # The URL to send API requests to
    7. [ url: <string> | default = global.pagerduty_url ]
    9. # The client identification of the Alertmanager.
    10. [ client:  <tmpl_string> | default = '{{ template "pagerduty.default.client" . }}' ]
    11. # A backlink to the sender of the notification.
    12. [ client_url:  <tmpl_string> | default = '{{ template "pagerduty.default.clientURL" . }}' ]
    14. # A description of the incident.
    15. [ description: <tmpl_string> | default = '{{ template "pagerduty.default.description" .}}' ]
    17. # A set of arbitrary key/value pairs that provide further detail
    18. # about the incident.
    19. [ details: { <string>: <tmpl_string>, ... } | default = {
    20.   firing:       '{{ template "pagerduty.default.instances" .Alerts.Firing }}'
    21.   resolved:     '{{ template "pagerduty.default.instances" .Alerts.Resolved }}'
    22.   num_firing:   '{{ .Alerts.Firing | len }}'
    23.   num_resolved: '{{ .Alerts.Resolved | len }}'
    24. } ]

    通过PUSHover API发送通知：

    1. # The recipient user’s user key.
    2. user_key: <string>
    4. # Your registered application’s API token, see https://pushover.net/apps
    5. token: <string>
    7. # Notification title.
    8. [ title: <tmpl_string> | default = '{{ template "pushover.default.title" . }}' ]
    10. # Notification message.
    11. [ message: <tmpl_string> | default = '{{ template "pushover.default.message" . }}' ]
    13. # A supplementary URL shown alongside the message.
    14. [ url: <tmpl_string> | default = '{{ template "pushover.default.url" . }}' ]
    16. # Priority, see https://pushover.net/api#priority
    17. [ priority: <tmpl_string> | default = '{{ if eq .Status "firing" }}2{{ else }}0{{ end }}' ]
    19. # How often the Pushover servers will send the same notification to the user.
    20. # Must be at least 30 seconds.
    21. [ retry: <duration> | default = 1m ]
    23. # How long your notification will continue to be retried for, unless the user
    24. # acknowledges the notification.
    25. [ expire: <duration> | default = 1h ]

    通过Slack webhooks发送通知：

    1. # Whether or not to notify about resolved alerts.
    2. [ send_resolved: <boolean> | default = false ]
    4. # The Slack webhook URL.
    5. [ api_url: <string> | default = global.slack_api_url ]
    7. # The channel or user to send notifications to.
    8. channel: <tmpl_string>
    10. # API request data as defined by the Slack webhook API.
    11. [ color: <tmpl_string> | default = '{{ if eq .Status "firing" }}danger{{ else }}good{{ end }}' ]
    12. [ username: <tmpl_string> | default = '{{ template "slack.default.username" . }}'
    13. [ title: <tmpl_string> | default = '{{ template "slack.default.title" . }}' ]
    14. [ title_link: <tmpl_string> | default = '{{ template "slack.default.titlelink" . }}' ]
    15. [ icon_emoji: <tmpl_string> ]
    16. [ icon_url: <tmpl_string> ]
    17. [ pretext: <tmpl_string> | default = '{{ template "slack.default.pretext" . }}' ]
    18. [ text: <tmpl_string> | default = '{{ template "slack.default.text" . }}' ]
    19. [ fallback: <tmpl_string> | default = '{{ template "slack.default.fallback" . }}' ]

    通过OpsGenie API发送通知:

    1. # Whether or not to notify about resolved alerts.
    2. [ send_resolved: <boolean> | default = true ]
    4. # The API key to use when talking to the OpsGenie API.
    5. api_key: <string>
    7. # The host to send OpsGenie API requests to.
    8. [ api_host: <string> | default = global.opsgenie_api_host ]
    10. # A description of the incident.
    11. [ description: <tmpl_string> | default = '{{ template "opsgenie.default.description" . }}' ]
    12. # A backlink to the sender of the notification.
    13. [ source: <tmpl_string> | default = '{{ template "opsgenie.default.source" . }}' ]
    15. # A set of arbitrary key/value pairs that provide further detail
    16. # about the incident.
    17. [ details: { <string>: <tmpl_string>, ... } ]
    19. # Comma separated list of team responsible for notifications.
    20. [ teams: <tmpl_string> ]
    21. # Comma separated list of tags attached to the notifications.
    22. [ tags: <tmpl_string> ]

    webhook接收者允许配置一个通用的接收者

    1. # Whether or not to notify about resolved alerts.
    2. [ send_resolved: <boolean> | default = true ]
    4. # The endpoint to send HTTP POST requests to.
    5. url: <string>

    Alertmanager通过HTTP POST请求发送json格式的数据到配置端点：

    1. {
    2.   "version": "3",
    3.   "groupKey": <number>     // key identifying the group of alerts (e.g. to deduplicate)
    4.   "status": "<resolved|firing>",
    5.   "receiver": <string>,
    6.   "groupLabels": <object>,
    7.   "commonLabels": <object>,
    8.   "commonAnnotations": <object>,
    9.   "externalURL": <string>,  // backling to the Alertmanager.
    10.   "alerts": [
    11.     {
    12.       "labels": <object>,
    13.       "annotations": <object>,
    14.       "startsAt": "<rfc3339>",
    15.       "endsAt": "<rfc3339>"
    16.     },
    17.     ...
    18.   ]
    19. }