diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-02-18 09:45:46 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-02-18 09:45:46 +0000 |
commit | a7b3560714b4d9cc4ab32dffcd1f74a284b93580 (patch) | |
tree | 7452bd5c3545c2fa67a28aa013835fb4fa071baf /doc/operations/incident_management | |
parent | ee9173579ae56a3dbfe5afe9f9410c65bb327ca7 (diff) | |
download | gitlab-ce-a7b3560714b4d9cc4ab32dffcd1f74a284b93580.tar.gz |
Add latest changes from gitlab-org/gitlab@14-8-stable-eev14.8.0-rc42
Diffstat (limited to 'doc/operations/incident_management')
-rw-r--r-- | doc/operations/incident_management/alerts.md | 10 | ||||
-rw-r--r-- | doc/operations/incident_management/escalation_policies.md | 4 | ||||
-rw-r--r-- | doc/operations/incident_management/incidents.md | 18 | ||||
-rw-r--r-- | doc/operations/incident_management/index.md | 2 | ||||
-rw-r--r-- | doc/operations/incident_management/integrations.md | 12 | ||||
-rw-r--r-- | doc/operations/incident_management/oncall_schedules.md | 4 | ||||
-rw-r--r-- | doc/operations/incident_management/paging.md | 2 | ||||
-rw-r--r-- | doc/operations/incident_management/status_page.md | 6 |
8 files changed, 29 insertions, 29 deletions
diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index cdf7ca5c8bc..b03955edf87 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -10,7 +10,7 @@ Alerts are a critical entity in your incident management workflow. They represen ## Alert List -Users with at least the Developer [role](../../user/permissions.md) can +Users with at least the Developer role can access the Alert list at **Monitor > Alerts** in your project's sidebar. The Alert list displays alerts sorted by start time, but you can change the sort order by clicking the headers in the Alert list. @@ -68,7 +68,7 @@ Alerts contain one of the following icons: ## Alert details page Navigate to the Alert details view by visiting the [Alert list](alerts.md) -and selecting an alert from the list. You need at least the Developer [role](../../user/permissions.md) +and selecting an alert from the list. You need at least the Developer role to access alerts. NOTE: @@ -96,7 +96,7 @@ instance. Prerequisite: -- You must have at least the Developer [role](../../user/permissions.md). +- You must have at least the Developer role. To view the metrics for an alert: @@ -120,7 +120,7 @@ your application's performance and how to resolve any problems. Prerequisite: -- You must have at least the Developer [role](../../user/permissions.md). +- You must have at least the Developer role. To view the logs for an alert: diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md index 5f132720000..c24824e55f8 100644 --- a/doc/operations/incident_management/escalation_policies.md +++ b/doc/operations/incident_management/escalation_policies.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -17,7 +17,7 @@ where you manage [On-call schedules](oncall_schedules.md). Prerequisite: -- You must have at least the Maintainer [role](../../user/permissions.md). +- You must have at least the Maintainer role. - You must have an [on-call schedule](oncall_schedules.md). To create an escalation policy: diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index ada1f426dd8..e142d060d87 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -21,15 +21,15 @@ You can create an incident manually or automatically. > - [Moved](https://gitlab.com/gitlab-org/monitor/monitor/-/issues/24) to GitLab Free in 13.3. > - [Permission changed](https://gitlab.com/gitlab-org/gitlab/-/issues/336624) from Guest to Reporter in GitLab 14.5. +> - Automatic application of the `incident` label [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/290964) in GitLab 14.8. If you have at least Reporter [permissions](../../user/permissions.md), you can create an incident manually from the Incidents List or the Issues List. To create an incident from the Incidents List: -1. Navigate to **Monitor > Incidents** and click **Create Incident**. -1. Create a new issue using the `incident` template available when creating it. -1. Create a new issue and assign the `incident` label to it. +1. Navigate to **Monitor > Incidents** and select **Create Incident**. +1. Create a new issue using the `incident` template. ![Incident List Create](img/incident_list_create_v13_3.png) @@ -47,15 +47,15 @@ To create an incident from the Issues List: ### Create incidents automatically **(ULTIMATE)** -With at least the Maintainer [role](../../user/permissions.md), you can enable - GitLab to create incident automatically whenever an alert is triggered: +With at least the Maintainer role, you can enable +GitLab to create incident automatically whenever an alert is triggered: 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Check the **Create an incident** checkbox. 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 the Developer [role](../../user/permissions.md), select + with the Developer role, select **Send a separate email notification to Developers**. Email notifications are also sent to users with the **Maintainer** and **Owner** roles. 1. Click **Save changes**. @@ -68,7 +68,7 @@ You can set up a webhook with PagerDuty to automatically create a GitLab inciden for each PagerDuty incident. This configuration requires you to make changes in both PagerDuty and GitLab: -1. Sign in as a user with the Maintainer [role](../../user/permissions.md). +1. Sign in as a user with the Maintainer role. 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Select the **PagerDuty integration** tab: @@ -276,7 +276,7 @@ templates. > - [Introduced for Prometheus Integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13401) in GitLab 12.5. > - [Introduced for HTTP Integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4. -With at least the Maintainer [role](../../user/permissions.md), you can enable +With at least the Maintainer role, you can enable GitLab to close an incident automatically when a **Recovery Alert** is received: 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. diff --git a/doc/operations/incident_management/index.md b/doc/operations/incident_management/index.md index ff5f41e59e9..3b38d4ab427 100644 --- a/doc/operations/incident_management/index.md +++ b/doc/operations/incident_management/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index a8b455e05a0..fe05cb9fda0 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -18,7 +18,7 @@ to use this endpoint. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab 13.5. -With at least the Maintainer [role](../../user/permissions.md), you can view the list of configured +With at least the Maintainer role, 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): @@ -36,7 +36,7 @@ Enabling the HTTP Endpoint in a GitLab projects activates it to receive alert payloads in JSON format. You can always [customize the payload](#customize-the-alert-payload-outside-of-gitlab) to your liking. -1. Sign in to GitLab as a user with the Maintainer [role](../../user/permissions.md) +1. Sign in to GitLab as a user with the Maintainer role for a project. 1. Navigate to **Settings > Monitor** in your project. 1. Expand the **Alerts** section, and in the **Select integration type** dropdown menu, @@ -53,7 +53,7 @@ In [GitLab Premium](https://about.gitlab.com/pricing/), you can create multiple unique HTTP endpoints to receive alerts from any external source in JSON format, and you can [customize the payload](#customize-the-alert-payload-outside-of-gitlab). -1. Sign in to GitLab as a user with the Maintainer [role](../../user/permissions.md) +1. Sign in to GitLab as a user with the Maintainer role for a project. 1. Navigate to **Settings > Monitor** in your project. 1. Expand the **Alerts** section. @@ -225,7 +225,7 @@ After a [project maintainer or owner](../../user/permissions.md) configures an integration, you can trigger a test alert to confirm your integration works properly. -1. Sign in as a user with at least the Developer [role](../../user/permissions.md). +1. Sign in as a user with at least the Developer role. 1. Navigate to **Settings > Monitor** in your project. 1. Click **Alerts** to expand the section. 1. Click the **{settings}** settings icon on the right side of the integration in [the list](#integrations-list). @@ -279,7 +279,7 @@ active at the same time. To enable Opsgenie integration: -1. Sign in as a user with the Maintainer or Owner [role](../../user/permissions.md). +1. Sign in as a user with the Maintainer or Owner role. 1. Navigate to **Monitor > Alerts**. 1. In the **Integrations** select box, select **Opsgenie**. 1. Select the **Active** toggle. diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index 2a8f0eac59c..84ab5da77df 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -24,7 +24,7 @@ Set up an on-call schedule for your team to add rotations to. Prerequisite: -- You must have at least the Maintainer [role](../../user/permissions.md). +- You must have at least the Maintainer role. To create an on-call schedule: diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 6fdf880783a..b6f77de3b4f 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index 241112df521..fe75c1812c8 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -41,7 +41,7 @@ Only AWS S3 is supported as a deploy target. Prerequisite: -- You must have at least the Maintainer [role](../../user/permissions.md). +- You must have at least the Maintainer role. To provide GitLab with the AWS account information needed to push content to your Status Page: @@ -175,5 +175,5 @@ within GitLab. Closing the issue triggers a background worker to update the GitLab Status Page website. If you -[make a published issue confidential](../../user/project/issues/confidential_issues.md#making-an-issue-confidential), +[make a published issue confidential](../../user/project/issues/confidential_issues.md#make-an-issue-confidential), GitLab unpublishes it from your GitLab Status Page website. |