diff options
| author | Peter Leitzen <pleitzen@gitlab.com> | 2019-07-15 13:50:35 +0200 |
|---|---|---|
| committer | Peter Leitzen <pleitzen@gitlab.com> | 2019-07-15 13:50:35 +0200 |
| commit | 02787c59fb6490bb399ad372ac29b62371681d5b (patch) | |
| tree | f01d159691c9f2559a7c2f23b7f215daa8f610ed | |
| parent | c29da98f5296d894e8f4e0694bb008169a5bb6a8 (diff) | |
| download | gitlab-ce-pl-incident-issue-alert-payload-docs.tar.gz | |
Add docs on how alert attributes are usedpl-incident-issue-alert-payload-docs
| -rw-r--r-- | doc/user/project/integrations/prometheus.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 765aa91b00f..8614b58f751 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -232,7 +232,16 @@ Alerts can be used to trigger actions, like open an issue automatically (enabled 1. Optionally, select whether to send an email notification to the developers of the project. 1. Click **Save changes**. -Once enabled, an issue will be opened automatically when an alert is triggered. The author of the issue will be the GitLab Alert Bot. To further customize the issue, you can add labels, mentions, or any other supported [quick action](../quick_actions.md) in the selected issue template. +Once enabled, an issue will be opened automatically when an alert is triggered which contains values extracted from [alert's payload][prometheus-webhook-config]: + +* issue author - `GitLab Alert Bot` +* issue title - extract from `annotations/title`, `annotations/summary` or `labels/alertname` +* alert `Summary` - a list of properties + * `starts_at` - alert start time via `startsAt` + * `full_query` - alert query extracted from `generatorURL` + * optional list of attached annotations extracted from `annotations/*` + +To further customize the issue, you can add labels, mentions, or any other supported [quick action](../quick_actions.md) in the selected issue template. If the metric exceeds the threshold of the alert for over 5 minutes, an email will be sent to all [Maintainers and Owners](../../permissions.md#project-members-permissions) of the project. @@ -274,6 +283,7 @@ If the "No data found" screen continues to appear, it could be due to: [gitlab-prometheus-k8s-monitor]: ../../../administration/monitoring/prometheus/index.md#configuring-prometheus-to-monitor-kubernetes [prometheus-docker-image]: https://hub.docker.com/r/prom/prometheus/ [prometheus-yml]:samples/prometheus.yml +[prometheus-webhook-config]: https://prometheus.io/docs/alerting/configuration/#webhook_config [gitlab.com-ip-range]: https://gitlab.com/gitlab-com/infrastructure/issues/434 [ci-environment-slug]: ../../../ci/variables/#predefined-environment-variables [ce-8935]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8935 |