-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add draft monitors docs #29408
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
+113
−42
Merged
Add draft monitors docs #29408
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
09f0e20
Add draft monitors docs
estherk15 7dd80c6
Apply suggestions from code review
estherk15 66e736f
Apply suggestions from code review
estherk15 b08c576
Apply suggestions from code review
estherk15 74d3329
Merge branch 'master' into esther/docs-10726-draft-monitors
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,61 @@ | ||
--- | ||
title: Draft Monitors | ||
further_reading: | ||
- link: "monitors/" | ||
tag: "Documentation" | ||
text: "Monitors and Alerting Overview" | ||
- link: "monitors/configuration/?tab=thresholdalert" | ||
tag: "Documentation" | ||
text: "Configure monitors" | ||
- link: "monitors/manage/" | ||
tag: "Documentation" | ||
text: "Manage monitors" | ||
--- | ||
|
||
## Overview | ||
|
||
Draft Monitors let you safely create, refine, and test alerts without triggering notifications or impacting production. Whether you're experimenting with thresholds, iterating on complex queries, or collaborating with teammates, drafts give you a clean, isolated space to work—free from the noise of unfinished or test monitors. They help reduce alert fatigue during development and ensure only fully vetted monitors go live. Ideal for engineers and SREs managing alert workflows, Draft Monitors provide a clear, low-risk path from idea to reliable alert. | ||
|
||
## Create a draft monitor | ||
|
||
To create and store monitors in a draft state: | ||
|
||
1. Navigate to [**Monitors > New Monitor**][1]. | ||
2. [Configure the monitor][2] (add your query, specify conditions, set notifications). Notifications set in a draft are only used after the monitor is published. | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
3. Click **Save as Draft**. No alerts are sent from this draft monitor. | ||
|
||
{{< img src="/monitors/draft/save_as_draft.png" alt="Save as Draft button in the monitor creation interface" style="width:100%;" >}} | ||
|
||
## Publish a draft monitor | ||
|
||
When your monitor is ready: | ||
|
||
1. Open the draft from [**Monitors List**][3] by using the draft status facet or filter by `status:draft`. | ||
2. Review the configuration. | ||
3. Click **Publish Monitor.** | ||
4. This publishes your monitor and begins alerting based on your conditions. | ||
|
||
## Manage Draft monitors | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<!-- TODO Add image of Monitors List filtered to view drafts, and final QA of instructions with UI--> | ||
|
||
Find draft monitors from the [**Monitors List**][3] by using the draft status facet or filter by `draft_status:draft`. Drafts appear with a **Draft** label on the monitor status page and in the monitor list. Drafts expire after 6 months, but you can delete draft monitors at any time. | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Permissions | ||
|
||
Anyone with edit permissions can update a draft monitor. You can use events to preview how often the monitor would have triggered without sending actual notifications. | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Best Practices | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* **Use drafts for peer reviews:** Collaborate before pushing changes live. | ||
* **Avoid noise in production:** Test alert conditions safely in a draft first. | ||
* **Track your work:** Use clear names and tags for drafts during development. | ||
* **Limit stale drafts:** Review and clean up old drafts to reduce clutter. | ||
|
||
## Further reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
[1]: https://app.datadoghq.com/monitors/create | ||
[2]: https://docs.datadoghq.com/monitors/configuration/?tab=thresholdalert | ||
[3]: https://app.datadoghq.com/monitors/manage | ||
estherk15 marked this conversation as resolved.
Show resolved
Hide resolved
|
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.