diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-15 21:09:05 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-15 21:09:05 +0300 |
commit | a0213db466c75403a5a79f95af8a0a5cff13014c (patch) | |
tree | 6118144407f99f1121c34e934cf0d96c991d578e /doc/operations/incident_management | |
parent | f5c3f32975addd56fe8659f1c346d0e56f0b23d9 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/operations/incident_management')
-rw-r--r-- | doc/operations/incident_management/img/custom_alert_mapping_v13_10.png | bin | 0 -> 100141 bytes | |||
-rw-r--r-- | doc/operations/incident_management/integrations.md | 31 |
2 files changed, 24 insertions, 7 deletions
diff --git a/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png b/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png Binary files differnew file mode 100644 index 00000000000..b2527d3a298 --- /dev/null +++ b/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index d5f3643695a..62a50255dd8 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -57,19 +57,36 @@ and you can [customize the payload](#customize-the-alert-payload-outside-of-gitl 1. Expand the **Alerts** section. 1. For each endpoint you want to create: + 1. Click the **Add new integration** button. 1. In the **Integration** dropdown menu, select **HTTP Endpoint**. 1. Name the integration. - 1. Toggle the **Active** alert setting to display the **URL** and **Authorization Key** - for the webhook configuration. You must also input the URL and Authorization Key - in your external service. - 1. _(Optional)_ To generate a test alert to test the new integration, enter a - sample payload, then click **Save and test alert payload**. Valid JSON is required. - 1. Click **Save Integration**. + 1. Toggle the **Active** alert setting. The **URL** and **Authorization Key** for the webhook + configuration are available in the **View credentials** tab after you save the integration. + You must also input the URL and Authorization Key in your external service. + 1. _(Optional)_ To map fields from your monitoring tool's alert to GitLab fields, enter a sample + payload and click **Parse payload for custom mapping**. Valid JSON is required. If you update + a sample payload, you must also remap the fields. + + 1. _(Optional)_ If you provided a valid sample payload, select each value in + **Payload alert key** to [map to a **GitLab alert key**](#map-fields-in-custom-alerts). + 1. To save your integration, click **Save Integration**. If desired, you can send a test alert + from your integration's **Send test alert** tab after the integration is created. The new HTTP Endpoint displays in the [integrations list](#integrations-list). -You can edit the integration by selecting the **{pencil}** pencil icon on the right +You can edit the integration by selecting the **{settings}** settings icon on the right side of the integrations list. +#### Map fields in custom alerts + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4443) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.10. + +You can integrate your monitoring tool's alert format with GitLab alerts. To show the +correct information in the [Alert list](alerts.md) and the +[Alert Details page](alerts.md#alert-details-page), map your alert's fields to +GitLab fields when you [create an HTTP endpoint](#http-endpoints): + +![Alert Management List](img/custom_alert_mapping_v13_10.png) + ### External Prometheus integration For GitLab versions 13.1 and greater, read |