Commit 5cdebc47 authored by Nick Gaskill's avatar Nick Gaskill

Merge branch 'fix/doc-operations-incidents' into 'master'

Doc Consistency: operations/incident_management

See merge request gitlab-org/gitlab!71595
parents 0b106ee2 eeb54877
...@@ -10,11 +10,10 @@ Alerts are a critical entity in your incident management workflow. They represen ...@@ -10,11 +10,10 @@ Alerts are a critical entity in your incident management workflow. They represen
## Alert List ## Alert List
Users with at least Developer [permissions](../../user/permissions.md) can Users with at least the Developer [role](../../user/permissions.md) can
access the Alert list at **Monitor > 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 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. 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.)
The alert list displays the following information: The alert list displays the following information:
...@@ -69,7 +68,7 @@ Alerts contain one of the following icons: ...@@ -69,7 +68,7 @@ Alerts contain one of the following icons:
## Alert details page ## Alert details page
Navigate to the Alert details view by visiting the [Alert list](alerts.md) Navigate to the Alert details view by visiting the [Alert list](alerts.md)
and selecting an alert from the list. You need least Developer [permissions](../../user/permissions.md) and selecting an alert from the list. You need at least the Developer [role](../../user/permissions.md)
to access alerts. to access alerts.
NOTE: NOTE:
...@@ -112,7 +111,7 @@ To view the metrics for an alert: ...@@ -112,7 +111,7 @@ To view the metrics for an alert:
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201846) in GitLab Ultimate 12.8. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201846) in GitLab Ultimate 12.8.
> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.3. > - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.3.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25455) to GitLab Free 12.9. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25455) from GitLab Ultimate to GitLab Free in 12.9.
Viewing logs from a metrics panel can be useful if you're triaging an Viewing logs from a metrics panel can be useful if you're triaging an
application incident and need to [explore logs](../metrics/dashboards/index.md#chart-context-menu) application incident and need to [explore logs](../metrics/dashboards/index.md#chart-context-menu)
......
...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Escalation Policies **(PREMIUM)** # Escalation Policies **(PREMIUM)**
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4638) in [GitLab Premium](https://about.gitlab.com/pricing/) 14.1. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4638) in GitLab 14.1.
Escalation Policies protect your company from missed critical alerts. Escalation Policies contain 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 time-boxed steps that automatically page the next responder in the escalation step if the responder
......
...@@ -24,7 +24,7 @@ Incident, you have two options to do this manually. ...@@ -24,7 +24,7 @@ Incident, you have two options to do this manually.
**From the Incidents List:** **From the Incidents List:**
> [Moved](https://gitlab.com/gitlab-org/monitor/health/-/issues/24) to GitLab Free in 13.3. > [Moved](https://gitlab.com/gitlab-org/monitor/monitor/-/issues/24) to GitLab Free in 13.3.
- Navigate to **Monitor > 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 using the `incident` template available when creating it.
...@@ -44,11 +44,11 @@ Incident, you have two options to do this manually. ...@@ -44,11 +44,11 @@ Incident, you have two options to do this manually.
![Incident List Create](img/new_incident_create_v13_4.png) ![Incident List Create](img/new_incident_create_v13_4.png)
### Create incidents automatically ### Create incidents automatically **(ULTIMATE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4925) in GitLab Ultimate 11.11. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4925) in GitLab 11.11.
With Maintainer or higher [permissions](../../user/permissions.md), you can enable With at least the Maintainer [role](../../user/permissions.md), you can enable
GitLab to create incident automatically whenever an alert is triggered: GitLab to create incident automatically whenever an alert is triggered:
1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**.
...@@ -56,9 +56,9 @@ With Maintainer or higher [permissions](../../user/permissions.md), you can enab ...@@ -56,9 +56,9 @@ With Maintainer or higher [permissions](../../user/permissions.md), you can enab
1. To customize the incident, select an 1. To customize the incident, select an
[issue template](../../user/project/description_templates.md#create-an-issue-template). [issue template](../../user/project/description_templates.md#create-an-issue-template).
1. To send [an email notification](paging.md#email-notifications) to users 1. To send [an email notification](paging.md#email-notifications) to users
with the [Developer role](../../user/permissions.md), select with the Developer [role](../../user/permissions.md), select
**Send a separate email notification to Developers**. Email notifications are **Send a separate email notification to Developers**. Email notifications are
also sent to users with **Maintainer** and **Owner** permissions. also sent to users with the **Maintainer** and **Owner** roles.
1. Click **Save changes**. 1. Click **Save changes**.
### Create incidents via the PagerDuty webhook ### Create incidents via the PagerDuty webhook
...@@ -69,7 +69,7 @@ You can set up a webhook with PagerDuty to automatically create a GitLab inciden ...@@ -69,7 +69,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 for each PagerDuty incident. This configuration requires you to make changes
in both PagerDuty and GitLab: 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](../../user/permissions.md).
1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**.
1. Select the **PagerDuty integration** tab: 1. Select the **PagerDuty integration** tab:
...@@ -114,14 +114,14 @@ in your project's sidebar. The list contains the following metrics: ...@@ -114,14 +114,14 @@ in your project's sidebar. The list contains the following metrics:
tooltip depending on the user's locale. tooltip depending on the user's locale.
- **Assignees** - The user assigned to the incident. - **Assignees** - The user assigned to the incident.
- **Published** - Displays a green check mark (**{check-circle}**) if the incident is published - **Published** - Displays a green check mark (**{check-circle}**) if the incident is published
to a [Status Page](status_page.md). **(ULTIMATE)** to a [Status Page](status_page.md).
The Incident list displays incidents sorted by incident created date. The Incident list displays incidents sorted by incident created date.
([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229534) to GitLab Free in 13.3.) ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229534) in GitLab 13.3.)
To see if a column is sortable, point your mouse at the header. Sortable columns To see if a column is sortable, point your mouse at the header. Sortable columns
display an arrow next to the column name. display an arrow next to the column name.
Incidents share the [Issues API](../../user/project/issues/index.md). Incidents share the [Issues API](../../api/issues.md).
NOTE: NOTE:
For a live example of the incident list in action, visit this For a live example of the incident list in action, visit this
...@@ -165,9 +165,9 @@ Beneath the highlight bar, GitLab displays a summary that includes the following ...@@ -165,9 +165,9 @@ Beneath the highlight bar, GitLab displays a summary that includes the following
Comments are displayed in threads, but can be displayed chronologically Comments are displayed in threads, but can be displayed chronologically
[in a timeline view](#timeline-view). [in a timeline view](#timeline-view).
### Metrics ### Metrics **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235994) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.8. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235994) in GitLab 13.8.
In many cases, incidents are associated to metrics. You can upload screenshots of metric In many cases, incidents are associated to metrics. You can upload screenshots of metric
charts in the **Metrics** tab: charts in the **Metrics** tab:
...@@ -189,7 +189,7 @@ field populated. ...@@ -189,7 +189,7 @@ field populated.
### Timeline view **(PREMIUM)** ### Timeline view **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227836) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227836) in GitLab 13.5.
To quickly see the latest updates on an incident, click To quickly see the latest updates on an incident, click
**{comments}** **Turn timeline view on** in the comment bar to display comments **{comments}** **Turn timeline view on** in the comment bar to display comments
...@@ -199,7 +199,7 @@ un-threaded and ordered chronologically, newest to oldest: ...@@ -199,7 +199,7 @@ un-threaded and ordered chronologically, newest to oldest:
### Service Level Agreement countdown timer **(PREMIUM)** ### Service Level Agreement countdown timer **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241663) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241663) in GitLab 13.5.
You can enable the Service Level Agreement Countdown timer on incidents to track 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 the Service Level Agreements (SLAs) you hold with your customers. The timer is
...@@ -277,7 +277,7 @@ templates. ...@@ -277,7 +277,7 @@ templates.
> - [Introduced for Prometheus Integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13401) in GitLab 12.5. > - [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. > - [Introduced for HTTP Integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4.
With Maintainer or higher [permissions](../../user/permissions.md), you can enable With at least the Maintainer [role](../../user/permissions.md), you can enable
GitLab to close an incident automatically when a **Recovery Alert** is received: GitLab to close an incident automatically when a **Recovery Alert** is received:
1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**.
......
...@@ -6,8 +6,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,8 +6,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Integrations **(FREE)** # Integrations **(FREE)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13203) in GitLab Ultimate 12.4. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13203) in GitLab 12.4.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) to GitLab Free in 12.8. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) from GitLab Ultimate to GitLab Free in 12.8.
GitLab can accept alerts from any source via a webhook receiver. This can be configured GitLab can accept alerts from any source via a webhook receiver. This can be configured
generically or, in GitLab versions 13.1 and greater, you can configure generically or, in GitLab versions 13.1 and greater, you can configure
...@@ -16,9 +16,9 @@ to use this endpoint. ...@@ -16,9 +16,9 @@ to use this endpoint.
## Integrations list ## Integrations list
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab Free 13.5. > [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](../../user/permissions.md), you can view the list of configured
alerts integrations by navigating to **Settings > Monitor** alerts integrations by navigating to **Settings > Monitor**
in your project's sidebar menu, and expanding the **Alerts** section. The list displays in your project's sidebar menu, and expanding the **Alerts** section. The list displays
the integration name, type, and status (enabled or disabled): the integration name, type, and status (enabled or disabled):
...@@ -30,13 +30,13 @@ the integration name, type, and status (enabled or disabled): ...@@ -30,13 +30,13 @@ the integration name, type, and status (enabled or disabled):
GitLab can receive alerts via a HTTP endpoint that you configure, GitLab can receive alerts via a HTTP endpoint that you configure,
or the [Prometheus integration](#external-prometheus-integration). or the [Prometheus integration](#external-prometheus-integration).
### Single HTTP Endpoint **(FREE)** ### Single HTTP Endpoint
Enabling the HTTP Endpoint in a GitLab projects activates it to Enabling the HTTP Endpoint in a GitLab projects activates it to
receive alert payloads in JSON format. You can always receive alert payloads in JSON format. You can always
[customize the payload](#customize-the-alert-payload-outside-of-gitlab) to your liking. [customize the payload](#customize-the-alert-payload-outside-of-gitlab) to your liking.
1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md) 1. Sign in to GitLab as a user with the Maintainer [role](../../user/permissions.md)
for a project. for a project.
1. Navigate to **Settings > Monitor** in your project. 1. Navigate to **Settings > Monitor** in your project.
1. Expand the **Alerts** section, and in the **Select integration type** dropdown menu, 1. Expand the **Alerts** section, and in the **Select integration type** dropdown menu,
...@@ -47,13 +47,13 @@ receive alert payloads in JSON format. You can always ...@@ -47,13 +47,13 @@ receive alert payloads in JSON format. You can always
### HTTP Endpoints **(PREMIUM)** ### HTTP Endpoints **(PREMIUM)**
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4442) in GitLab Premium 13.6. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4442) in GitLab 13.6.
In [GitLab Premium](https://about.gitlab.com/pricing/), you can create multiple 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, 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). and you can [customize the payload](#customize-the-alert-payload-outside-of-gitlab).
1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md) 1. Sign in to GitLab as a user with the Maintainer [role](../../user/permissions.md)
for a project. for a project.
1. Navigate to **Settings > Monitor** in your project. 1. Navigate to **Settings > Monitor** in your project.
1. Expand the **Alerts** section. 1. Expand the **Alerts** section.
...@@ -80,7 +80,7 @@ side of the integrations list. ...@@ -80,7 +80,7 @@ side of the integrations list.
#### Map fields in custom alerts #### Map fields in custom alerts
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4443) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.10. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4443) in GitLab 13.10.
You can integrate your monitoring tool's alert format with GitLab alerts. To show the You can integrate your monitoring tool's alert format with GitLab alerts. To show the
correct information in the [Alert list](alerts.md) and the correct information in the [Alert list](alerts.md) and the
...@@ -159,13 +159,13 @@ Example payload: ...@@ -159,13 +159,13 @@ Example payload:
## Triggering test alerts ## Triggering test alerts
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab Free in 13.2. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab in 13.2.
After a [project maintainer or owner](../../user/permissions.md) After a [project maintainer or owner](../../user/permissions.md)
configures an integration, you can trigger a test configures an integration, you can trigger a test
alert to confirm your integration works properly. alert to confirm your integration works properly.
1. Sign in as a user with Developer or greater [permissions](../../user/permissions.md). 1. Sign in as a user with at least the Developer [role](../../user/permissions.md).
1. Navigate to **Settings > Monitor** in your project. 1. Navigate to **Settings > Monitor** in your project.
1. Click **Alerts** to expand the section. 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. Click the **{settings}** settings icon on the right side of the integration in [the list](#integrations-list).
...@@ -177,7 +177,7 @@ GitLab displays an error or success message, depending on the outcome of your te ...@@ -177,7 +177,7 @@ GitLab displays an error or success message, depending on the outcome of your te
## Automatic grouping of identical alerts **(PREMIUM)** ## Automatic grouping of identical alerts **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214557) in GitLab Premium 13.2. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214557) in GitLab 13.2.
In GitLab versions 13.2 and greater, GitLab groups alerts based on their In GitLab versions 13.2 and greater, GitLab groups alerts based on their
payload. When an incoming alert contains the same payload as another alert payload. When an incoming alert contains the same payload as another alert
...@@ -200,9 +200,9 @@ field is `end_time`. With custom mappings, you can select the expected field. ...@@ -200,9 +200,9 @@ field is `end_time`. With custom mappings, you can select the expected field.
You can also configure the associated [incident to be closed automatically](../incident_management/incidents.md#automatically-close-incidents-via-recovery-alerts) when the alert resolves. You can also configure the associated [incident to be closed automatically](../incident_management/incidents.md#automatically-close-incidents-via-recovery-alerts) when the alert resolves.
## Link to your Opsgenie Alerts ## Link to your Opsgenie Alerts **(PREMIUM)**
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab Premium 13.2. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in GitLab 13.2.
WARNING: WARNING:
We are building deeper integration with Opsgenie and other alerting tools through We are building deeper integration with Opsgenie and other alerting tools through
...@@ -219,7 +219,7 @@ active at the same time. ...@@ -219,7 +219,7 @@ active at the same time.
To enable Opsgenie integration: 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](../../user/permissions.md).
1. Navigate to **Monitor > Alerts**. 1. Navigate to **Monitor > Alerts**.
1. In the **Integrations** select box, select **Opsgenie**. 1. In the **Integrations** select box, select **Opsgenie**.
1. Select the **Active** toggle. 1. Select the **Active** toggle.
......
...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# On-call Schedule Management **(PREMIUM)** # On-call Schedule Management **(PREMIUM)**
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4544) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.11. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4544) in GitLab 13.11.
Use on-call schedule management to create schedules for responders to rotate on-call Use on-call schedule management to create schedules for responders to rotate on-call
responsibilities. Maintain the availability of your software services by putting your teams on-call. responsibilities. Maintain the availability of your software services by putting your teams on-call.
......
...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Status Page **(ULTIMATE)** # Status Page **(ULTIMATE)**
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2479) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2479) in GitLab 12.10.
With a GitLab Status Page, you can create and deploy a static website to communicate With a GitLab Status Page, you can create and deploy a static website to communicate
efficiently to users during an incident. The Status Page landing page displays an efficiently to users during an incident. The Status Page landing page displays an
...@@ -138,7 +138,7 @@ you provided during setup. As part of publication, GitLab: ...@@ -138,7 +138,7 @@ you provided during setup. As part of publication, GitLab:
- Anonymizes user and group mentions with `Incident Responder`. - Anonymizes user and group mentions with `Incident Responder`.
- Removes titles of non-public [GitLab references](../../user/markdown.md#gitlab-specific-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. - 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).) ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205166) in GitLab 13.1.)
After publication, you can access the incident's details page by clicking the After publication, you can access the incident's details page by clicking the
**Published on status page** button displayed under the Incident's title. **Published on status page** button displayed under the Incident's title.
...@@ -162,7 +162,7 @@ To publish comments to the Status Page Incident: ...@@ -162,7 +162,7 @@ To publish comments to the Status Page Incident:
adding a microphone [award emoji](../../user/award_emojis.md) adding a microphone [award emoji](../../user/award_emojis.md)
reaction (`:microphone:` 🎤) to the comment. reaction (`:microphone:` 🎤) to the comment.
- Any files attached to the comment (up to 5000 per issue) are also published. - Any files attached to the comment (up to 5000 per issue) are also published.
([Introduced in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/205166).) ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205166) in GitLab 13.1.)
WARNING: WARNING:
Anyone with access to view the Issue can add an emoji award to a comment, so Anyone with access to view the Issue can add an emoji award to a comment, so
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment