debian-mirror-gitlab/doc/operations/incident_management/integrations.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

283 lines
11 KiB
Markdown
Raw Normal View History

2021-01-03 14:25:43 +05:30
---
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-01-03 14:25:43 +05:30
---
2021-04-17 20:07:23 +05:30
# Integrations **(FREE)**
2021-01-03 14:25:43 +05:30
2021-11-18 22:05:49 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13203) in GitLab 12.4.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) from GitLab Ultimate to GitLab Free in 12.8.
2021-03-11 19:13:27 +05:30
GitLab can accept alerts from any source via a webhook receiver. This can be configured
2022-07-23 23:45:48 +05:30
generically.
2021-03-11 19:13:27 +05:30
## Integrations list
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab 13.5.
2021-01-03 14:25:43 +05:30
2022-04-04 11:22:00 +05:30
With at least the Maintainer role, you can view the list of configured
2021-09-30 23:02:18 +05:30
alerts integrations by navigating to **Settings > Monitor**
2021-09-04 01:27:46 +05:30
in your project's sidebar menu, and expanding the **Alerts** section. The list displays
2021-04-29 21:17:54 +05:30
the integration name, type, and status (enabled or disabled):
2021-01-03 14:25:43 +05:30
![Current Integrations](img/integrations_list_v13_5.png)
2021-03-11 19:13:27 +05:30
## Configuration
2022-07-23 23:45:48 +05:30
GitLab can receive alerts via a HTTP endpoint that you configure.
2021-03-11 19:13:27 +05:30
2021-11-18 22:05:49 +05:30
### Single HTTP Endpoint
2021-03-11 19:13:27 +05:30
Enabling the HTTP Endpoint in a GitLab projects activates it to
receive alert payloads in JSON format. You can always
[customize the payload](#customize-the-alert-payload-outside-of-gitlab) to your liking.
2022-04-04 11:22:00 +05:30
1. Sign in to GitLab as a user with the Maintainer role
2021-03-11 19:13:27 +05:30
for a project.
2021-09-04 01:27:46 +05:30
1. Navigate to **Settings > Monitor** in your project.
1. Expand the **Alerts** section, and in the **Select integration type** dropdown menu,
2021-04-29 21:17:54 +05:30
select **HTTP Endpoint**.
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.
2021-03-11 19:13:27 +05:30
### HTTP Endpoints **(PREMIUM)**
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4442) in GitLab 13.6.
2021-03-11 19:13:27 +05:30
In [GitLab Premium](https://about.gitlab.com/pricing/), you can create multiple
unique HTTP endpoints to receive alerts from any external source in JSON format,
and you can [customize the payload](#customize-the-alert-payload-outside-of-gitlab).
2022-04-04 11:22:00 +05:30
1. Sign in to GitLab as a user with the Maintainer role
2021-03-11 19:13:27 +05:30
for a project.
2021-09-04 01:27:46 +05:30
1. Navigate to **Settings > Monitor** in your project.
1. Expand the **Alerts** section.
2021-03-11 19:13:27 +05:30
1. For each endpoint you want to create:
2022-07-23 23:45:48 +05:30
1. Select **Add new integration**.
2021-04-29 21:17:54 +05:30
1. In the **Select integration type** dropdown menu, select **HTTP Endpoint**.
2021-03-11 19:13:27 +05:30
1. Name the integration.
2021-04-17 20:07:23 +05:30
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.
2022-01-26 12:08:38 +05:30
1. Optional. To map fields from your monitoring tool's alert to GitLab fields, enter a sample
2022-07-23 23:45:48 +05:30
payload and select **Parse payload for custom mapping**. Valid JSON is required. If you update
2021-04-17 20:07:23 +05:30
a sample payload, you must also remap the fields.
2022-01-26 12:08:38 +05:30
1. Optional. If you provided a valid sample payload, select each value in
2021-04-17 20:07:23 +05:30
**Payload alert key** to [map to a **GitLab alert key**](#map-fields-in-custom-alerts).
2022-07-23 23:45:48 +05:30
1. To save your integration, select **Save Integration**. If desired, you can send a test alert
2021-04-17 20:07:23 +05:30
from your integration's **Send test alert** tab after the integration is created.
2021-03-11 19:13:27 +05:30
The new HTTP Endpoint displays in the [integrations list](#integrations-list).
2021-04-17 20:07:23 +05:30
You can edit the integration by selecting the **{settings}** settings icon on the right
2021-03-11 19:13:27 +05:30
side of the integrations list.
2021-04-17 20:07:23 +05:30
#### Map fields in custom alerts
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4443) in GitLab 13.10.
2021-04-17 20:07:23 +05:30
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):
2021-04-29 21:17:54 +05:30
![Alert Management List](img/custom_alert_mapping_v13_11.png)
2021-04-17 20:07:23 +05:30
2021-03-11 19:13:27 +05:30
## Customize the alert payload outside of GitLab
2021-06-08 01:23:25 +05:30
For HTTP Endpoints without [custom mappings](#map-fields-in-custom-alerts), you can customize the payload by sending the following
2021-04-17 20:07:23 +05:30
parameters. All fields are optional. If the incoming alert does not contain a value for the `Title` field, a default value of `New: Alert` will be applied.
2021-03-11 19:13:27 +05:30
| Property | Type | Description |
| ------------------------- | --------------- | ----------- |
2021-06-08 01:23:25 +05:30
| `title` | String | The title of the alert.|
2021-03-11 19:13:27 +05:30
| `description` | String | A high-level summary of the problem. |
2021-06-08 01:23:25 +05:30
| `start_time` | DateTime | The time of the alert. If none is provided, a current time is used. |
| `end_time` | DateTime | The resolution time of the alert. If provided, the alert is resolved. |
2021-03-11 19:13:27 +05:30
| `service` | String | The affected service. |
2021-06-08 01:23:25 +05:30
| `monitoring_tool` | String | The name of the associated monitoring tool. |
2021-03-11 19:13:27 +05:30
| `hosts` | String or Array | One or more hosts, as to where this incident occurred. |
| `severity` | String | The severity of the alert. Case-insensitive. Can be one of: `critical`, `high`, `medium`, `low`, `info`, `unknown`. Defaults to `critical` if missing or value is not in this list. |
| `fingerprint` | String or Array | The unique identifier of the alert. This can be used to group occurrences of the same alert. |
| `gitlab_environment_name` | String | The name of the associated GitLab [environment](../../ci/environments/index.md). Required to [display alerts on a dashboard](../../user/operations_dashboard/index.md#adding-a-project-to-the-dashboard). |
You can also add custom fields to the alert's payload. The values of extra
parameters aren't limited to primitive types (such as strings or numbers), but
can be a nested JSON object. For example:
```json
{ "foo": { "bar": { "baz": 42 } } }
```
NOTE:
Ensure your requests are smaller than the
[payload application limits](../../administration/instance_limits.md#generic-alert-json-payloads).
2021-11-18 22:05:49 +05:30
### Example request body
2021-03-11 19:13:27 +05:30
Example payload:
```json
{
"title": "Incident title",
"description": "Short description of the incident",
"start_time": "2019-09-12T06:00:55Z",
"service": "service affected",
"monitoring_tool": "value",
"hosts": "value",
"severity": "high",
"fingerprint": "d19381d4e8ebca87b55cda6e8eee7385",
"foo": {
"bar": {
"baz": 42
}
}
}
```
2021-11-18 22:05:49 +05:30
## Authorization
The following authorization methods are accepted:
- Bearer authorization header
- Basic authentication
The `<authorization_key>` and `<url>` values can be found when configuring an alert integration.
### Bearer authorization header
The authorization key can be used as the Bearer token:
```shell
curl --request POST \
--data '{"title": "Incident title"}' \
--header "Authorization: Bearer <authorization_key>" \
--header "Content-Type: application/json" \
<url>
```
### Basic authentication
The authorization key can be used as the `password`. The `username` is left blank:
- username: `<blank>`
2022-01-26 12:08:38 +05:30
- password: authorization_key
2021-11-18 22:05:49 +05:30
```shell
curl --request POST \
--data '{"title": "Incident title"}' \
--header "Authorization: Basic <base_64_encoded_credentials>" \
--header "Content-Type: application/json" \
<url>
```
Basic authentication can also be used with credentials directly in the URL:
```shell
curl --request POST \
--data '{"title": "Incident title"}' \
--header "Content-Type: application/json" \
<username:password@url>
```
WARNING:
Using your authorization key in the URL is insecure, as it's visible in server logs. We recommend
using one of the above header options if your tooling supports it.
2021-12-11 22:18:48 +05:30
## Response body
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342730) in GitLab 14.5.
The JSON response body contains a list of any alerts created within the request:
```json
[
{
"iid": 1,
"title": "Incident title"
},
{
"iid": 2,
"title": "Second Incident title"
}
]
```
Successful responses return a `200` response code.
2021-03-11 19:13:27 +05:30
## Triggering test alerts
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab in 13.2.
2021-03-11 19:13:27 +05:30
After a [project maintainer or owner](../../user/permissions.md)
configures an integration, you can trigger a test
alert to confirm your integration works properly.
2022-04-04 11:22:00 +05:30
1. Sign in as a user with at least the Developer role.
2021-09-04 01:27:46 +05:30
1. Navigate to **Settings > Monitor** in your project.
2022-07-23 23:45:48 +05:30
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).
2021-04-29 21:17:54 +05:30
1. Select the **Send test alert** tab to open it.
1. Enter a test payload in the payload field (valid JSON is required).
2022-07-23 23:45:48 +05:30
1. Select **Send**.
2021-03-11 19:13:27 +05:30
GitLab displays an error or success message, depending on the outcome of your test.
## Automatic grouping of identical alerts **(PREMIUM)**
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214557) in GitLab 13.2.
2021-03-11 19:13:27 +05:30
In GitLab versions 13.2 and greater, GitLab groups alerts based on their
payload. When an incoming alert contains the same payload as another alert
(excluding the `start_time` and `hosts` attributes), GitLab groups these alerts
together and displays a counter on the [Alert Management List](incidents.md)
and details pages.
If the existing alert is already `resolved`, GitLab creates a new alert instead.
![Alert Management List](img/alert_list_v13_1.png)
2021-06-08 01:23:25 +05:30
## Recovery alerts
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4.
The alert in GitLab will be automatically resolved when an HTTP Endpoint
receives a payload with the end time of the alert set. For HTTP Endpoints
without [custom mappings](#map-fields-in-custom-alerts), the expected
field is `end_time`. With custom mappings, you can select the expected field.
You can also configure the associated [incident to be closed automatically](../incident_management/incidents.md#automatically-close-incidents-via-recovery-alerts) when the alert resolves.
2021-11-18 22:05:49 +05:30
## Link to your Opsgenie Alerts **(PREMIUM)**
2021-03-11 19:13:27 +05:30
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.2.
2021-03-11 19:13:27 +05:30
WARNING:
We are building deeper integration with Opsgenie and other alerting tools through
[HTTP endpoint integrations](#single-http-endpoint) so you can see alerts in
the GitLab interface. As a result, the previous direct link to Opsgenie Alerts from
the GitLab alerts list is deprecated in
GitLab versions [13.8 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/273657).
You can monitor alerts using a GitLab integration with [Opsgenie](https://www.atlassian.com/software/opsgenie).
If you enable the Opsgenie integration, you can't have other GitLab alert
services
active at the same time.
To enable Opsgenie integration:
2022-04-04 11:22:00 +05:30
1. Sign in as a user with the Maintainer or Owner role.
2021-09-04 01:27:46 +05:30
1. Navigate to **Monitor > Alerts**.
2021-03-11 19:13:27 +05:30
1. In the **Integrations** select box, select **Opsgenie**.
1. Select the **Active** toggle.
1. In the **API URL** field, enter the base URL for your Opsgenie integration,
such as `https://app.opsgenie.com/alert/list`.
1. Select **Save changes**.
After you enable the integration, navigate to the Alerts list page at
2021-09-04 01:27:46 +05:30
**Monitor > Alerts**, and then select **View alerts in Opsgenie**.