Skip to content

Commit f0b9782

Browse files
authored
Merge pull request #112 from checkly/sp-patch-2
Incident management tweaks
2 parents 521bcc1 + 35090dc commit f0b9782

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

communicate/status-pages/incidents.mdx

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Incident Management'
3-
description: 'Comprehensive guide to creating, managing, and automating incidents on Checkly status pages including subscriber notifications and backfilling capabilities.'
3+
description: 'Guide to creating, managing, and automating incidents on Checkly status pages including subscriber notifications and incident backfilling capabilities.'
44
sidebarTitle: 'Incidents'
55
---
66

@@ -13,20 +13,19 @@ When an incident is posted, a notification will be sent to all users subscribed
1313
Create an incident when you want to communicate downtime or known issues of your services to users via your status page.
1414

1515
1. Click ‘Status page’ in the sidebar and open your status page.
16-
2. Click ‘Add incident’
16+
2. Click ‘Add incident’ at the top right, or click the fire icon at the bottom of the card that most relates to the incident you're about to create
1717
3. Enter the name of the incident
18-
4. Select the severity of the incident
18+
4. Choose the severity of the incident
1919
5. Select which services are impacted in the dropdown list.
2020

2121
> Note that incidents will be posted on all status pages where a service is present. [See Services for more details](/communicate/status-pages/overview#services).
2222
23-
6. Provide an incident update message.
24-
7. Select the status of the incident.
23+
6. Write the initial incident update message, and update the status of the incident.
2524
8. If you want to backfill the incident, select `Use custom date`. See [Backfilling incidents for more information](/communicate/status-pages/incidents#backfilling-an-incident).
2625
9. Select if you want to notify subscribers of your status page about the incident.
2726
10. Click ‘Create incident’
2827

29-
Your incident will now appear on all status pages that show the selected service(s).
28+
Your incident will now appear on all status pages that show the selected service(s). If you selected the option to notify subscribers, they will receive the update message by email.
3029

3130
> All times on status pages are displayed in UTC.
3231
@@ -37,8 +36,12 @@ To update an ongoing incident go to the ‘Incidents’ tab on your status page
3736

3837
![Incidents view](/images/docs/images/status-pages/status-pages-incidents-1.png)
3938

40-
41-
Here you can post a new status update for the incident, or you can edit existing updates. You can also edit the impacted services or the incident severity, and delete the incident.
39+
From there, you can:
40+
* Post a new status update for the incident
41+
* Edit existing updates
42+
* Change the impacted services
43+
* Change the incident severity
44+
* Delete the incident entirely
4245

4346
## Incident notifications
4447

@@ -56,21 +59,21 @@ Incident notifications contain information about the incident name, the severity
5659

5760
## Subscribing to incident notifications
5861

59-
Subscribing to incident notifications is done on your status page. To subscribe, a user needs to enter a valid email address. A verification email will be sent to the registered email, and only after confirming the subscription will the user start receiving incident notifications.
62+
Subscribing to incident notifications is done on your status page. To subscribe, a user needs to enter a valid email address. A verification email will be sent to the registered email, and the user will be ready to receive incident notifications after confirming the subscription.
6063

6164
## Incident automation
6265

63-
Automatically open incidents whenever a check would alert with incident automation. The incident will be automatically resolved when the check recovers.
64-
65-
Incident automation works by connecting a check to a service. When the check fails and triggers an alert it will also open an incident on the connected service. Multiple checks can be connected to the same service through incident automation.
66+
Incident automation opens incidents automatically whenever a check fails. It works by connecting a check to a service. Multiple checks can be connected to the same service through incident automation. After connecting:
67+
* When the check fails and triggers an alert, it will also open an incident on the connected service.
68+
* The incident will be automatically resolved when the check recovers.
6669

6770
1. Open your check from the home dashboard.
6871
2. Click ‘Edit’ in the check overview page.
69-
3. For API checks, URL monitors and TCP monitors, click the ‘Incident triggers’ tab. For Browser and Multistep checks, first click ‘Settings’ then ‘Incident triggers’.
72+
3. For API checks, URL monitors and TCP monitors, click the ‘Incident triggers’ tab. For Browser and Multistep checks, first click ‘Settings’ then ‘Incident automation’.
7073
4. Check the ‘Enable incident automation’ checkbox.
71-
5. Fill in the incident name, a first status update and the severity of the incident.
74+
5. Fill in the incident name, a first status update and the severity of the incident which will be created upon the check failing.
7275
6. Select which service the incident should be opened on.
73-
7. Select if the status page subscribers should be notified when the automatic incident updates are posted.
76+
7. Select if the status page subscribers should be notified when the incident updates are automatically posted.
7477
8. Save your check.
7578

7679
![Incident automation](/images/docs/images/status-pages/status-pages-incident-automation-1.png)
@@ -86,4 +89,4 @@ To backfill an incident, follow the steps 1 - 7 in the [Creating an incident](/c
8689

8790
We recommend to uncheck notifications when backfilling incidents to avoid notifying customers about resolved incidents.
8891

89-
If you only want to provide the history of the incident, you can set the first incident update to resolved. This will correctly show the incident as having occurred, but without a duration. If you want to have correct uptime on your service you should post two incident updates, with the timestamps for when the incident started and resolved respectively.
92+
If you only want to provide the history of the incident, you can set the first incident update to resolved. This will correctly show the incident as having occurred, but without a duration. If you want to have correct uptime on your service you should post two incident updates, with the timestamps for when the incident started and resolved respectively.

0 commit comments

Comments
 (0)