Commit 35beac59 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'sarnold-alert-management-ingestion-documentation' into 'master'

Add populating section to alert management docs, and mention severity

See merge request gitlab-org/gitlab!31567
parents 976ab01d 52ba7f1c
...@@ -32,12 +32,13 @@ You can customize the payload by sending the following parameters. All fields ar ...@@ -32,12 +32,13 @@ You can customize the payload by sending the following parameters. All fields ar
| Property | Type | Description | | Property | Type | Description |
| -------- | ---- | ----------- | | -------- | ---- | ----------- |
| `title` | String | The title of the incident. If none is provided, then `New: Incident #N` will be used, where `#N` is the number of incident | | `title` | String | The title of the incident. Required. |
| `description` | String | A high-level summary of the problem. | | `description` | String | A high-level summary of the problem. |
| `start_time` | DateTime | The time of the incident. If none is provided, a timestamp of the issue will be used. | | `start_time` | DateTime | The time of the incident. If none is provided, a timestamp of the issue will be used. |
| `service` | String | The affected service. | | `service` | String | The affected service. |
| `monitoring_tool` | String | The name of the associated monitoring tool. | | `monitoring_tool` | String | The name of the associated monitoring tool. |
| `hosts` | String or Array | One or more hosts, as to where this incident occurred. | | `hosts` | String or Array | One or more hosts, as to where this incident occurred. |
| `severity` | String | The severity of the alert. Must be one of `critical`, `high`, `medium`, `low`, `info`, `unknown`. Default is `critical`. |
Example request: Example request:
......
...@@ -12,10 +12,16 @@ NOTE: **Note:** ...@@ -12,10 +12,16 @@ NOTE: **Note:**
You will need at least Maintainer [permissions](../../permissions.md) to enable the Alert Management feature. You will need at least Maintainer [permissions](../../permissions.md) to enable the Alert Management feature.
1. Follow the [instructions for toggling generic alerts](../integrations/generic_alerts.md#setting-up-generic-alerts) 1. Follow the [instructions for toggling generic alerts](../integrations/generic_alerts.md#setting-up-generic-alerts)
1. You can now visit **{cloud-gear}** **Operations > Alert Management** in your project's sidebar to [view a list](#alert-management-list) of alerts. 1. You can now visit **{cloud-gear}** **Operations > Alerts** in your project's sidebar to [view a list](#alert-management-list) of alerts.
![Alert Management Toggle](img/alert_management_1_v13_1.png) ![Alert Management Toggle](img/alert_management_1_v13_1.png)
## Populate Alert data
To populate data, see the instructions for
[customizing the payload](../integrations/generic_alerts.md) and making a
request to the alerts endpoint.
## Alert Management severity ## Alert Management severity
Each level of alert contains a uniquely shaped and color-coded icon to help Each level of alert contains a uniquely shaped and color-coded icon to help
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment