diff options
Diffstat (limited to 'doc/operations/incident_management/integrations.md')
| -rw-r--r-- | doc/operations/incident_management/integrations.md | 25 |
1 files changed, 8 insertions, 17 deletions
diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index fe05cb9fda0..6e65fe875c5 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -10,9 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) from GitLab Ultimate to GitLab Free in 12.8. GitLab can accept alerts from any source via a webhook receiver. This can be configured -generically or, in GitLab versions 13.1 and greater, you can configure -[External Prometheus instances](../metrics/alerts.md#external-prometheus-instances) -to use this endpoint. +generically. ## Integrations list @@ -27,8 +25,7 @@ the integration name, type, and status (enabled or disabled): ## Configuration -GitLab can receive alerts via a HTTP endpoint that you configure, -or the [Prometheus integration](#external-prometheus-integration). +GitLab can receive alerts via a HTTP endpoint that you configure. ### Single HTTP Endpoint @@ -59,19 +56,19 @@ 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. Select **Add new integration**. 1. In the **Select integration type** dropdown menu, select **HTTP Endpoint**. 1. Name the 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 + payload and select **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 + 1. To save your integration, select **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). @@ -89,12 +86,6 @@ GitLab fields when you [create an HTTP endpoint](#http-endpoints):  -### External Prometheus integration - -For GitLab versions 13.1 and greater, read -[External Prometheus Instances](../metrics/alerts.md#external-prometheus-instances) -to configure alerts for this integration. - ## Customize the alert payload outside of GitLab For HTTP Endpoints without [custom mappings](#map-fields-in-custom-alerts), you can customize the payload by sending the following @@ -227,11 +218,11 @@ alert to confirm your integration works properly. 1. Sign in as a user with at least the Developer role. 1. Navigate to **Settings > Monitor** in your project. -1. Click **Alerts** to expand the section. -1. Click the **{settings}** settings icon on the right side of the integration in [the list](#integrations-list). +1. Select **Alerts** to expand the section. +1. Select the **{settings}** settings icon on the right side of the integration in [the list](#integrations-list). 1. Select the **Send test alert** tab to open it. 1. Enter a test payload in the payload field (valid JSON is required). -1. Click **Send**. +1. Select **Send**. GitLab displays an error or success message, depending on the outcome of your test. |