diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 12:55:51 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 12:55:51 +0300 |
commit | e8d2c2579383897a1dd7f9debd359abe8ae8373d (patch) | |
tree | c42be41678c2586d49a75cabce89322082698334 /doc/operations/metrics | |
parent | fc845b37ec3a90aaa719975f607740c22ba6a113 (diff) |
Add latest changes from gitlab-org/gitlab@14-1-stable-eev14.1.0-rc42
Diffstat (limited to 'doc/operations/metrics')
-rw-r--r-- | doc/operations/metrics/alerts.md | 48 | ||||
-rw-r--r-- | doc/operations/metrics/dashboards/img/panel_context_menu_v13_3.png | bin | 14538 -> 0 bytes | |||
-rw-r--r-- | doc/operations/metrics/dashboards/img/panel_context_menu_v14_0.png | bin | 0 -> 11084 bytes | |||
-rw-r--r-- | doc/operations/metrics/dashboards/index.md | 6 | ||||
-rw-r--r-- | doc/operations/metrics/dashboards/variables.md | 2 | ||||
-rw-r--r-- | doc/operations/metrics/img/prometheus_integration_alerts.png (renamed from doc/operations/metrics/img/prometheus_service_alerts.png) | bin | 16084 -> 16084 bytes |
6 files changed, 4 insertions, 52 deletions
diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 16cfb05ad9a..ea4dd7e34cb 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -9,54 +9,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) to GitLab Free in 12.10. After [configuring metrics for your CI/CD environment](index.md), you can set up -alerting for Prometheus metrics depending on the location of your instances, and +alerting for Prometheus metrics, and [trigger actions from alerts](#trigger-actions-from-alerts) to notify your team when environment performance falls outside of the boundaries you set. -## Managed Prometheus instances - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6590) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.2 for [custom metrics](index.md#adding-custom-metrics), and GitLab 11.3 for [library metrics](../../user/project/integrations/prometheus_library/index.md). - -WARNING: -Managed Prometheus on Kubernetes is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/327796) -and scheduled for [removal in GitLab 14.0](https://gitlab.com/groups/gitlab-org/-/epics/4280). - -For managed Prometheus instances using auto configuration, you can -[configure alerts for metrics](index.md#adding-custom-metrics) directly in the -[metrics dashboard](index.md). To set an alert: - -1. In your project, navigate to **Monitor > Metrics**, -1. Identify the metric you want to create the alert for, and click the - **ellipsis** **{ellipsis_v}** icon in the top right corner of the metric. -1. Choose **Alerts**. -1. Set threshold and operator. -1. (Optional) Add a Runbook URL. -1. Click **Add** to save and activate the alert. - -![Adding an alert](img/prometheus_alert.png) - -To remove the alert, click back on the alert icon for the desired metric, and click **Delete**. - -### Link runbooks to alerts - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39315) in GitLab 13.3. -> - [Deprecated](https://gitlab.com/groups/gitlab-org/-/epics/5877) in GitLab 13.11. -> - [Removed](https://gitlab.com/groups/gitlab-org/-/epics/4280) in GitLab 14.0. - -WARNING: -Linking runbooks to alerts through the alerts UI is [deprecated](https://gitlab.com/groups/gitlab-org/-/epics/5877) -and scheduled for [removal in GitLab 14.0](https://gitlab.com/groups/gitlab-org/-/epics/4280). -However, you can still add runbooks to your alert payload. They show up in the alert UI when the -alert is triggered. - -When creating alerts from the metrics dashboard for [managed Prometheus instances](#managed-prometheus-instances), -you can also link a runbook. When the alert triggers, the -[chart context menu](dashboards/index.md#chart-context-menu) on the metrics chart -links to the runbook, making it easy for you to locate and access the correct runbook -as soon as the alert fires: - -![Linked Runbook in charts](img/linked_runbooks_on_charts.png) - ## Prometheus cluster integrations Alerts are not currently supported for [Prometheus cluster integrations](../../user/clusters/integrations.md). @@ -72,7 +28,7 @@ use with Prometheus webhooks. If you have manual configuration enabled, an This section contains the needed **URL** and **Authorization Key**. The **Reset Key** button invalidates the key and generates a new one. -![Prometheus service configuration of Alerts](img/prometheus_service_alerts.png) +![Prometheus integration configuration of Alerts](img/prometheus_integration_alerts.png) To send GitLab alert notifications, copy the **URL** and **Authorization Key** into the [`webhook_configs`](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config) diff --git a/doc/operations/metrics/dashboards/img/panel_context_menu_v13_3.png b/doc/operations/metrics/dashboards/img/panel_context_menu_v13_3.png Binary files differdeleted file mode 100644 index 1259917608b..00000000000 --- a/doc/operations/metrics/dashboards/img/panel_context_menu_v13_3.png +++ /dev/null diff --git a/doc/operations/metrics/dashboards/img/panel_context_menu_v14_0.png b/doc/operations/metrics/dashboards/img/panel_context_menu_v14_0.png Binary files differnew file mode 100644 index 00000000000..78cce5d30b7 --- /dev/null +++ b/doc/operations/metrics/dashboards/img/panel_context_menu_v14_0.png diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index d7b748034d5..d59f72f2a91 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -123,7 +123,7 @@ You can take action related to a chart's data by clicking the **{ellipsis_v}** **More actions** dropdown box above the upper right corner of any chart on a dashboard: -![Context Menu](img/panel_context_menu_v13_3.png) +![Context Menu](img/panel_context_menu_v14_0.png) The options are: @@ -135,10 +135,6 @@ The options are: feature, logs narrow down to the selected time range. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/122013) in GitLab 12.8.) - **Download CSV** - Data from Prometheus charts on the metrics dashboard can be downloaded as CSV. - [Copy link to chart](../embed.md#embedding-gitlab-managed-kubernetes-metrics) -- **Alerts** - Display any [alerts](../alerts.md) configured for this metric. -- **View Runbook** - Displays the runbook for an alert. For information about configuring - runbooks, read [Set up alerts for Prometheus metrics](../alerts.md). - ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211844) in GitLab 13.3.) ### Timeline zoom and URL sharing diff --git a/doc/operations/metrics/dashboards/variables.md b/doc/operations/metrics/dashboards/variables.md index 31782b5c95f..4b083284819 100644 --- a/doc/operations/metrics/dashboards/variables.md +++ b/doc/operations/metrics/dashboards/variables.md @@ -16,7 +16,7 @@ Queries that continue to use the old format display no data. ## Predefined variables -GitLab supports a limited set of [CI/CD variables](../../../ci/variables/README.md) +GitLab supports a limited set of [CI/CD variables](../../../ci/variables/index.md) in the Prometheus query. This is particularly useful for identifying a specific environment, for example with `ci_environment_slug`. Variables for Prometheus queries must be lowercase. The supported variables are: diff --git a/doc/operations/metrics/img/prometheus_service_alerts.png b/doc/operations/metrics/img/prometheus_integration_alerts.png Binary files differindex 609c5e5196c..609c5e5196c 100644 --- a/doc/operations/metrics/img/prometheus_service_alerts.png +++ b/doc/operations/metrics/img/prometheus_integration_alerts.png |