diff options
Diffstat (limited to 'doc/operations/incident_management')
| -rw-r--r-- | doc/operations/incident_management/alerts.md | 37 | ||||
| -rw-r--r-- | doc/operations/incident_management/escalation_policies.md | 49 | ||||
| -rw-r--r-- | doc/operations/incident_management/incidents.md | 2 | ||||
| -rw-r--r-- | doc/operations/incident_management/oncall_schedules.md | 73 | ||||
| -rw-r--r-- | doc/operations/incident_management/paging.md | 9 | ||||
| -rw-r--r-- | doc/operations/incident_management/status_page.md | 41 |
6 files changed, 131 insertions, 80 deletions
diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index 7b6391cc76e..c6ff70103d9 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -91,10 +91,14 @@ your alerting rules, see [Embedding metrics based on alerts in incident issues]( [External Prometheus instances](../metrics/alerts.md#external-prometheus-instances) for information about setting up alerts for your self-managed Prometheus instance. +Prerequisite: + +- You must have at least the Developer [role](../../user/permissions.md). + To view the metrics for an alert: -1. Sign in as a user with Developer or higher [permissions](../../user/permissions.md). -1. Navigate to **Monitor > Alerts**. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Alerts**. 1. Select the alert you want to view. 1. Below the title of the alert, select the **Metrics** tab. @@ -111,10 +115,14 @@ application incident and need to [explore logs](../metrics/dashboards/index.md#c from across your application. These logs help you understand what's affecting your application's performance and how to resolve any problems. +Prerequisite: + +- You must have at least the Developer [role](../../user/permissions.md). + To view the logs for an alert: -1. Sign in as a user with Developer or higher [permissions](../../user/permissions.md). -1. Navigate to **Monitor > Alerts**. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Alerts**. 1. Select the alert you want to view. 1. Below the title of the alert, select the **Metrics** tab. 1. Select the [menu](../metrics/dashboards/index.md#chart-context-menu) of @@ -167,17 +175,20 @@ difficult to track who is investigating and working on it. Assigning alerts ease To assign an alert: -1. To display the list of current alerts, navigate to **Monitor > Alerts**. +1. Display the list of current alerts: + + 1. On the top bar, select **Menu > Projects** and find your project. + 1. On the left sidebar, select **Monitor > Alerts**. 1. Select your desired alert to display its details.  1. If the right sidebar is not expanded, select - **{angle-double-right}** **Expand sidebar** to expand it. + **Expand sidebar** (**{angle-double-right}**) to expand it. -1. In the right sidebar, locate the **Assignee**, and then select **Edit**. - From the dropdown menu, select each user you want to assign to the alert. +1. On the right sidebar, locate the **Assignee**, and then select **Edit**. + From the list, select each user you want to assign to the alert. GitLab creates a [to-do item](../../user/todos.md) for each user. After completing their portion of investigating or fixing the alert, users can @@ -192,13 +203,17 @@ You can manually create [To-Do list items](../../user/todos.md) for yourself from the Alert details screen, and view them later on your **To-Do List**. To add a to-do item: -1. To display the list of current alerts, navigate to **Monitor > Alerts**. +1. Display the list of current alerts: + + 1. On the top bar, select **Menu > Projects** and find your project. + 1. On the left sidebar, select **Monitor > Alerts**. + 1. Select your desired alert to display its **Alert Management Details View**. -1. Select the **Add a to do** button in the right sidebar: +1. On the right sidebar, select **Add a to do**:  -Select the **To-Do List** **{todo-done}** in the navigation bar to view your current to-do list. +To view your To-Do List, on the top bar, select **To-Do List** (**{todo-done}**). ## View the environment that generated the alert diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md index 9df8f0dbf7f..b82aa5e5dc5 100644 --- a/doc/operations/incident_management/escalation_policies.md +++ b/doc/operations/incident_management/escalation_policies.md @@ -15,29 +15,48 @@ 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: +Prerequisite: -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 +- You must have at least the Maintainer [role](../../user/permissions.md). +- You must have an [on-call schedule](oncall_schedules.md). + +To create an escalation policy: + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Escalation Policies**. +1. Select **Add an escalation policy**. +1. Enter the policy's name and description, and escalation rules to follow when a primary responder misses an alert. 1. Select **Add escalation policy**.  -### Edit an escalation policy +### Select the responder of an escalation rule + +When configuring an escalation rule, you can designate who to page: + +- **Email on-call user in schedule:** notifies the users who are on-call when the rule is triggered, + covering all rotations on the specified [on-call schedule](oncall_schedules.md). +- **Email user:** notifies the specified user directly. + +When a notification is sent to a user through an on-call schedule or directly, a system note listing +the paged users is created on the alert. + +## Edit an escalation policy -Follow these steps to update an escalation policy: +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. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Escalation Policies**. +1. Select **Edit escalation policy** (**{pencil}**). +1. Edit the information. +1. Select **Save changes**. -### Delete an escalation policy +## Delete an escalation policy -Follow these steps to delete a policy: +To delete an escalation 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. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Escalation Policies**. +1. Select **Delete escalation policy** (**{remove}**). +1. On the confirmation dialog, select **Delete escalation policy**. diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 385030d56de..0cd0a645c15 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -238,6 +238,8 @@ Associate an incident to a milestone by selecting **Edit** next to the milestone See [Incident List](#incident-list) for a full description of the severity levels available. Select **Edit** in the right-hand side bar to change the severity of an incident. +You can also change the severity using the [`/severity` quick action](../../user/project/quick_actions.md). + ### Add a to-do item Add a to-do for incidents that you want to track in your to-do list. Click the diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index 5d312ef672f..9e736f2cdec 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -13,24 +13,26 @@ responsibilities. Maintain the availability of your software services by putting With an on-call schedule, your team is notified immediately when things go wrong so they can quickly respond to service outages and disruptions. -To use on-call schedules, users with Maintainer [permissions](../../user/permissions.md) -must do the following: +To use on-call schedules: 1. [Create a schedule](#schedules). 1. [Add a rotation to the schedule](#rotations). -If you have at least Maintainer [permissions](../../user/permissions.md) -to create a schedule, you can do this manually. - ## Schedules Set up an on-call schedule for your team to add rotations to. -Follow these steps to create a schedule: +Prerequisite: + +- You must have at least the Maintainer [role](../../user/permissions.md). + +To create an on-call schedule: -1. Go to **Monitor > On-call Schedules** and select **Add a schedule**. -1. In the **Add schedule** form, enter the schedule's name and description, and select a timezone. -1. Click **Add schedule**. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > On-call Schedules**. +1. Select **Add a schedule**. +1. Enter the schedule's name and description and select a timezone. +1. Select **Add schedule**. You now have an empty schedule with no rotations. This renders as an empty state, prompting you to create [rotations](#rotations) for your schedule. @@ -39,59 +41,64 @@ create [rotations](#rotations) for your schedule. ### Edit a schedule -Follow these steps to update a schedule: +To update a schedule: -1. Go to **Monitor > On-call Schedules** and select the **Pencil** icon on the top right of the - schedule card, across from the schedule name. -1. In the **Edit schedule** form, edit the information you wish to update. -1. Click the **Edit schedule** button to save your changes. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > On-call Schedules**. +1. Select **Edit schedule** (**{pencil}**). +1. Edit the information. +1. Select **Save changes**. If you change the schedule's time zone, GitLab automatically updates the rotation's restricted time interval (if one is set) to the corresponding times in the new time zone. ### Delete a schedule -Follow these steps to delete a schedule: +To delete a schedule: -1. Go to **Monitor > On-call Schedules** and select the **Trash Can** icon on the top right of the - schedule card. -1. In the **Delete schedule** window, click the **Delete schedule** button. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > On-call Schedules**. +1. Select **Delete escalation policy** (**{remove}**). +1. On the confirmation dialog, select **Delete schedule**. ## Rotations Add rotations to an existing schedule to put your team members on-call. -Follow these steps to create a rotation: +To create a rotation: -1. Go to **Monitor > On-call Schedules** and select **Add a rotation** on the top right of the - current schedule. -1. In the **Add rotation** form, enter the following: +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > On-call Schedules**. +1. Select the **Add a rotation** link. +1. Enter the following information: - **Name:** Your rotation's name. - **Participants:** The people you want in the rotation. - **Rotation length:** The rotation's duration. - **Starts on:** The date and time the rotation begins. - - **Enable end date:** With the toggle set to on, you can select the date and time your rotation + - **Enable end date:** With the toggle on, you can select the date and time your rotation ends. - - **Restrict to time intervals:** With the toggle set to on, you can restrict your rotation to the + - **Restrict to time intervals:** With the toggle on, you can restrict your rotation to the time period you select. ### Edit a rotation -Follow these steps to edit a rotation: +To edit a rotation: -1. Go to **Monitor > On-call Schedules** and select the **Pencil** icon to the right of the title - of the rotation that you want to update. -1. In the **Edit rotation** form, make the changes that you want. -1. Select the **Edit rotation** button. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > On-call Schedules**. +1. In the **Rotations** section, select **Edit rotation** (**{pencil}**). +1. Edit the information. +1. Select **Save changes**. ### Delete a rotation -Follow these steps to delete a rotation: +To delete a rotation: -1. Go to **Monitor > On-call Schedules** and select the **Trash Can** icon to the right of the - title of the rotation that you want to delete. -1. In the **Delete rotation** window, select the **Delete rotation** button. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > On-call Schedules**. +1. In the **Rotations** section, select **Delete rotation** (**{remove}**). +1. On the confirmation dialog, select **Delete rotation**. ## View schedule rotations diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index db419001343..6fdf880783a 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -27,10 +27,11 @@ Email notifications are available in projects for triggered alerts. Project members with the **Owner** or **Maintainer** roles have the option to receive a single email notification for new alerts. -1. Navigate to **Settings > Monitor**. -1. Expand the **Alerts** section. -1. In the **Integration settings** tab, select the checkbox - **Send a single email notification to Owners and Maintainers for new alerts**. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Settings > Monitor**. +1. Expand **Alerts**. +1. On the **Alert settings** tab, select the + **Send a single email notification to Owners and Maintainers for new alerts** checkbox. 1. Select **Save changes**. ## Paging **(PREMIUM)** diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index d63d42e07c1..db7b55424dd 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -39,19 +39,23 @@ To configure a GitLab Status Page you must: Only AWS S3 is supported as a deploy target. +Prerequisite: + +- You must have at least the Maintainer [role](../../user/permissions.md). + To provide GitLab with the AWS account information needed to push content to your Status Page: -1. Sign into GitLab as a user with Maintainer or greater [permissions](../../user/permissions.md). -1. Navigate to **{settings}** **Settings > Monitor**. Next to **Status Page**, - click **Expand**. -1. Click **Active** to enable the Status Page feature. -1. In **Status Page URL**, provide the URL to your external status page. -1. Provide the **S3 Bucket name**. For more information, see +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Settings > Monitor**. +1. Expand **Status Page**. +1. Select the **Active** checkbox. +1. In the **Status Page URL** box, provide the URL for your external status page. +1. In the **S3 Bucket name** box, type the name of your S3 bucket. For more information, see [Bucket configuration documentation](https://docs.aws.amazon.com/AmazonS3/latest/dev/HostingWebsiteOnS3Setup.html). -1. Provide the **AWS region** for your bucket. For more information, see the +1. In the **AWS region** box, type the region for your bucket. For more information, see the [AWS documentation](https://github.com/aws/aws-sdk-ruby#configuration). -1. Provide your **AWS access key ID** and **AWS Secret access key**. -1. Click **Save changes**. +1. Enter your **AWS access key ID** and **AWS Secret access key**. +1. Select **Save changes**. ### Configure your AWS account @@ -69,8 +73,8 @@ the necessary CI/CD variables to deploy the Status Page to AWS S3: 1. Fork the [Status Page](https://gitlab.com/gitlab-org/status-page) project. You can do this through [Repository Mirroring](https://gitlab.com/gitlab-org/status-page#repository-mirroring), which ensures you get the up-to-date Status Page features. -1. Navigate to **{settings}** **Settings > CI/CD**. -1. Scroll to **Variables**, and click **Expand**. +1. On the left sidebar, select **Settings > CI/CD**. +1. Expand **Variables**. 1. Add the following variables from your Amazon Console: - `S3_BUCKET_NAME` - The name of the Amazon S3 bucket. If no bucket with the provided name exists, the first pipeline run creates @@ -80,8 +84,8 @@ the necessary CI/CD variables to deploy the Status Page to AWS S3: - `AWS_DEFAULT_REGION` - The AWS region. - `AWS_ACCESS_KEY_ID` - The AWS access key ID. - `AWS_SECRET_ACCESS_KEY` - The AWS secret. -1. Navigate to **CI/CD > Pipelines > Run Pipeline**, and run the pipeline to - deploy the Status Page to S3. +1. On the left sidebar, select **CI/CD > Pipelines**. +1. To deploy the Status Page to S3, select **Run pipeline**. WARNING: Consider limiting who can access issues in this project, as any user who can view @@ -92,7 +96,9 @@ the issue can potentially [publish comments to your GitLab Status Page](#publish After creating the CI/CD variables, configure the Project you want to use for Incident issues: -1. To view the Status Page settings, navigate to **{settings}** **Settings > Monitor > Status Page**. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Settings > Monitor**. +1. Expand **Status page**. 1. Fill in your cloud provider's credentials and make sure to select the **Active** checkbox. 1. Select **Save changes**. @@ -124,7 +130,7 @@ To publish an incident: 1. Create an issue in the project you enabled the GitLab Status Page settings in. 1. A [project or group owner](../../user/permissions.md) must use the `/publish` [quick action](../../user/project/quick_actions.md) to publish the - issue to the GitLab Status Page. Confidential issues can't be published. + issue to the GitLab Status Page. [Confidential issues](../../user/project/issues/confidential_issues.md) can't be published. A background worker publishes the issue onto the Status Page using the credentials you provided during setup. As part of publication, GitLab: @@ -168,5 +174,6 @@ To change the incident status from `open` to `closed`, close the incident issue within GitLab. Closing the issue triggers a background worker to update the GitLab Status Page website. -If you make a published issue confidential, GitLab unpublishes it from your -GitLab Status Page website. +If you +[make a published issue confidential](../../user/project/issues/confidential_issues.md#making-an-issue-confidential), +GitLab unpublishes it from your GitLab Status Page website. |