Commit 256f8317 authored by Sarah Waldner's avatar Sarah Waldner Committed by Amy Qualls

Updates to incident page docs

parent 2d3e5c76
...@@ -24,7 +24,7 @@ you never miss a page. ...@@ -24,7 +24,7 @@ you never miss a page.
## Email notifications ## Email notifications
Email notifications are available in projects that have been Email notifications are available in projects that have been
[configured to create incidents automatically](incidents.md#configure-incidents) [configured to create incidents automatically](incidents.md#create-incidents-automatically)
for triggered alerts. Project members with the **Owner** or **Maintainer** roles are for triggered alerts. Project members with the **Owner** or **Maintainer** roles are
sent an email notification automatically. (This is not configurable.) To optionally sent an email notification automatically. (This is not configurable.) To optionally
send additional email notifications to project members with the **Developer** role: send additional email notifications to project members with the **Developer** role:
......
...@@ -6,90 +6,17 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,90 +6,17 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Incidents # Incidents
While no configuration is required to use the [manual features](#create-an-incident-manually) Incidents are critical entities in incident management workflows. They represent a service disruption or outage that needs to be restored urgently. GitLab provides tools for the triage, response, and remediation of incidents.
of incident management, some simple [configuration](#configure-incidents) is needed to automate incident creation.
For users with at least Guest [permissions](../../user/permissions.md), the ## Incident Creation
Incident Management list is available at **Operations > Incidents**
in your project's sidebar. The list contains the following metrics:
![Incident List](img/incident_list_v13_5.png)
- **Status** - To filter incidents by their status, click **Open**, **Closed**,
or **All** above the incident list.
- **Search** - The Incident list supports a simple free text search, which filters
on the **Title** and **Incident** fields.
- **Severity** - Severity of a particular incident, which can be one of the following
values:
- **{severity-critical}** **Critical - S1**
- **{severity-high}** **High - S2**
- **{severity-medium}** **Medium - S3**
- **{severity-low}** **Low - S4**
- **{severity-unknown}** **Unknown**
[Editing incident severity](#incident-details) on the incident details page was
[introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229402) in GitLab 13.4.
- **Incident** - The description of the incident, which attempts to capture the
most meaningful data.
- **Date created** - How long ago the incident was created. This field uses the
standard GitLab pattern of `X time ago`, but is supported by a granular date/time
tooltip depending on the user's locale.
- **Time to SLA** - If configured for this alert, the time remaining
[before the SLA period expires](#service-level-agreement-countdown-timer).
- **Assignees** - The user assigned to the incident.
- **Published** - Displays a green check mark (**{check-circle}**) if the incident is published
to a [Status Page](status_page.md). **(ULTIMATE)**
The Incident list displays incidents sorted by incident created date.
([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229534) to GitLab core in 13.3.)
To see if a column is sortable, point your mouse at the header. Sortable columns
display an arrow next to the column name.
Incidents share the [Issues API](../../user/project/issues/index.md). You can create an incident manually or automatically.
TIP: **Tip:** ### Create incidents manually
For a live example of the incident list in action, visit this
[demo project](https://gitlab.com/gitlab-examples/ops/incident-setup/everyone/tanuki-inc/-/incidents).
## Configure incidents If you have at least Guest [permissions](../../user/permissions.md), to create an Incident, you have two options to do this manually.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4925) in GitLab Ultimate 11.11. **From the Incidents List:**
With Maintainer or higher [permissions](../../user/permissions.md), you can enable
or disable Incident Management features in the GitLab user interface
to create issues when alerts are triggered:
1. Navigate to **Settings > Operations > Incidents** and expand
**Incidents**:
![Incident Management Settings](./img/incident_management_settings_v13_3.png)
1. For GitLab versions 11.11 and greater, you can select the **Create an issue**
checkbox to create an issue based on your own
[issue templates](../../user/project/description_templates.md#creating-issue-templates).
For more information, see
[Trigger actions from alerts](../metrics/alerts.md#trigger-actions-from-alerts) **(ULTIMATE)**.
1. To create issues from alerts, select the template in the **Issue Template**
select box.
1. To send [separate email notifications](alert_notifications.md#email-notifications) to users
with [Developer permissions](../../user/permissions.md), select
**Send a separate email notification to Developers**.
1. Click **Save changes**.
Appropriately configured alerts include an
[embedded chart](../metrics/embed.md#embedding-metrics-based-on-alerts-in-incident-issues)
for the query corresponding to the alert. You can also configure GitLab to
[close issues](../metrics/alerts.md#trigger-actions-from-alerts)
when you receive notification that the alert is resolved.
## Create an incident manually
If you have at least Guest [permissions](../../user/permissions.md), to create an Incident,
you can create incidents manually [from the Incidents list](#from-the-incidents-list)
or [from the issues list](#from-the-issues-list).
### From the Incidents List
> [Moved](https://gitlab.com/gitlab-org/monitor/health/-/issues/24) to GitLab core in 13.3. > [Moved](https://gitlab.com/gitlab-org/monitor/health/-/issues/24) to GitLab core in 13.3.
...@@ -99,7 +26,7 @@ or [from the issues list](#from-the-issues-list). ...@@ -99,7 +26,7 @@ or [from the issues list](#from-the-issues-list).
![Incident List Create](./img/incident_list_create_v13_3.png) ![Incident List Create](./img/incident_list_create_v13_3.png)
### From the Issues List **From the Issues List:**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230857) in GitLab 13.4. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230857) in GitLab 13.4.
...@@ -109,11 +36,31 @@ or [from the issues list](#from-the-issues-list). ...@@ -109,11 +36,31 @@ or [from the issues list](#from-the-issues-list).
![Incident List Create](./img/new_incident_create_v13_4.png) ![Incident List Create](./img/new_incident_create_v13_4.png)
## Configure PagerDuty integration ### Create incidents automatically
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4925) in GitLab Ultimate 11.11.
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**:
![Incident Management Settings](./img/incident_management_settings_v13_3.png)
1. Check the **Create an incident**
checkbox.
1. To customize the incident, select an [issue templates](../../user/project/description_templates.md#creating-issue-templates).
1. To send [an email notification](alert_notifications.md#email-notifications) to users
with [Developer permissions](../../user/permissions.md), select
**Send a separate email notification to Developers**. Email notifications will also be sent to users with **Maintainer** and **Owner** permissions.
1. Click **Save changes**.
### Create incidents via the PagerDuty webhook
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/119018) in GitLab 13.3. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/119018) in GitLab 13.3.
You can set up a webhook with PagerDuty to automatically create a GitLab issue You can set up a webhook with PagerDuty to automatically create a GitLab incident
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:
...@@ -130,7 +77,50 @@ in both PagerDuty and GitLab: ...@@ -130,7 +77,50 @@ in both PagerDuty and GitLab:
to add the webhook URL to a PagerDuty webhook integration. to add the webhook URL to a PagerDuty webhook integration.
To confirm the integration is successful, trigger a test incident from PagerDuty to To confirm the integration is successful, trigger a test incident from PagerDuty to
confirm that a GitLab issue is created from the incident. 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**
in your project's sidebar. The list contains the following metrics:
![Incident List](img/incident_list_v13_5.png)
- **Status** - To filter incidents by their status, click **Open**, **Closed**,
or **All** above the incident list.
- **Search** - The Incident list supports a simple free text search, which filters
on the **Title** and **Incident** fields.
- **Severity** - Severity of a particular incident, which can be one of the following
values:
- **{severity-critical}** **Critical - S1**
- **{severity-high}** **High - S2**
- **{severity-medium}** **Medium - S3**
- **{severity-low}** **Low - S4**
- **{severity-unknown}** **Unknown**
[Editing incident severity](#change-severity) on the incident details page was
[introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229402) in GitLab 13.4.
- **Incident** - The description of the incident, which attempts to capture the
most meaningful data.
- **Date created** - How long ago the incident was created. This field uses the
standard GitLab pattern of `X time ago`, but is supported by a granular date/time
tooltip depending on the user's locale.
- **Assignees** - The user assigned to the incident.
- **Published** - Displays a green check mark (**{check-circle}**) if the incident is published
to a [Status Page](status_page.md). **(ULTIMATE)**
The Incident list displays incidents sorted by incident created date.
([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229534) to GitLab core in 13.3.)
To see if a column is sortable, point your mouse at the header. Sortable columns
display an arrow next to the column name.
Incidents share the [Issues API](../../user/project/issues/index.md).
TIP: **Tip:**
For a live example of the incident list in action, visit this
[demo project](https://gitlab.com/gitlab-examples/ops/incident-setup/everyone/tanuki-inc/-/incidents).
## Incident details ## Incident details
...@@ -156,12 +146,9 @@ The summary section for incidents provides both critical details about and the ...@@ -156,12 +146,9 @@ The summary section for incidents provides both critical details about and the
contents of the issue template (if one was used). The highlighted bar at the top contents of the issue template (if one was used). The highlighted bar at the top
of the incident displays from left to right: of the incident displays from left to right:
![Incident SLA Highlight Bar](./img/incident_highlight_bar_v13_5.png)
- The link to the original alert. - The link to the original alert.
- The alert start time. - The alert start time.
- The event count. - The event count.
- The time to [SLA breach](#service-level-agreement-countdown-timer).
Beneath the highlight bar, GitLab displays a summary that includes the following fields: Beneath the highlight bar, GitLab displays a summary that includes the following fields:
...@@ -175,10 +162,10 @@ Comments are displayed in threads, but can be displayed chronologically ...@@ -175,10 +162,10 @@ Comments are displayed in threads, but can be displayed chronologically
### Alert details ### Alert details
The **Alert details** tab displays more detailed information about linked alerts. To populate this Incidents show the details of linked alerts in a separate tab. To populate this
tab, the incident must have been created with a linked alert. Incidents tab, the incident must have been created with a linked alert. Incidents
[created automatically](#configure-incidents) from alerts have this created automatically from alerts have this
field populated: field populated.
![Incident alert details](./img/incident_alert_details_v13_4.png) ![Incident alert details](./img/incident_alert_details_v13_4.png)
...@@ -194,29 +181,52 @@ un-threaded and ordered chronologically, newest to oldest: ...@@ -194,29 +181,52 @@ un-threaded and ordered chronologically, newest to oldest:
### Service Level Agreement countdown timer ### Service Level Agreement countdown timer
> [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 configure a Service Level Agreement (SLA) timer for Incidents in the Incident After enabling **Incident SLA** in the Incident Management configuration, newly-created
Management configuration. When set, the incident list and [incident summary tab](#summary) incidents display a SLA (Service Level Agreement) timer showing the time remaining before
display an SLA timer for newly-created incidents, showing the time remaining the SLA period expires. If the incident is not closed before the SLA period ends, GitLab
before the SLA period expires. adds a `missed::SLA` label to the incident.
If the incident is not closed before the SLA period ends, GitLab adds a `missed::SLA` ## Incident Actions
label to the incident.
#### Enable the Incident SLA There are different actions avilable to help triage and respond to incidents.
To configure the Service Level Agreement countdown timer: ### Assign incidents
1. Sign in as a user with Maintainer [permissions](../../user/permissions.md). Assign incidents to users that are actively responding. Select **Edit** in the right-hand side bar to select or deselect assignees.
1. Navigate to **Settings > Operations** and expand **Incidents**.
1. Select the **Incident Settings** tab:
![Incident SLA settings](./img/incident_sla_settings_v13_5.png) ### Change severity
1. Select the **Activate** check box to activate the integration. See [Incident List](#incident-list) for a full description of the severities available. Select **Edit** in the right-hand side bar to change the severity of an incident.
1. In **Time limit**, select the length of the SLA period.
1. Click **Save changes**. ### Add a to do
Add a to-do for incidents that you want to track in your to-do list. Clicke the **Add a to do** button at the top of the right-hand side bar to add a to do.
### Manage incidents from Slack
Slack slash commands allow you to control GitLab and view GitLab content without leaving Slack.
Learn how to [set up Slack slash commands](../../user/project/integrations/slack_slash_commands.md)
and how to [use the available slash commands](../../integration/slash_commands.md).
### Associate Zoom calls
GitLab enables you to [associate a Zoom meeting with an issue](../../user/project/issues/associate_zoom_meeting.md)
for synchronous communication during incident management. After starting a Zoom
call for an incident, you can associate the conference call with an issue. Your
team members can join the Zoom call without requesting a link.
### Embed metrics in incidents
You can embed metrics anywhere [GitLab Markdown](../../user/markdown.md) is
used, such as descriptions, comments on issues, and merge requests. Embedding
metrics helps you share them when discussing incidents or performance issues.
You can output the dashboard directly into any issue, merge request, epic, or
any other Markdown text field in GitLab by
[copying and pasting the link to the metrics dashboard](../metrics/embed.md#embedding-gitlab-managed-kubernetes-metrics).
Any changes to the Incident SLA settings are applied to *new* incidents only. You can embed both [GitLab-hosted metrics](../metrics/embed.md) and
Existing incidents remain unchanged. [Grafana metrics](../metrics/embed_grafana.md) in incidents and issue
templates.
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