-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Status Pages scheduled maintenance #32756
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
Open
estherk15
wants to merge
5
commits into
master
Choose a base branch
from
esther/docs-12360-status-pages-maintenance
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8bfdeae
Initial draft of scheduled maintenance
estherk15 276fefc
Apply suggestions from code review
estherk15 96d8582
Apply suggestions from code review
estherk15 7d9a357
Update permissions
estherk15 d207bf8
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
Some comments aren't visible on the classic Files Changed page.
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -22,12 +22,13 @@ | |||||
|
|
||||||
| {{< 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%;" >}} | ||||||
|
|
||||||
| 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. | ||||||
| Status Pages is part of Datadog's Incident Response suite, alongside On-Call and Incident Management. It lets your team proactively communicate **service availability**, **degradation**, and **planned maintenance** 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 | ||||||
| * Communicate service disruptions clearly during service degradations | ||||||
| * Announce scheduled maintenance and planned downtime in advance | ||||||
| * Reduce inbound support volume with proactive email notifications | ||||||
|
|
||||||
| ## Configure permissions | ||||||
|
|
@@ -57,7 +58,7 @@ | |||||
| </tr> | ||||||
| <tr> | ||||||
| <td style="white-space: nowrap;">Status Pages Notice Write<br><code style="white-space: nowrap;">status_pages_incident_write</code></td> | ||||||
| <td>Publish and update Incidents.</td> | ||||||
| <td>Publish and update Notices for degradations and maintenance windows.</td> | ||||||
| <td>Datadog Admin Role</td> | ||||||
| </tr> | ||||||
| </tbody> | ||||||
|
|
@@ -130,6 +131,28 @@ | |||||
|
|
||||||
| You can post **updates** over time to keep users informed, and then mark the notice as **Resolved**. | ||||||
|
|
||||||
| ## Schedule maintenance windows | ||||||
| <!-- Image placeholder | ||||||
| {{< img src="#" alt="Status page showing a scheduled maintenance window for upcoming infrastructure work" style="width:100%;" >}}--> | ||||||
|
|
||||||
| Maintenance windows allow you to proactively communicate planned downtime or service impact before it happens. Unlike [notices](#add-a-notice) which are used for unplanned incidents, maintenance windows are scheduled in advance for infrastructure upgrades, system maintenance, database migrations, and other planned work. Proactively communicate scheduled downtime so you can keep your customers informed and lessen the load on your support team. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @reaganrazon Are all "notices" now referred to as degradations? Instead of #add-a-notice should it be #add-a-degredation? |
||||||
|
|
||||||
| ### Publish a maintenance window | ||||||
|
|
||||||
| 1. From a status page, click **Public Notice** to open the maintenance window modal. | ||||||
| 1. Under **Notice type**, select the "Scheduled Maintenance" tab and provide: | ||||||
| | Field | Description | | ||||||
| | ---- | ---- | | ||||||
| | **Title** | Clear description of the maintenance activity <br>*Example: Database infrastructure upgrade* | | ||||||
| | **Maintenance window** | Scheduled time range for the maintenance window, including start and end times | | ||||||
| | **Messages** | Set the messages that you want to automatically publish for each status update | | ||||||
| | **Components impacted** | One or more components that is affected during maintenance | | ||||||
| | **Impact** | Default impact per component during a maintenance window. If an incident occurs during maintenance, components can transition to: <br>- Degraded Performance <br>- Partial Outage <br>- Major Outage | | ||||||
| | **Notify Subscribers** | Toggle to notify subscribers in advance and for each automatic update| | ||||||
| 1. Click **Review Notice** and click **Publish Notice**. | ||||||
|
|
||||||
| After scheduling, the maintenance window appears on the status page under "Upcoming Maintenance" with the scheduled time range. When the window begins, component status automatically updates to "Undergoing Maintenance" and returns to "Operational" when it ends (unless manually overridden). You can edit the messages, post updates if plans change, reschedule the window, or cancel it if no longer needed. | ||||||
|
|
||||||
| ## Email subscriptions | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
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.