diff options
Diffstat (limited to 'doc/operations/incident_management')
| -rw-r--r-- | doc/operations/incident_management/alert_integrations.md | 9 | ||||
| -rw-r--r-- | doc/operations/incident_management/alerts.md | 20 | ||||
| -rw-r--r-- | doc/operations/incident_management/escalation_policies.md | 43 | ||||
| -rw-r--r-- | doc/operations/incident_management/img/escalation_policy_v14_1.png | bin | 0 -> 19996 bytes | |||
| -rw-r--r-- | doc/operations/incident_management/img/link_runbooks_to_alerts_v13_5.png | bin | 77748 -> 0 bytes | |||
| -rw-r--r-- | doc/operations/incident_management/incidents.md | 2 | ||||
| -rw-r--r-- | doc/operations/incident_management/integrations.md | 4 |
7 files changed, 49 insertions, 29 deletions
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: - - - ## 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**. + + + +### 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): |
