diff options
Diffstat (limited to 'doc/operations')
15 files changed, 62 insertions, 88 deletions
diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index d4edf324caa..baaefcc3a0b 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -26,7 +26,7 @@ least Maintainer [permissions](../user/permissions.md) to enable the Sentry inte 1. Sign up to Sentry.io or [deploy your own](#deploying-sentry) Sentry instance. 1. [Create](https://docs.sentry.io/product/sentry-basics/guides/integrate-frontend/create-new-project/) a new Sentry project. For each GitLab project that you want to integrate, we recommend that you create a new Sentry project. 1. [Find or generate](https://docs.sentry.io/api/auth/) a Sentry auth token for your Sentry project. - Make sure to give the token at least the following scopes: `event:read` and `project:read`. + Make sure to give the token at least the following scopes: `event:read`, `project:read`, and `event:write` (for resolving events). 1. In GitLab, navigate to your project's **Monitor > Error Tracking** page, and click **Enable Error Tracking**. 1. Navigate to your project's **Settings > Monitor**. In the **Error Tracking** section, diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index 4045e46de04..a8686e2f4b7 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -80,7 +80,7 @@ You can apply a feature flag strategy across multiple environments, without defi the strategy multiple times. GitLab Feature Flags use [Unleash](https://docs.getunleash.io/) as the feature flag -engine. In Unleash, there are [strategies](https://docs.getunleash.io/docs/activation_strategy) +engine. In Unleash, there are [strategies](https://docs.getunleash.io/activation_strategy/) for granular feature flag controls. GitLab Feature Flags can have multiple strategies, and the supported strategies are: @@ -95,7 +95,7 @@ and clicking **{pencil}** (edit). ### All users -Enables the feature for all users. It uses the [`default`](https://docs.getunleash.io/docs/activation_strategy#default) +Enables the feature for all users. It uses the [`default`](https://docs.getunleash.io/activation_strategy/#default) Unleash activation strategy. ### Percent Rollout @@ -104,7 +104,7 @@ Unleash activation strategy. Enables the feature for a percentage of page views, with configurable consistency of behavior. This consistency is also known as stickiness. It uses the -[`flexibleRollout`](https://docs.getunleash.io/docs/activation_strategy#flexiblerollout) +[`flexibleRollout`](https://docs.getunleash.io/activation_strategy/#flexiblerollout) Unleash activation strategy. You can configure the consistency to be based on: @@ -133,7 +133,7 @@ Selecting **Random** provides inconsistent application behavior for individual u ### Percent of Users Enables the feature for a percentage of authenticated users. It uses the Unleash activation strategy -[`gradualRolloutUserId`](https://docs.getunleash.io/docs/activation_strategy#gradualrolloutuserid). +[`gradualRolloutUserId`](https://docs.getunleash.io/activation_strategy/#gradualrolloutuserid). For example, set a value of 15% to enable the feature for 15% of authenticated users. @@ -155,7 +155,7 @@ ID for the feature to be enabled. See the [Ruby example](#ruby-application-examp > - [Updated](https://gitlab.com/gitlab-org/gitlab/-/issues/34363) to be defined per environment in GitLab 12.6. Enables the feature for a list of target users. It is implemented -using the Unleash [`userWithId`](https://docs.getunleash.io/docs/activation_strategy#userwithid) +using the Unleash [`userWithId`](https://docs.getunleash.io/activation_strategy/#userwithid) activation strategy. Enter user IDs as a comma-separated list of values (for example, @@ -171,7 +171,7 @@ target users. See the [Ruby example](#ruby-application-example) below. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35930) in GitLab 13.1. Enables the feature for lists of users created [in the Feature Flags UI](#create-a-user-list), or with the [Feature Flag User List API](../api/feature_flag_user_lists.md). -Similar to [User IDs](#user-ids), it uses the Unleash [`userWithId`](https://docs.getunleash.io/docs/activation_strategy#userwithid) +Similar to [User IDs](#user-ids), it uses the Unleash [`userWithId`](https://docs.getunleash.io/activation_strategy/#userwithid) activation strategy. It's not possible to *disable* a feature for members of a user list, but you can achieve the same @@ -392,8 +392,10 @@ end > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36617) in GitLab 13.2. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/251234) in GitLab 13.5. +> - Showing related feature flags in issues [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220333) in GitLab 14.1. You can link related issues to a feature flag. In the **Linked issues** section, click the `+` button and input the issue reference number or the full URL of the issue. +The issues then appear in the related feature flag and the other way round. This feature is similar to the [linked issues](../user/project/issues/related_issues.md) feature. diff --git a/doc/operations/incident_management/alert_integrations.md b/doc/operations/incident_management/alert_integrations.md deleted file mode 100644 index b08ce8a0ad7..00000000000 --- a/doc/operations/incident_management/alert_integrations.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -redirect_to: 'integrations.md' -remove_date: '2021-05-03' ---- - -This document was moved to [another location](integrations.md). - -<!-- This redirect file can be deleted after <2021-05-03>. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index def54d8dae2..7b6391cc76e 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -85,11 +85,10 @@ The **Alert details** tab has two sections. The top section provides a short lis > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.2. -The **Metrics** tab displays a metrics chart for alerts coming from Prometheus. If the alert originated from any other tool, the **Metrics** tab is empty. To set up alerts for GitLab-managed Prometheus instances, see [Managed Prometheus instances](../metrics/alerts.md#managed-prometheus-instances). For externally-managed Prometheus instances, you must configure your alerting -rules to display a chart in the alert. For information about how to configure +The **Metrics** tab displays a metrics chart for alerts coming from Prometheus. If the alert originated from any other tool, the **Metrics** tab is empty. +For externally-managed Prometheus instances, you must configure your alerting rules to display a chart in the alert. For information about how to configure your alerting rules, see [Embedding metrics based on alerts in incident issues](../metrics/embed.md#embedding-metrics-based-on-alerts-in-incident-issues). See -[External Prometheus instances](../metrics/alerts.md#external-prometheus-instances) -for information about setting up alerts for your self-managed Prometheus +[External Prometheus instances](../metrics/alerts.md#external-prometheus-instances) for information about setting up alerts for your self-managed Prometheus instance. To view the metrics for an alert: @@ -201,19 +200,6 @@ add a to-do item: Select the **To-Do List** **{todo-done}** in the navigation bar to view your current to-do list. -## Link runbooks to alerts - -> Runbook URLs [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39315) in GitLab 13.3. - -When creating alerts from the metrics dashboard for -[managed Prometheus instances](../metrics/alerts.md#managed-prometheus-instances), -you can link a runbook. When the alert triggers, you can access the runbook through -the [chart context menu](../metrics/dashboards/index.md#chart-context-menu) in the -upper-right corner of the metrics chart, making it easy for you to locate and access -the correct runbook: - -![Linked Runbook in charts](img/link_runbooks_to_alerts_v13_5.png) - ## View the environment that generated the alert > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232492) in GitLab 13.5 behind a feature flag, disabled by default. diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md new file mode 100644 index 00000000000..9df8f0dbf7f --- /dev/null +++ b/doc/operations/incident_management/escalation_policies.md @@ -0,0 +1,43 @@ +--- +stage: Monitor +group: Monitor +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# Escalation Policies **(PREMIUM)** + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4638) in [GitLab Premium](https://about.gitlab.com/pricing/) 14.1. + +Escalation Policies protect your company from missed critical alerts. Escalation Policies contain +time-boxed steps that automatically page the next responder in the escalation step if the responder +in the previous step has not responded. You can create an escalation policy in the GitLab project +where you manage [On-call schedules](oncall_schedules.md). + +## Add an escalation policy + +If you have at least Maintainer [permissions](../../user/permissions.md), +you can create an escalation policy: + +1. Go to **Operations > Escalation Policies** and select **Add an escalation policy**. +1. In the **Add escalation policy** form, enter the policy's name and description, and create + escalation rules to follow when a primary responder misses an alert. +1. Select **Add escalation policy**. + +![Escalation Policy](img/escalation_policy_v14_1.png) + +### Edit an escalation policy + +Follow these steps to update an escalation policy: + +1. Go to **Operations > Escalation Policies** and select the **Pencil** icon on the top right of the + policy card, across from the policy name. +1. In the **Edit policy** form, edit the information you wish to update. +1. Select the **Edit policy** button to save your changes. + +### Delete an escalation policy + +Follow these steps to delete a policy: + +1. Go to **Operations > Escalation Policies** and select the **Trash Can** icon on the top right of + the policy card. +1. In the **Delete escalation policy** window, select the **Delete escalation policy** button. diff --git a/doc/operations/incident_management/img/escalation_policy_v14_1.png b/doc/operations/incident_management/img/escalation_policy_v14_1.png Binary files differnew file mode 100644 index 00000000000..89cd4318fcb --- /dev/null +++ b/doc/operations/incident_management/img/escalation_policy_v14_1.png diff --git a/doc/operations/incident_management/img/link_runbooks_to_alerts_v13_5.png b/doc/operations/incident_management/img/link_runbooks_to_alerts_v13_5.png Binary files differdeleted file mode 100644 index a63001b4cde..00000000000 --- a/doc/operations/incident_management/img/link_runbooks_to_alerts_v13_5.png +++ /dev/null diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 1cb10fea566..385030d56de 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -56,7 +56,7 @@ With Maintainer or higher [permissions](../../user/permissions.md), you can enab 1. To customize the incident, select an [issue template](../../user/project/description_templates.md#create-an-issue-template). 1. To send [an email notification](paging.md#email-notifications) to users - with [Developer permissions](../../user/permissions.md), select + with the [Developer role](../../user/permissions.md), select **Send a separate email notification to Developers**. Email notifications are also sent to users with **Maintainer** and **Owner** permissions. 1. Click **Save changes**. diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index d2c52123838..f6c85045fa0 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -18,8 +18,8 @@ to use this endpoint. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab Free 13.5. -With the [Maintainer role or higher](../../user/permissions.md), -you can view the list of configured alerts integrations by navigating to **Settings > Monitor** +With at least the [Maintainer role](../../user/permissions.md), you can view the list of configured +alerts integrations by navigating to **Settings > Monitor** in your project's sidebar menu, and expanding the **Alerts** section. The list displays the integration name, type, and status (enabled or disabled): 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 |