-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add status pages docs #29558
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add status pages docs #29558
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5109818
Add status pages docs
estherk15 61ca25c
Fix a formatting typo
estherk15 8d7ffdc
Update nav icon and example
estherk15 1dba8c6
Update content/en/service_management/status_pages.md
estherk15 566bf52
Merge branch 'master' into esther/docs-10539-status-pages
estherk15 1391172
Apply suggestions from code review
estherk15 25e344f
Merge branch 'master' into esther/docs-10539-status-pages
estherk15 9a9bedf
Apply suggestions from code review
estherk15 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
--- | ||
title: Status Pages | ||
further_reading: | ||
- link: "service_management/incident_management/" | ||
tag: "Documentation" | ||
text: "Learn more about Incident Management" | ||
- link: "service_management/on-call/" | ||
tag: "Documentation" | ||
text: "Learn more about On-Call Scheduling" | ||
--- | ||
|
||
{{< callout url="https://www.datadoghq.com/product-preview/status-pages/" header="Limited Availability">}} | ||
Incident Management Status Pages is in Limited Availability. | ||
{{< /callout >}} | ||
|
||
## Overview | ||
|
||
{{< 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%;" >}} | ||
|
||
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. | ||
|
||
Use Status Pages to: | ||
|
||
* Share the availability of critical systems and features | ||
* Communicate service disruptions clearly during incidents | ||
* Reduce inbound support volume with proactive updates | ||
|
||
## Configure permissions | ||
|
||
There are three RBAC permissions that are relevant to Status Pages. Users with the Datadog Admin Role have all the necessary permissions. | ||
|
||
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]. | ||
|
||
| Name | Description | Default Role | | ||
| :---- | :---- | :---- | | ||
| 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 | | ||
| Status Pages Settings Write (`status_pages_settings_write`) | Create and launch new Status Pages, and configure Status Pages settings. | Datadog Admin Role | | ||
| Status Pages Incident Write (`status_pages_incident_write`) | Publish and update Incidents. | Datadog Admin Role | | ||
|
||
## Create a status page | ||
|
||
1. In Datadog, navigate to [**Service Management > Status Pages**][2]. | ||
1. Click **Create Status Page** and follow the onboarding flow: | ||
|
||
| Field | Description | | ||
| ----------------- | ----------- | | ||
| **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 | | ||
| **Page name** | Displayed as the page header (if no logo is uploaded). <br>*Example: Acme Cloud Platform* | | ||
| **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 | | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| **Company logo or Favicon** *(optional)* | Upload a logo or favicon to personalize the appearance of your status page | | ||
1. (Optional) [Add components](#add-components) to show the status of individual services. | ||
1. Click **Save Settings**. | ||
<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> | ||
|
||
## Add components | ||
|
||
{{< img src="/service_management/status_pages/status_page_components.png" alt="Status page component configuration with live preview panel" style="width:100%;" >}} | ||
|
||
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: | ||
- API Gateway | ||
- Web Dashboard | ||
- Database Cluster | ||
- US Region Services | ||
|
||
You can add components to your status page either on intial setup or through the status page settings: | ||
|
||
1. From your status page, click **Settings** and select the **Components** tab. | ||
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. | ||
1. Select a visualization type: | ||
1. Bars and Uptime Percentage | ||
1. Bars Only | ||
1. Component Name Only | ||
|
||
## Publish your status page | ||
|
||
After you save your status page settings, click **Launch Status Page** to make the page available at its URL. | ||
|
||
If you selected: | ||
- **Public**, the page is immediately accessible to all visitors. | ||
- **Private**, access is limited to authenticated Datadog users in your organization. | ||
|
||
## Add an incident | ||
|
||
<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> | ||
|
||
When an issue arises, you can communicate it clearly through your status page. | ||
|
||
1. From a status page, click **Publish Incident** to open a "Publish Status Page Incident" modal and provide: | ||
| Field | Description | | ||
| ---- | ---- | | ||
| **Title** | Short, clear description of the incident <br>*Example: Increased error rates on US region* | | ||
| **Status** | Current state of the incident: <br>- Investigating <br>- Identified <br>- Monitoring <br>- Resolved | | ||
| **Message** *(optional)* | Additional details for your users <br>*Examples: known cause, expected resolution time* | | ||
| **Affected Components** | One or more components impacted by the incident | | ||
| **Impact** | Level of impact per component: <br>- Operational <br>- Degraded Performance <br>- Partial Outage <br>- Major Outage | | ||
1. Click **Publish Incident**. | ||
|
||
{{< 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%;" >}} | ||
|
||
After an incident is published, the incident: | ||
- Appears on the Status Pages List under **Active Incidents**. | ||
- Updates the uptime bars for impacted components. | ||
- Is visible in the incident history timeline. | ||
|
||
You can post **updates** over time to keep users informed, and then mark the incident as **Resolved**. | ||
|
||
{{< 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 >}} | ||
|
||
## Set a custom domain | ||
|
||
To match your branding, you have the option to map your status page to a custom domain like `status.acme.com`. | ||
|
||
1. From your status page, click **Settings**. | ||
1. Select **Custom Domain**. | ||
1. Follow the instructions to enter your domain and add DNS records. | ||
1. Datadog automatically detects the DNS configuration and provisions an SSL certificate. | ||
|
||
<div class="alert alert-warning">Custom domains require access to your DNS provider to add a CNAME or A record.</div> | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
**Notes**: | ||
|
||
- DNS propagation may take several minutes. | ||
- You can revert to the default Datadog domain at any time. | ||
- Ensure DNS changes are made by someone with access to your domain registrar. | ||
|
||
## Further reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
[1]: /account_management/rbac/ | ||
[2]: https://app.datadoghq.com/status-pages |
Binary file added
BIN
+9.98 MB
static/images/service_management/status_pages/live_status_page_incident_history.mp4
Binary file not shown.
Binary file added
BIN
+71.3 KB
static/images/service_management/status_pages/publish_status_page_incident.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+252 KB
static/images/service_management/status_pages/shopist_status_page_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+159 KB
static/images/service_management/status_pages/status_page_components.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+926 KB
...c/images/service_management/status_pages/status_pages_list_active_incidents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.