debian-mirror-gitlab/doc/operations/incident_management/incidents.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

194 lines
7.8 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-03-11 19:13:27 +05:30
# Incidents **(FREE)**
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
An incident is a service disruption or outage that needs to be restored urgently.
Incidents are critical in incident management workflows.
Use GitLab to triage, respond, and remediate incidents.
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
## Incidents list
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
When you [view the incidents list](manage_incidents.md#view-incidents-list), it contains the following:
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
- **State**: To filter incidents by their state, select **Open**, **Closed**,
or **All** above the incident list.
- **Search**: Search for incident titles and descriptions or [filter the list](#filter-the-incidents-list).
- **Severity**: Severity of a particular incident, which can be one of the following
values:
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
- **{severity-critical}** Critical - S1
- **{severity-high}** High - S2
- **{severity-medium}** Medium - S3
- **{severity-low}** Low - S4
- **{severity-unknown}** Unknown
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
- **Incident**: The title of the incident, which attempts to capture the
most meaningful information.
- **Status**: The status of the incident, which can be one of the following values:
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
- Triggered
- Acknowledged
- Resolved
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
In the Premium or Ultimate tier, this field is also linked to [on-call escalation](paging.md#escalating-an-incident) for the incident.
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
- **Date created**: How long ago the incident was created. This field uses the
standard GitLab pattern of `X time ago`. Hover over this value to see the exact date and time formatted according to your locale.
- **Assignees**: The user assigned to the incident.
- **Published**: Whether the incident is published to a [status page](status_page.md).
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
![Incidents List](img/incident_list_v15_6.png)
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
For an example of the incident list in action, visit this
[demo project](https://gitlab.com/gitlab-org/monitor/monitor-sandbox/-/incidents).
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
### Sort the incident list
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229534) in GitLab 13.3: incidents are sorted by created date by default.
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
The incident list shows incidents sorted by incident created date, showing the newest first.
2021-01-03 14:25:43 +05:30
2023-03-04 22:38:38 +05:30
To sort by another column, or to change the sorting order, select the column.
2022-11-25 23:54:43 +05:30
2023-03-04 22:38:38 +05:30
The columns you can sort by:
2022-11-25 23:54:43 +05:30
2023-03-04 22:38:38 +05:30
- Severity
- Status
- Time to SLA
- Published
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
### Filter the incidents list
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
To filter the incident list by author or assignee, enter these values in the search box.
2020-11-24 15:15:51 +05:30
2021-01-03 14:25:43 +05:30
## Incident details
### Summary
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
The summary section for incidents provides critical details about the
incident and the contents of the issue template (if [selected](../metrics/alerts.md#trigger-actions-from-alerts)). The highlighted
2022-08-13 15:12:31 +05:30
bar at the top of the incident displays from left to right:
2020-10-24 23:57:45 +05:30
2021-01-03 14:25:43 +05:30
- The link to the original alert.
- The alert start time.
- The event count.
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
Below the highlight bar, a summary includes the following fields:
2020-10-24 23:57:45 +05:30
2021-01-03 14:25:43 +05:30
- Start time
- Severity
- `full_query`
- Monitoring tool
2020-10-24 23:57:45 +05:30
2022-08-13 15:12:31 +05:30
The incident summary can be further customized using
2023-03-04 22:38:38 +05:30
[GitLab Flavored Markdown](../../user/markdown.md).
If an incident is [created from an alert](../metrics/alerts.md#trigger-actions-from-alerts)
that provided Markdown for the incident, then the Markdown is appended to the summary.
If an incident template is configured for the project, then the template content is appended at the end.
2022-08-13 15:12:31 +05:30
2021-01-03 14:25:43 +05:30
Comments are displayed in threads, but can be displayed chronologically
2022-06-21 17:19:12 +05:30
[by toggling on the recent updates view](#recent-updates-view).
2020-11-24 15:15:51 +05:30
2023-03-04 22:38:38 +05:30
When you make changes to an incident, GitLab creates system notes and
displays them below the summary.
2021-11-18 22:05:49 +05:30
### Metrics **(PREMIUM)**
2021-03-08 18:12:59 +05:30
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235994) in GitLab 13.8.
2021-03-08 18:12:59 +05:30
In many cases, incidents are associated to metrics. You can upload screenshots of metric
charts in the **Metrics** tab:
![Incident Metrics tab](img/incident_metrics_tab_v13_8.png)
2022-07-23 23:45:48 +05:30
When you upload an image, you can associate the image with text or a link to the original graph.
2021-03-08 18:12:59 +05:30
2022-05-07 20:08:51 +05:30
![Text link modal](img/incident_metrics_tab_text_link_modal_v14_9.png)
2022-11-25 23:54:43 +05:30
If you add a link, you can access the original graph by selecting the hyperlink above the uploaded image.
2021-03-08 18:12:59 +05:30
2021-01-03 14:25:43 +05:30
### Alert details
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230847) in GitLab 13.4.
2021-01-03 14:25:43 +05:30
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
created automatically from alerts have this
field populated.
2020-10-24 23:57:45 +05:30
2021-01-29 00:20:46 +05:30
![Incident alert details](img/incident_alert_details_v13_4.png)
2020-11-24 15:15:51 +05:30
2022-08-13 15:12:31 +05:30
### Timeline events
2022-10-11 01:57:18 +05:30
Incident timelines give a high-level overview of what happened
during an incident, and the steps that were taken for it to be resolved.
2022-08-13 15:12:31 +05:30
2022-10-11 01:57:18 +05:30
Read more about [timeline events](incident_timeline_events.md) and how to enable this feature.
2022-08-13 15:12:31 +05:30
2022-06-21 17:19:12 +05:30
### Recent updates view **(PREMIUM)**
2020-11-24 15:15:51 +05:30
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227836) in GitLab 13.5.
2020-11-24 15:15:51 +05:30
2023-03-04 22:38:38 +05:30
To see the latest updates on an incident, select
**Turn recent updates view on** (**{history}**) on the comment bar. Comments display
un-threaded and chronologically, newest to oldest.
2020-10-24 23:57:45 +05:30
2021-03-11 19:13:27 +05:30
### Service Level Agreement countdown timer **(PREMIUM)**
2020-10-24 23:57:45 +05:30
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241663) in GitLab 13.5.
2020-10-24 23:57:45 +05:30
2021-01-29 00:20:46 +05:30
You can enable the Service Level Agreement Countdown timer on incidents to track
2023-03-04 22:38:38 +05:30
the Service Level Agreements (SLA) you hold with your customers. The timer is
2021-01-29 00:20:46 +05:30
automatically started when the incident is created, and shows the time
2021-09-04 01:27:46 +05:30
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.
2023-03-04 22:38:38 +05:30
Prerequisites:
- You must have at least the Maintainer role for the project.
2021-09-04 01:27:46 +05:30
To configure the timer:
2021-01-29 00:20:46 +05:30
2023-03-04 22:38:38 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Monitor**.
1. Expand the **Incidents** section, then select the **Incident settings** tab.
2021-01-29 00:20:46 +05:30
1. Select **Activate "time to SLA" countdown timer**.
1. Set a time limit in increments of 15 minutes.
2022-07-23 23:45:48 +05:30
1. Select **Save changes**.
2021-01-29 00:20:46 +05:30
2023-03-04 22:38:38 +05:30
After you enable the SLA countdown timer, the **Time to SLA** column is available in the
incidents list and as a field on new incidents. If
2021-01-29 00:20:46 +05:30
the incident isn't closed before the SLA period ends, GitLab adds a `missed::SLA`
label to the incident.
2020-10-24 23:57:45 +05:30
2023-03-04 22:38:38 +05:30
## Related topics
- [Create an incident](manage_incidents.md#create-an-incident)
- [Create an incident automatically](../metrics/alerts.md#trigger-actions-from-alerts)
whenever an alert is triggered
- [View incidents list](manage_incidents.md#view-incidents-list)
- [Assign to a user](manage_incidents.md#assign-to-a-user)
- [Change incident severity](manage_incidents.md#change-severity)
- [Change incident status](manage_incidents.md#change-status)
- [Change escalation policy](manage_incidents.md#change-escalation-policy)
- [Embed metrics](manage_incidents.md#embed-metrics)
- [Close an incident](manage_incidents.md#close-an-incident)
- [Automatically close incidents via recovery alerts](manage_incidents.md#automatically-close-incidents-via-recovery-alerts)
- [Add a to-do item](../../user/todos.md#create-a-to-do-item)
- [Add labels](../../user/project/labels.md)
- [Assign a milestone](../../user/project/milestones/index.md)
- [Make an incident confidential](../../user/project/issues/confidential_issues.md)
- [Set a due date](../../user/project/issues/due_dates.md)
- [Toggle notifications](../../user/profile/notifications.md#edit-notification-settings-for-issues-merge-requests-and-epics)
- [Track spent time](../../user/project/time_tracking.md)
- [Add a Zoom meeting to an incident](../../user/project/issues/associate_zoom_meeting.md) the same
way you add it to an issue.
- [Linked resources in incidents](linked_resources.md)
- Create incidents and receive incident notifications [directly from Slack](slack.md).
- Use the [Issues API](../../api/issues.md) to interact with incidents.