debian-mirror-gitlab/doc/operations/incident_management/incident_timeline_events.md
2023-06-20 00:43:36 +05:30

6.1 KiB

stage group info
Monitor Respond 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

Timeline events

Incident timelines are an important part of record keeping for incidents. Timelines can show executives and external viewers what happened during an incident, and which steps were taken for it to be resolved.

View the timeline

Incident timeline events are listed in ascending order of the date and time. They are grouped with dates and are listed in ascending order of the time when they occurred:

Incident timeline events list

To view the event timeline of an incident:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Monitor > Incidents.
  3. Select an incident.
  4. Select the Timeline tab.

Create an event

You can create a timeline event in many ways in GitLab.

Using the form

Create a timeline event manually using the form.

Prerequisites:

  • You must have at least the Developer role for the project.

To create a timeline event:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Monitor > Incidents.
  3. Select an incident.
  4. Select the Timeline tab.
  5. Select Add new timeline event.
  6. Complete the required fields.
  7. Select Save or Save and add another event.

Using a quick action

Introduced in GitLab 15.4.

You can create a timeline event using the /timeline quick action.

From a comment on the incident

Introduced in GitLab 15.4.

Prerequisites:

  • You must have at least the Developer role for the project.

To create a timeline event from a comment on the incident:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Monitor > Incidents.
  3. Select an incident.
  4. Create a comment or choose an existing comment.
  5. On the comment you want to add, select Add comment to incident timeline ({clock}).

The comment is shown on the incident timeline as a timeline event.

When incident severity changes

Introduced in GitLab 15.6.

A new timeline event is created when someone changes the severity of an incident.

Incident timeline event for severity change

When labels change (Experiment)

Introduced in GitLab 15.3 with a flag named incident_timeline_events_from_labels. Disabled by default.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, ask an administrator to enable the feature flag named incident_timeline_events_from_labels. On GitLab.com, this feature is not available. This feature is not ready for production use.

A new timeline event is created when someone adds or removes labels on an incident.

Delete an event

Ability to delete an event when editing it introduced in GitLab 15.7.

You can also delete timeline events.

Prerequisites:

  • You must have at least the Developer role for the project.

To delete a timeline event:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Monitor > Incidents.
  3. Select an incident.
  4. Select the Timeline tab.
  5. On the right of a timeline event, select More actions ({ellipsis_v}) and then select Delete.
  6. To confirm, select Delete Event.

Alternatively:

  1. On the right of a timeline event, select More actions ({ellipsis_v}) and then select Edit.
  2. Select Delete.
  3. To confirm, select Delete event.

Incident tags

When creating an event using the form or editing it, you can specify incident tags to capture relevant incident timestamps. Timeline tags are optional. You can choose more than one tag per event. When you create a timeline event and select the tags, the event note is populated with a default message. This allows for a quick event creation. If a note has already been set, it isn't changed. Added tags are displayed next to the timestamp.

Formatting rules

Incident timeline events support the following GitLab Flavored Markdown features.