diff options
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/incident_management/index.md | 4 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 16 | ||||
-rw-r--r-- | doc/user/project/issues/img/issue_health_status_dropdown_v12_10.png | bin | 0 -> 44744 bytes | |||
-rw-r--r-- | doc/user/project/issues/index.md | 2 |
4 files changed, 18 insertions, 4 deletions
diff --git a/doc/user/incident_management/index.md b/doc/user/incident_management/index.md index 829fee47826..2b95128bffd 100644 --- a/doc/user/incident_management/index.md +++ b/doc/user/incident_management/index.md @@ -138,6 +138,4 @@ Incident Management features can be easily enabled & disabled via the Project se #### Auto-creation -GitLab Issues can automatically be created as a result of an Alert notification. An Issue created this way will contain error information to help you further debug the error. - -For [GitLab-managed alerting rules](../project/integrations/prometheus.md#setting-up-alerts-for-prometheus-metrics-ultimate), the issue will include an embedded chart for the query corresponding to the alert. The chart will show an hour of data surrounding the starting point of the incident, 30 minutes before and after. +You can automatically create GitLab issues from an Alert notification. Issues created this way contain error information to help you debug the error. Appropriately configured alerts include an [embedded chart](../project/integrations/prometheus.md#embedding-metrics-based-on-alerts-in-incident-issues) for the query corresponding to the alert. diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 273ab9095c0..4b07ecd2743 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -802,6 +802,22 @@ It is also possible to embed either the default dashboard metrics or individual ![Embedded Metrics in issue templates](img/embed_metrics_issue_template.png) +### Embedding metrics based on alerts in incident issues + +For [GitLab-managed alerting rules](#setting-up-alerts-for-prometheus-metrics-ultimate), the issue will include an embedded chart for the query corresponding to the alert. The chart displays an hour of data surrounding the starting point of the incident, 30 minutes before and after. + +For [manually configured Prometheus instances](#manual-configuration-of-prometheus), a chart corresponding to the query can be included if these requirements are met: + +- The alert corresponds to an environment managed through GitLab. +- The alert corresponds to a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries). +- The alert contains the required attributes listed in the chart below. + +| Attributes | Required | Description | +| ---------- | -------- | ----------- | +| `annotations/gitlab_environment_name` | Yes | Name of the GitLab-managed environment corresponding to the alert | +| One of `annotations/title`, `annotations/summary`, `labels/alertname` | Yes | Will be used as the chart title | +| `annotations/gitlab_y_label` | No | Will be used as the chart's y-axis label | + ### Embedding Cluster Health Charts **(ULTIMATE)** > [Introduced](<https://gitlab.com/gitlab-org/gitlab/issues/40997>) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.9. diff --git a/doc/user/project/issues/img/issue_health_status_dropdown_v12_10.png b/doc/user/project/issues/img/issue_health_status_dropdown_v12_10.png Binary files differnew file mode 100644 index 00000000000..c0f0a0dfe16 --- /dev/null +++ b/doc/user/project/issues/img/issue_health_status_dropdown_v12_10.png diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index c020d6e5802..55e9967a370 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -177,7 +177,7 @@ that's progressing as planned or needs attention to keep on schedule: - **Needs attention** (amber) - **At risk** (red) -!["On track" health status on an issue](img/issue_health_status_v12_10.png) +!["On track" health status on an issue](img/issue_health_status_dropdown_v12_10.png) You can then see issue statuses on the [Epic tree](../../group/epics/index.md#issue-health-status-in-epic-tree-ultimate). |