Skip to content

Commit 9982a26

Browse files
Status Pages Subscriptions (#31913)
* Replace Incidents with Notices * Add email subscriptions config and notes * Remove comment * Convert md table to html * Fix anchor link reference Co-authored-by: Alicia Thuerk <[email protected]> * Add suggestions from product review * Apply suggestions from code review --------- Co-authored-by: Alicia Thuerk <[email protected]>
1 parent e13ab4f commit 9982a26

File tree

3 files changed

+62
-39
lines changed

3 files changed

+62
-39
lines changed

content/en/service_management/status_pages/_index.md

Lines changed: 62 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -9,45 +9,63 @@ further_reading:
99
text: "Learn more about On-Call Scheduling"
1010
---
1111

12-
{{< callout url="https://www.datadoghq.com/product-preview/status-pages/">}}
13-
Status Pages is in Preview.
14-
{{< /callout >}}
15-
1612
## Overview
1713

18-
{{< img src="service_management/status_pages/shopist_status_page_example.png" alt="Example status page showing service components with their current status and recent incident updates" style="width:100%;" >}}
14+
{{< img src="service_management/status_pages/shopist_status_page.png" alt="Example status page showing service components with their current status and recent incident updates" style="width:100%;" >}}
1915

20-
Status Pages are part of Datadog's Incident Response suite, alongside On-Call and Incident Management. They let your team proactively communicate **service availability**, **incidents**, and **maintenance updates** with customers or internal stakeholders through a shareable web page.
16+
Status Pages is part of Datadog's Incident Response suite, alongside On-Call and Incident Management. It lets your team proactively communicate **service availability** and **incidents** with customers or internal stakeholders through a shareable web page.
2117

2218
Use Status Pages to:
2319

2420
* Share the availability of critical systems and features
2521
* Communicate service disruptions clearly during incidents
26-
* Reduce inbound support volume with proactive updates
22+
* Reduce inbound support volume with proactive email notifications
2723

28-
## Configure permissions
24+
## Configure permissions
2925

3026
There are three RBAC permissions that are relevant to Status Pages. Users with the Datadog Admin Role have all the necessary permissions.
3127

3228
To create, update, or publish Status Pages, you must have `status_pages_settings_read`, `status_pages_settings_write`, and `status_pages_incident_write` RBAC permissions. For more information, see [Access Control][1].
3329

34-
| Name | Description | Default Role |
35-
| :---- | :---- | :---- |
36-
| Status Pages Settings Read (`status_pages_settings_read`) | View the list of Status Pages, the settings of each Status Pages, their Incidents, and launched Internal Status Pages. | Datadog Read Only Role |
37-
| Status Pages Settings Write (`status_pages_settings_write`) | Create and launch new Status Pages, and configure Status Pages settings. | Datadog Admin Role |
38-
| Status Pages Incident Write (`status_pages_incident_write`) | Publish and update Incidents. | Datadog Admin Role |
30+
<table>
31+
<thead>
32+
<tr>
33+
<th style="white-space: nowrap;">Name</th>
34+
<th>Description</th>
35+
<th>Default Role</th>
36+
</tr>
37+
</thead>
38+
<tbody>
39+
<tr>
40+
<td style="white-space: nowrap;">Status Pages Settings Read<br><code style="white-space: nowrap;">status_pages_settings_read</code></td>
41+
<td>View the list of Status Pages, the settings of each Status Pages, their Incidents, and launched Internal Status Pages.</td>
42+
<td>Datadog Read Only Role</td>
43+
</tr>
44+
<tr>
45+
<td style="white-space: nowrap;">Status Pages Settings Write<br><code style="white-space: nowrap;">status_pages_settings_write</code></td>
46+
<td>Create and launch new Status Pages, and configure Status Pages settings.</td>
47+
<td>Datadog Admin Role</td>
48+
</tr>
49+
<tr>
50+
<td style="white-space: nowrap;">Status Pages Notice Write<br><code style="white-space: nowrap;">status_pages_incident_write</code></td>
51+
<td>Publish and update Incidents.</td>
52+
<td>Datadog Admin Role</td>
53+
</tr>
54+
</tbody>
55+
</table>
3956

4057
## Create a status page
4158

42-
1. In Datadog, navigate to [**Service Management > Status Pages**][2].
59+
1. In Datadog, navigate to [**Service Management > Status Pages**][2].
4360
1. Click **Create Status Page** and follow the onboarding flow:
4461

4562
| Field | Description |
4663
| ----------------- | ----------- |
47-
| **Visibility** | Choose who can access the page: <br>- **Public** - Anyone with the link can view <br>- **Internal** - Only authenticated users within your Datadog organization can view |
64+
| **Status Page Type** | Choose who can access the page: <br>- **Public** - Anyone with the link can view <br>- **Internal** - Only authenticated users within your Datadog organization can view |
4865
| **Page name** | Displayed as the page header (if no logo is uploaded). <br>*Example: Acme Cloud Platform* |
49-
| **Domain Prefix** | Used as your status page subdomain prefix. <br>*Example: shopist → shopist.status.datadoghq.com* <br>- Must be **globally unique** <br>- Lowercase, alphanumeric, and hyphenated <br>- May affect links if changed later |
50-
| **Company logo or Favicon** *(optional)* | Upload a logo or favicon to personalize the appearance of your status page |
66+
| **Domain Prefix** | Used as your status page subdomain prefix. <br>*Example: shopist → shopist.statuspage.datadoghq.com* <br>- Must be **globally unique** <br>- Lowercase, alphanumeric, and hyphenated <br>- May affect links if changed later |
67+
| **Subscriptions** *(optional)* | Enable users to receive email notifications about status page updates. When subscriptions are enabled, users can sign up to get notified about new notices and updates. You can turn subscriptions on or off for each status page. **Note**: [Email subscriptions](#email-subscriptions) are double opt-in, email must be confirmed. |
68+
| **Company logo, Favicon, or Email Header Image** *(optional)* | Upload a logo, favicon, or image to personalize the appearance of your status page and email notifications. |
5169
1. (Optional) [Add components](#add-components) to show the status of individual services.
5270
1. Click **Save Settings**.
5371
<div class="alert alert-info">A status page <strong>is not Live</strong> after you save your settings. To make the page available, <a href="#publish-your-status-page">publish your status page</a>.</div>
@@ -57,54 +75,59 @@ To create, update, or publish Status Pages, you must have `status_pages_settings
5775
{{< img src="/service_management/status_pages/status_page_components.png" alt="Status page component configuration with live preview panel" style="width:100%;" >}}
5876

5977
Components are the building blocks of your status page. Each one represents a service or feature your users care about. Some examples of components include:
60-
- API Gateway
61-
- Web Dashboard
62-
- Database Cluster
78+
- API Gateway
79+
- Web Dashboard
80+
- Database Cluster
6381
- US Region Services
6482

6583
You can add components to your status page either on intial setup or through the status page settings:
6684

6785
1. From your status page, click **Settings** and select the **Components** tab.
68-
1. Create individual components or a group of related components. You can associate [incidents](#add-an-incident) with these components to reflect impact on your status page.
69-
1. Select a visualization type:
70-
1. Bars and Uptime Percentage
71-
1. Bars Only
72-
1. Component Name Only
86+
1. Create individual components or a group of related components. You can associate [notices](#add-a-notice) with these components to reflect impact on your status page.
87+
1. Select a visualization type:
88+
1. Bars and Uptime Percentage
89+
1. Bars Only
90+
1. Component Name Only
7391

7492
## Publish your status page
7593

7694
After you save your status page settings, click **Launch Status Page** to make the page available at its URL.
7795

7896
If you selected:
79-
- **Public**, the page is immediately accessible to all visitors.
97+
- **Public**, the page is immediately accessible to all visitors.
8098
- **Internal**, access is limited to authenticated Datadog users in your organization.
8199

82-
## Add an incident
83-
84-
<div class="alert alert-warning">Incidents published on Status Pages are not the same as incidents declared within Datadog Incident Management. Incidents on Status Pages are carefully crafted messages posted to a public website to communicate system status, and may encompass multiple internal Incident Management incidents.</div>
100+
## Add a notice
85101

86-
When an issue arises, you can communicate it clearly through your status page.
102+
Notices on Status Pages are carefully crafted messages posted to a public website to communicate system status. When an issue arises, you can communicate it clearly through your status page.
87103

88-
1. From a status page, click **Publish Incident** to open a "Publish Status Page Incident" modal and provide:
104+
1. From a status page, click **Publish Notice** to open a "Publish Status Page Notice" modal and provide:
89105
| Field | Description |
90106
| ---- | ---- |
91107
| **Title** | Short, clear description of the incident <br>*Example: Increased error rates on US region* |
92108
| **Status** | Current state of the incident: <br>- Investigating <br>- Identified <br>- Monitoring <br>- Resolved |
93109
| **Message** *(optional)* | Additional details for your users <br>*Examples: known cause, expected resolution time* |
94-
| **Affected Components** | One or more components impacted by the incident |
110+
| **Components impacted** | One or more components impacted by the incident |
95111
| **Impact** | Level of impact per component: <br>- Operational <br>- Degraded Performance <br>- Partial Outage <br>- Major Outage |
96-
1. Click **Publish Incident**.
112+
| **Notify Subscribers** | Toggle to send the notice to subscribers |
113+
1. Click **Publish Notice**.
97114

98-
{{< img src="/service_management/status_pages/publish_status_page_incident.png" alt="Screenshot of the Status Page Incident creation modal with fields filled out" style="width:70%;" >}}
115+
{{< img src="/service_management/status_pages/publish_status_page_incident_1.png" alt="Screenshot of the Status Page Notice creation modal with fields filled out" style="width:70%;" >}}
99116

100-
After an incident is published, the incident:
101-
- Appears on the Status Pages List under **Active Incidents**.
117+
After a notice is published, the notice:
118+
- Appears on the Status Pages List under **Active Notices**.
102119
- Updates the uptime bars for impacted components.
103-
- Is visible in the incident history timeline.
120+
- Is visible in the notice history timeline.
121+
122+
You can post **updates** over time to keep users informed, and then mark the notice as **Resolved**.
123+
124+
{{< img src="/service_management/status_pages/live_status_page_incident_history.mp4" alt="Video showing the noticce history timeline on a live status page with published notices and updates" video=true >}}
125+
126+
## Email subscriptions
104127

105-
You can post **updates** over time to keep users informed, and then mark the incident as **Resolved**.
128+
Email subscriptions on status pages are **double opt-in**: users must confirm their email address before they are added as subscribers. After entering an email to subscribe, a confirmation email is sent, and the subscription is only activated after the user clicks the confirmation link.
106129

107-
{{< img src="/service_management/status_pages/live_status_page_incident_history.mp4" alt="Video showing the incident history timeline on a live status page with published incidents and updates" video=true >}}
130+
For **internal** status pages, the subscription process is the same, but users must log in to the same Datadog organization to confirm their subscription and receive notifications.
108131

109132
## Further reading
110133

61.4 KB
Loading
110 KB
Loading

0 commit comments

Comments
 (0)