Skip to content

Commit a81e35e

Browse files
estherk15rtrieu
andauthored
Add status pages docs (#29558)
* Add status pages docs Add preview form Final content formatting with added images * Fix a formatting typo * Update nav icon and example * Update content/en/service_management/status_pages.md * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com> --------- Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com>
1 parent c6c4f0e commit a81e35e

File tree

7 files changed

+139
-2
lines changed

7 files changed

+139
-2
lines changed

config/_default/menus/main.en.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2454,12 +2454,18 @@ menu:
24542454
parent: oncall
24552455
identifier: oncall_guides
24562456
weight: 8
2457+
- name: Status Pages
2458+
url: service_management/status_pages/
2459+
pre: status-page-wui
2460+
parent: service_management_heading
2461+
identifier: status_pages
2462+
weight: 40000
24572463
- name: Event Management
24582464
url: service_management/events/
24592465
pre: events
24602466
identifier: events
24612467
parent: service_management_heading
2462-
weight: 40000
2468+
weight: 50000
24632469
- name: Ingest Events
24642470
url: service_management/events/ingest/
24652471
identifier: event_ingest
@@ -2595,7 +2601,7 @@ menu:
25952601
pre: case-management
25962602
parent: service_management_heading
25972603
identifier: case_management
2598-
weight: 50000
2604+
weight: 60000
25992605
- name: Projects
26002606
url: service_management/case_management/projects
26012607
parent: case_management
Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
title: Status Pages
3+
further_reading:
4+
- link: "service_management/incident_management/"
5+
tag: "Documentation"
6+
text: "Learn more about Incident Management"
7+
- link: "service_management/on-call/"
8+
tag: "Documentation"
9+
text: "Learn more about On-Call Scheduling"
10+
---
11+
12+
{{< callout url="https://www.datadoghq.com/product-preview/status-pages/" header="Limited Availability">}}
13+
Incident Management Status Pages is in Limited Availability.
14+
{{< /callout >}}
15+
16+
## Overview
17+
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%;" >}}
19+
20+
Status Pages are part of Datadog's Incident Response suite, alongside On-Call and Incident Management. They let your team proactively communicate **real-time service availability**, **incidents**, and **maintenance updates** with customers or internal stakeholders through a shareable web page.
21+
22+
Use Status Pages to:
23+
24+
* Share the availability of critical systems and features
25+
* Communicate service disruptions clearly during incidents
26+
* Reduce inbound support volume with proactive updates
27+
28+
## Configure permissions
29+
30+
There are three RBAC permissions that are relevant to Status Pages. Users with the Datadog Admin Role have all the necessary permissions.
31+
32+
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].
33+
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 Private 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 |
39+
40+
## Create a status page
41+
42+
1. In Datadog, navigate to [**Service Management > Status Pages**][2].
43+
1. Click **Create Status Page** and follow the onboarding flow:
44+
45+
| Field | Description |
46+
| ----------------- | ----------- |
47+
| **Visibility** | Choose who can access the page: <br>- **Public** - Anyone with the link can view <br>- **Private** - Only authenticated users within your Datadog organization can view |
48+
| **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 |
51+
1. (Optional) [Add components](#add-components) to show the status of individual services.
52+
1. Click **Save Settings**.
53+
<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>
54+
55+
## Add components
56+
57+
{{< img src="/service_management/status_pages/status_page_components.png" alt="Status page component configuration with live preview panel" style="width:100%;" >}}
58+
59+
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
63+
- US Region Services
64+
65+
You can add components to your status page either on intial setup or through the status page settings:
66+
67+
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
73+
74+
## Publish your status page
75+
76+
After you save your status page settings, click **Launch Status Page** to make the page available at its URL.
77+
78+
If you selected:
79+
- **Public**, the page is immediately accessible to all visitors.
80+
- **Private**, access is limited to authenticated Datadog users in your organization.
81+
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>
85+
86+
When an issue arises, you can communicate it clearly through your status page.
87+
88+
1. From a status page, click **Publish Incident** to open a "Publish Status Page Incident" modal and provide:
89+
| Field | Description |
90+
| ---- | ---- |
91+
| **Title** | Short, clear description of the incident <br>*Example: Increased error rates on US region* |
92+
| **Status** | Current state of the incident: <br>- Investigating <br>- Identified <br>- Monitoring <br>- Resolved |
93+
| **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 |
95+
| **Impact** | Level of impact per component: <br>- Operational <br>- Degraded Performance <br>- Partial Outage <br>- Major Outage |
96+
1. Click **Publish Incident**.
97+
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%;" >}}
99+
100+
After an incident is published, the incident:
101+
- Appears on the Status Pages List under **Active Incidents**.
102+
- Updates the uptime bars for impacted components.
103+
- Is visible in the incident history timeline.
104+
105+
You can post **updates** over time to keep users informed, and then mark the incident as **Resolved**.
106+
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 >}}
108+
109+
## Set a custom domain
110+
111+
To match your branding, you have the option to map your status page to a custom domain like `status.acme.com`.
112+
113+
1. From your status page, click **Settings**.
114+
1. Select **Custom Domain**.
115+
1. Follow the instructions to enter your domain and add DNS records.
116+
1. Datadog automatically detects the DNS configuration and provisions an SSL certificate.
117+
118+
<div class="alert alert-warning">Custom domains require access to your DNS provider to add a CNAME or A record.</div>
119+
120+
**Notes**:
121+
122+
- DNS propagation may take several minutes.
123+
- You can revert to the default Datadog domain at any time.
124+
- Ensure DNS changes are made by someone with access to your domain registrar.
125+
126+
## Further reading
127+
128+
{{< partial name="whats-next/whats-next.html" >}}
129+
130+
[1]: /account_management/rbac/
131+
[2]: https://app.datadoghq.com/status-pages
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)