diff options
Diffstat (limited to 'doc/operations/incident_management')
| -rw-r--r-- | doc/operations/incident_management/alert_integrations.md | 1 | ||||
| -rw-r--r-- | doc/operations/incident_management/alerts.md | 10 | ||||
| -rw-r--r-- | doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png | bin | 43318 -> 13288 bytes | |||
| -rw-r--r-- | doc/operations/incident_management/incidents.md | 20 | ||||
| -rw-r--r-- | doc/operations/incident_management/integrations.md | 24 | ||||
| -rw-r--r-- | doc/operations/incident_management/oncall_schedules.md | 12 | ||||
| -rw-r--r-- | doc/operations/incident_management/paging.md | 6 | ||||
| -rw-r--r-- | doc/operations/incident_management/status_page.md | 11 |
8 files changed, 43 insertions, 41 deletions
diff --git a/doc/operations/incident_management/alert_integrations.md b/doc/operations/incident_management/alert_integrations.md index bec0653d464..b08ce8a0ad7 100644 --- a/doc/operations/incident_management/alert_integrations.md +++ b/doc/operations/incident_management/alert_integrations.md @@ -1,5 +1,6 @@ --- redirect_to: 'integrations.md' +remove_date: '2021-05-03' --- This document was moved to [another location](integrations.md). diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index c49684954d9..def54d8dae2 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -11,7 +11,7 @@ Alerts are a critical entity in your incident management workflow. They represen ## Alert List Users with at least Developer [permissions](../../user/permissions.md) can -access the Alert list at **Operations > Alerts** in your project's +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. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217745) in GitLab 13.1.) @@ -95,7 +95,7 @@ instance. To view the metrics for an alert: 1. Sign in as a user with Developer or higher [permissions](../../user/permissions.md). -1. Navigate to **Operations > Alerts**. +1. Navigate to **Monitor > Alerts**. 1. Select the alert you want to view. 1. Below the title of the alert, select the **Metrics** tab. @@ -115,7 +115,7 @@ your application's performance and how to resolve any problems. To view the logs for an alert: 1. Sign in as a user with Developer or higher [permissions](../../user/permissions.md). -1. Navigate to **Operations > Alerts**. +1. Navigate to **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 @@ -168,7 +168,7 @@ 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 **Operations > Alerts**. +1. To display the list of current alerts, navigate to **Monitor > Alerts**. 1. Select your desired alert to display its details. @@ -193,7 +193,7 @@ 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 **Operations > Alerts**. +1. To display the list of current alerts, navigate to **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: diff --git a/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png b/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png Binary files differindex 0991e963e02..08a45d001c2 100644 --- a/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png +++ b/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index d09dbd2cb04..1cb10fea566 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -26,7 +26,7 @@ Incident, you have two options to do this manually. > [Moved](https://gitlab.com/gitlab-org/monitor/health/-/issues/24) to GitLab Free in 13.3. -- Navigate to **Operations > Incidents** and click **Create Incident**. +- Navigate to **Monitor > Incidents** and click **Create Incident**. - Create a new issue using the `incident` template available when creating it. - Create a new issue and assign the `incident` label to it. @@ -51,7 +51,7 @@ Incident, you have two options to do this manually. With Maintainer or higher [permissions](../../user/permissions.md), you can enable GitLab to create incident automatically whenever an alert is triggered: -1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**. +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). @@ -69,8 +69,8 @@ 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 Maintainer [permissions](../../user/permissions.md). -1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**. +1. Sign in as a user with the [Maintainer role](../../user/permissions.md). +1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Select the **PagerDuty integration** tab:  @@ -87,7 +87,7 @@ confirm that a GitLab incident is created from the incident. ## Incident list For users with at least Guest [permissions](../../user/permissions.md), the -Incident list is available at **Operations > Incidents** +Incident list is available at **Monitor > Incidents** in your project's sidebar. The list contains the following metrics:  @@ -132,7 +132,7 @@ For a live example of the incident list in action, visit this > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230847) in GitLab 13.4. Users with at least Guest [permissions](../../user/permissions.md) can view -the Incident Details page. Navigate to **Operations > Incidents** in your project's +the Incident Details page. Navigate to **Monitor > Incidents** in your project's sidebar, and select an incident from the list. When you take any of these actions on an incident, GitLab logs a system note and @@ -204,9 +204,11 @@ un-threaded and ordered chronologically, newest to oldest: You can enable the Service Level Agreement Countdown timer on incidents to track the Service Level Agreements (SLAs) you hold with your customers. The timer is automatically started when the incident is created, and shows the time -remaining before the SLA period expires. To configure the timer: +remaining before the SLA period expires. The timer is also dynamically updated +every 15 minutes so you do not have to refresh the page to see the time remaining. +To configure the timer: -1. Navigate to **Settings > Operations**. +1. Navigate to **Settings > Monitor**. 1. Scroll to **Incidents** and click **Expand**, then select the **Incident settings** tab. 1. Select **Activate "time to SLA" countdown timer**. @@ -276,7 +278,7 @@ templates. With Maintainer or higher [permissions](../../user/permissions.md), you can enable GitLab to close an incident automatically when a **Recovery Alert** is received: -1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**. +1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Check the **Automatically close associated Incident** checkbox. 1. Click **Save changes**. diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index 07ffb92a000..d2c52123838 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -18,9 +18,9 @@ to use this endpoint. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab Free 13.5. -With Maintainer or higher [permissions](../../user/permissions.md), -you can view the list of configured alerts integrations by navigating to **Settings > Operations** -in your project's sidebar menu, and expanding the **Alert integrations** section. The list displays +With the [Maintainer role or higher](../../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):  @@ -38,8 +38,8 @@ receive alert payloads in JSON format. You can always 1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md) for a project. -1. Navigate to **Settings > Operations** in your project. -1. Expand the **Alert integrations** section, and in the **Select integration type** dropdown menu, +1. Navigate to **Settings > Monitor** in your project. +1. Expand the **Alerts** section, and in the **Select integration type** dropdown menu, select **HTTP Endpoint**. 1. Toggle the **Active** alert setting. The URL and Authorization Key for the webhook configuration are available in the **View credentials** tab after you save the integration. You must also input @@ -55,8 +55,8 @@ and you can [customize the payload](#customize-the-alert-payload-outside-of-gitl 1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md) for a project. -1. Navigate to **Settings > Operations** in your project. -1. Expand the **Alert integrations** section. +1. Navigate to **Settings > Monitor** in your project. +1. Expand the **Alerts** section. 1. For each endpoint you want to create: 1. Click the **Add new integration** button. @@ -166,8 +166,8 @@ configures an integration, you can trigger a test alert to confirm your integration works properly. 1. Sign in as a user with Developer or greater [permissions](../../user/permissions.md). -1. Navigate to **Settings > Operations** in your project. -1. Click **Alert integrations** to expand the section. +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). 1. Select the **Send test alert** tab to open it. 1. Enter a test payload in the payload field (valid JSON is required). @@ -219,8 +219,8 @@ active at the same time. To enable Opsgenie integration: -1. Sign in as a user with Maintainer or Owner [permissions](../../user/permissions.md). -1. Navigate to **Operations > Alerts**. +1. Sign in as a user with the [Maintainer or Owner role](../../user/permissions.md). +1. Navigate to **Monitor > Alerts**. 1. In the **Integrations** select box, select **Opsgenie**. 1. Select the **Active** toggle. 1. In the **API URL** field, enter the base URL for your Opsgenie integration, @@ -228,4 +228,4 @@ To enable Opsgenie integration: 1. Select **Save changes**. After you enable the integration, navigate to the Alerts list page at -**Operations > Alerts**, and then select **View alerts in Opsgenie**. +**Monitor > Alerts**, and then select **View alerts in Opsgenie**. diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index 695b42f7d1a..5d312ef672f 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -28,7 +28,7 @@ Set up an on-call schedule for your team to add rotations to. Follow these steps to create a schedule: -1. Go to **Operations > On-call Schedules** and select **Add a 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**. @@ -41,7 +41,7 @@ create [rotations](#rotations) for your schedule. Follow these steps to update a schedule: -1. Go to **Operations > On-call Schedules** and select the **Pencil** icon on the top right of the +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. @@ -53,7 +53,7 @@ interval (if one is set) to the corresponding times in the new time zone. Follow these steps to delete a schedule: -1. Go to **Operations > On-call Schedules** and select the **Trash Can** icon on the top right of the +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. @@ -63,7 +63,7 @@ Add rotations to an existing schedule to put your team members on-call. Follow these steps to create a rotation: -1. Go to **Operations > On-call Schedules** and select **Add a rotation** on the top right of the +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: @@ -80,7 +80,7 @@ Follow these steps to create a rotation: Follow these steps to edit a rotation: -1. Go to **Operations > On-call Schedules** and select the **Pencil** icon to the right of the title +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. @@ -89,7 +89,7 @@ Follow these steps to edit a rotation: Follow these steps to delete a rotation: -1. Go to **Operations > On-call Schedules** and select the **Trash Can** icon to the right of the +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. diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 1588cb96218..db419001343 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -27,9 +27,9 @@ 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 > Operations**. -1. Expand the **Incidents** section. -1. In the **Alert Integration** tab, select the checkbox +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. Select **Save changes**. diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index 1e11a9c62e0..d63d42e07c1 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -42,7 +42,7 @@ Only AWS S3 is supported as a deploy target. 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 > Operations**. Next to **Status Page**, +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. @@ -92,10 +92,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 [Operations Settings](../../user/project/settings/#operations-settings) - page, navigate to **{settings}** **Settings > Operations > Status Page**. -1. Fill in your cloud provider's credentials and make sure the **Active** checkbox is checked. -1. Click **Save changes**. +1. To view the Status Page settings, navigate to **{settings}** **Settings > Monitor > Status Page**. +1. Fill in your cloud provider's credentials and make sure to select the **Active** checkbox. +1. Select **Save changes**. ## How to use your GitLab Status Page @@ -131,7 +130,7 @@ A background worker publishes the issue onto the Status Page using the credentia you provided during setup. As part of publication, GitLab: - Anonymizes user and group mentions with `Incident Responder`. -- Removes titles of non-public [GitLab references](../../user/markdown.md#special-gitlab-references). +- Removes titles of non-public [GitLab references](../../user/markdown.md#gitlab-specific-references). - Publishes any files attached to incident issue descriptions, up to 5000 per issue. ([Introduced in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/205166).) |
