diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2019-07-15 17:57:51 +0300 |
|---|---|---|
| committer | 🤖 GitLab Bot 🤖 <gitlab-bot@gitlab.com> | 2019-07-15 18:27:31 +0300 |
| commit | 0d9afa5d6c7aa7a927cbb20aef2a4fce586748d4 (patch) | |
| tree | d4c4e833eae0ec9e63b9e3206b0c8d0ff830ab33 /doc/user/project | |
| parent | 92d536a03120b7095b2a78553e76f1913c30e7a9 (diff) | |
Merge branch 'pl-incident-issue-alert-payload-docs' into 'master'
Add docs on how alert attributes are used
See merge request gitlab-org/gitlab-ce!30736
(cherry picked from commit 7fc35ac124f6437e4d04f17416a4e8af9f7a220b)
02787c59 Add docs on how alert attributes are used
4821406c Apply suggestion to doc/user/project/integrations/prometheus.md
9bdaea60 Apply suggestion to doc/user/project/integrations/prometheus.md
fff0495f Apply suggestion to doc/user/project/integrations/prometheus.md
Diffstat (limited to 'doc/user/project')
| -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..0d35d557c98 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -232,7 +232,17 @@ 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](https://prometheus.io/docs/alerting/configuration/#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. |