Commit 65824a0f authored by Craig Norris's avatar Craig Norris

Merge branch 'incident-docs' into 'master'

Update incident docs

See merge request gitlab-org/gitlab!41078
parents d62ff93b b3101533
......@@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Alert details page
Navigate to the Alert details view by visiting the
[Alert list](alerts.md) and selecting an alert from the
[Alert list](./alerts.md) and selecting an alert from the
list. You need least Developer [permissions](../../user/permissions.md) to access
alerts.
......@@ -18,16 +18,16 @@ amount of information you need.
The **Overview** tab provides basic information about the alert:
![Alert Detail Overview](img/alert_detail_overview_v13_1.png)
![Alert Detail Overview](./img/alert_detail_overview_v13_1.png)
## Alert details tab
![Alert Full Details](img/alert_detail_full_v13_1.png)
![Alert Full Details](./img/alert_detail_full_v13_1.png)
### Update an Alert's status
The Alert detail view enables you to update the Alert Status.
See [Create and manage alerts in GitLab](alerts.md) for more details.
See [Create and manage alerts in GitLab](./alerts.md) for more details.
### Create an Issue from an Alert
......@@ -57,11 +57,11 @@ GitLab currently only supports a single assignee per alert.
1. To display the list of current alerts, click
**{cloud-gear}** **Operations > Alerts**:
![Alert List View Assignee(s)](img/alert_list_assignees_v13_1.png)
![Alert List View Assignee(s)](./img/alert_list_assignees_v13_1.png)
1. Select your desired alert to display its **Alert Details View**:
![Alert Details View Assignee(s)](img/alert_details_assignees_v13_1.png)
![Alert Details View Assignee(s)](./img/alert_details_assignees_v13_1.png)
1. If the right sidebar is not expanded, click
**{angle-double-right}** **Expand sidebar** to expand it.
......@@ -69,7 +69,7 @@ GitLab currently only supports a single assignee per alert.
dropdown menu, select each user you want to assign to the alert. GitLab creates
a [To-Do list item](../../user/todos.md) for each user.
![Alert Details View Assignee(s)](img/alert_todo_assignees_v13_1.png)
![Alert Details View Assignee(s)](./img/alert_todo_assignees_v13_1.png)
To remove an assignee, click **Edit** next to the **Assignee** dropdown menu and
deselect the user from the list of assignees, or click **Unassigned**.
......@@ -88,7 +88,7 @@ The following actions will result in a system note:
- [Creating an issue based on an alert](#create-an-issue-from-an-alert)
- [Assignment of an alert to a user](#update-an-alerts-assignee)
![Alert Details View System Notes](img/alert_detail_system_notes_v13_1.png)
![Alert Details View System Notes](./img/alert_detail_system_notes_v13_1.png)
### Create a To-Do from an Alert
......@@ -102,11 +102,11 @@ Alert details screen, and view them later on your **To-Do List**. To add a To-Do
1. Select your desired alert to display its **Alert Management Details View**.
1. Click the **Add a To-Do** button in the right sidebar:
![Alert Details Add A To Do](img/alert_detail_add_todo_v13_1.png)
![Alert Details Add A To Do](./img/alert_detail_add_todo_v13_1.png)
Click the **To-Do** **{todo-done}** in the navigation bar to view your current To-Do list.
![Alert Details Added to Do](img/alert_detail_added_todo_v13_1.png)
![Alert Details Added to Do](./img/alert_detail_added_todo_v13_1.png)
### View an Alert's metrics data
......@@ -145,7 +145,7 @@ notifications, simplifying communication and ownership of the alert.
After completing their portion of investigating or fixing the alert, users can
unassign their account from the alert when their role is complete.
The alert status can be updated on the [Alert list](alerts.md) to
The alert status can be updated on the [Alert list](./alerts.md) to
reflect if the alert has been resolved.
## View an Alert's logs
......
......@@ -14,7 +14,7 @@ but you can change the sort order by clicking the headers in the Alert Managemen
The alert list displays the following information:
![Alert List](img/alert_list_v13_1.png)
![Alert List](./img/alert_list_v13_1.png)
- **Search** - The alert list supports a simple free text search on the title,
description, monitoring tool, and service fields.
......@@ -58,7 +58,7 @@ To populate the alerts with data, read
You can configure an externally-managed Prometheus instance to send alerts
to GitLab. To set up this configuration, read the [configuring Prometheus](../metrics/alerts.md#external-prometheus-instances) documentation. Activating the external Prometheus
configuration also enables the [Alerts list](alerts.md).
configuration also enables the [Alerts list](./alerts.md).
To populate the alerts with data, read
[External Prometheus instances](../metrics/alerts.md#external-prometheus-instances).
......@@ -69,9 +69,9 @@ GitLab provides the Generic Alerts endpoint so you can accept alerts from a thir
alerts service. Read the
[instructions for toggling generic alerts](generic_alerts.md#setting-up-generic-alerts)
to add this option. After configuring the endpoint, the
[Alerts list](alerts.md) is enabled.
[Alerts list](./alerts.md) is enabled.
To populate the alerts with data, read [Customizing the payload](generic_alerts.md#customizing-the-payload) for requests to the alerts endpoint.
To populate the alerts with data, read [Customizing the payload](./generic_alerts.md#customizing-the-payload) for requests to the alerts endpoint.
### Opsgenie integration **(PREMIUM)**
......@@ -82,7 +82,7 @@ A new way of monitoring Alerts via a GitLab integration is with
NOTE: **Note:**
If you enable the Opsgenie integration, you can't have other GitLab alert services,
such as [Generic Alerts](generic_alerts.md) or
such as [Generic Alerts](./generic_alerts.md) or
Prometheus alerts, active at the same time.
To enable Opsgenie integration:
......@@ -104,7 +104,7 @@ Each level of alert contains a uniquely shaped and color-coded icon to help
you identify the severity of a particular alert. These severity icons help you
immediately identify which alerts you should prioritize investigating:
![Alert Management Severity System](img/alert_management_severity_v13_0.png)
![Alert Management Severity System](./img/alert_management_severity_v13_0.png)
Alerts contain one of the following icons:
......
......@@ -117,9 +117,9 @@ 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 (excluding the
`start_time` and `hosts` attributes), GitLab groups these alerts together and
displays a counter on the
[Alert Management List](incidents.md)
[Alert Management List](./incidents.md)
and details pages.
If the existing alert is already `resolved`, then a new alert will be created instead.
![Alert Management List](img/alert_list_v13_1.png)
![Alert Management List](./img/alert_list_v13_1.png)
......@@ -13,7 +13,7 @@ For users with at least Developer [permissions](../../user/permissions.md), the
Incident Management list is available at **Operations > Incidents**
in your project's sidebar. The list contains the following metrics:
![Incident List](img/incident_list_sort_v13_3.png)
![Incident List](./img/incident_list_sort_v13_3.png)
- **Status** - To filter incidents by their status, click **Open**, **Closed**,
or **All** above the incident list.
......@@ -26,7 +26,7 @@ in your project's sidebar. The list contains the following metrics:
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)**
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).)
......@@ -47,7 +47,7 @@ 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)
![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
......@@ -91,7 +91,7 @@ in both PagerDuty and GitLab:
1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**.
1. Select the **PagerDuty integration** tab:
![PagerDuty incidents integration](img/pagerduty_incidents_integration_v13_3.png)
![PagerDuty incidents integration](./img/pagerduty_incidents_integration_v13_3.png)
1. Activate the integration, and save the changes in GitLab.
1. Copy the value of **Webhook URL** for use in a later step.
......
......@@ -8,13 +8,13 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2877) in GitLab 13.0.
Alert Management enables developers to easily discover and view the alerts
Incident Management enables developers to easily discover and view the alerts
generated by their application. By surfacing alert information where the code is
being developed, efficiency and awareness can be increased.
GitLab offers solutions for handling incidents in your applications and services,
such as [setting up Prometheus alerts](#configure-prometheus-alerts),
[displaying metrics](alertdetails.md#embed-metrics-in-incidents-and-issues), and sending notifications.
[displaying metrics](./alert_details.md#embed-metrics-in-incidents-and-issues), and sending notifications.
## Alert notifications
......@@ -35,7 +35,7 @@ These emails contain details of the alert, and a link for more information.
To send separate email notifications to users with
[Developer permissions](../../user/permissions.md), see
[Configure incidents](incidents.md#configure-incidents).
[Configure incidents](./incidents.md#configure-incidents).
## Configure Prometheus alerts
......@@ -49,9 +49,12 @@ user, but it does not count toward your license limit.
## Configure external generic alerts
GitLab can accept alerts from any source through a generic webhook receiver. When
[configuring the generic alerts integration](generic_alerts.md),
GitLab creates a unique endpoint which receives a JSON-formatted, customizable payload.
GitLab can accept alerts from any source through a generic webhook receiver.
When [configuring the generic alerts integration](./generic_alerts.md), GitLab
creates a unique endpoint which receives a JSON-formatted, customizable payload.
After configuration, you can manage your alerts using either the
[alerts section](./alerts.md) or the [alert details section](./alert_details.md).
## Integrate incidents with Slack
......@@ -66,3 +69,13 @@ GitLab enables you to [associate a Zoom meeting with an issue](../../user/projec
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.
## More information
For information about GitLab and incident management, see:
- [Generic alerts](./generic_alerts.md)
- [Alerts](./alerts.md)
- [Alert details](./alert_details.md)
- [Incidents](./incidents.md)
- [Status page](./status_page.md)
......@@ -12,11 +12,11 @@ With a GitLab Status Page, you can create and deploy a static website to communi
efficiently to users during an incident. The Status Page landing page displays an
overview of recent incidents:
![Status Page landing page](img/status_page_incidents_v12_10.png)
![Status Page landing page](./img/status_page_incidents_v12_10.png)
Clicking an incident displays a detail page with more information about a particular incident:
![Status Page detail](img/status_page_detail_v12_10.png)
![Status Page detail](./img/status_page_detail_v12_10.png)
- Status on the incident, including when the incident was last updated.
- The incident title, including any emojis.
......@@ -144,7 +144,7 @@ you provided during setup. As part of publication, GitLab will:
After publication, you can access the incident's details page by clicking the
**Published on status page** button displayed under the Incident's title.
![Status Page detail link](img/status_page_detail_link_v13_1.png)
![Status Page detail link](./img/status_page_detail_link_v13_1.png)
### Update an incident
......
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