Commit 399fa5f7 authored by Peter Leitzen's avatar Peter Leitzen

Merge branch 'asalii-master-patch-76318' into 'master'

Updating 'Operations Dashboard' documentation

See merge request gitlab-org/gitlab!52198
parents 405e447b a5a2962b
......@@ -92,7 +92,7 @@ parameters. All fields are optional. If the incoming alert does not contain a va
| `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`. |
| `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). This can be used to associate your alert to your environment. |
| `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
......
......@@ -78,6 +78,9 @@ For GitLab to associate your alerts with an [environment](../../ci/environments/
you must configure a `gitlab_environment_name` label on the alerts you set up in
Prometheus. The value of this should match the name of your environment in GitLab.
You can display alerts with a `gitlab_environment_name` of `production`
[on a dashboard](../../user/operations_dashboard/index.md#adding-a-project-to-the-dashboard).
In GitLab versions 13.1 and greater, you can configure your manually configured
Prometheus server to use the
[Generic alerts integration](../incident_management/alert_integrations.md).
......
......@@ -22,7 +22,10 @@ have a [Silver](https://about.gitlab.com/pricing/) plan.
To add a project to the dashboard:
1. Click the **Add projects** button in the homescreen of the dashboard.
1. Ensure your alerts
[populate the `gitlab_environment_name` field](../../operations/metrics/alerts.md#external-prometheus-instances).
In GitLab 13.9, you can display alerts for the `production` environment only.
1. Click the **Add projects** button in the home screen of the dashboard.
1. Search and add one or more projects using the **Search your projects** field.
1. Click the **Add projects** button.
......
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