Skip to content

Commit 04070f0

Browse files
estherk15stevenklinemichaelcretzman
authored
Add draft monitors docs (#29408)
* Add draft monitors docs * Apply suggestions from code review Co-authored-by: stevenkline <steven.kline@datadoghq.com> * Apply suggestions from code review Co-authored-by: Michael Cretzman <58786311+michaelcretzman@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: stevenkline <steven.kline@datadoghq.com> --------- Co-authored-by: stevenkline <steven.kline@datadoghq.com> Co-authored-by: Michael Cretzman <58786311+michaelcretzman@users.noreply.github.com>
1 parent 79abcab commit 04070f0

File tree

3 files changed

+113
-42
lines changed

3 files changed

+113
-42
lines changed

config/_default/menus/main.en.yaml

Lines changed: 47 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1665,214 +1665,219 @@ menu:
16651665
identifier: alerting
16661666
parent: platform_heading
16671667
weight: 60000
1668+
- name: Draft Monitors
1669+
url: monitors/draft/
1670+
parent: alerting
1671+
identifier: monitor_draft
1672+
weight: 1
16681673
- name: Configure Monitors
16691674
url: monitors/configuration/
16701675
parent: alerting
16711676
identifier: monitor_configuration
1672-
weight: 1
1677+
weight: 2
16731678
- name: Monitor Templates
16741679
url: monitors/templates/
16751680
parent: alerting
16761681
identifier: monitor_templates
1677-
weight: 2
1682+
weight: 3
16781683
- name: Monitor Types
16791684
url: monitors/types/
16801685
parent: alerting
16811686
identifier: monitor_types
1682-
weight: 3
1687+
weight: 4
16831688
- name: Host
16841689
url: monitors/types/host/
16851690
parent: monitor_types
16861691
identifier: monitor_types_host
1687-
weight: 301
1692+
weight: 401
16881693
- name: Metric
16891694
url: monitors/types/metric/
16901695
parent: monitor_types
16911696
identifier: monitor_types_metrics
1692-
weight: 202
1697+
weight: 402
16931698
- name: Anomaly
16941699
url: monitors/types/anomaly/
16951700
parent: monitor_types
16961701
identifier: monitor_types_anomaly
1697-
weight: 303
1702+
weight: 403
16981703
- name: APM
16991704
url: monitors/types/apm/
17001705
parent: monitor_types
17011706
identifier: monitor_types_apm
1702-
weight: 304
1707+
weight: 404
17031708
- name: Audit Trail
17041709
url: monitors/types/audit_trail/
17051710
parent: monitor_types
17061711
identifier: monitor_types_auditlogs
1707-
weight: 305
1712+
weight: 405
17081713
- name: Change
17091714
url: monitors/types/change-alert/
17101715
parent: monitor_types
17111716
identifier: monitor_types_change
1712-
weight: 306
1717+
weight: 406
17131718
- name: CI/CD & Test
17141719
url: monitors/types/ci/
17151720
parent: monitor_types
17161721
identifier: monitor_types_ci
1717-
weight: 307
1722+
weight: 407
17181723
- name: Cloud Cost
17191724
url: monitors/types/cloud_cost/
17201725
parent: monitor_types
17211726
identifier: monitor_types_cloud_cost
1722-
weight: 308
1727+
weight: 408
17231728
- name: Composite
17241729
url: monitors/types/composite/
17251730
parent: monitor_types
17261731
identifier: monitor_types_composite
1727-
weight: 309
1732+
weight: 409
17281733
- name: Database Monitoring
17291734
url: monitors/types/database_monitoring/
17301735
parent: monitor_types
17311736
identifier: monitor_types_database_monitoring
1732-
weight: 310
1737+
weight: 410
17331738
- name: Error Tracking
17341739
url: monitors/types/error_tracking/
17351740
parent: monitor_types
17361741
identifier: monitor_types_error_tracking
1737-
weight: 311
1742+
weight: 411
17381743
- name: Event
17391744
url: monitors/types/event/
17401745
parent: monitor_types
17411746
identifier: monitor_types_event
1742-
weight: 312
1747+
weight: 412
17431748
- name: Forecast
17441749
url: monitors/types/forecasts/
17451750
parent: monitor_types
17461751
identifier: monitor_types_forecasts
1747-
weight: 313
1752+
weight: 413
17481753
- name: Integration
17491754
url: monitors/types/integration/
17501755
parent: monitor_types
17511756
identifier: monitor_types_integration
1752-
weight: 314
1757+
weight: 414
17531758
- name: Live Process
17541759
url: monitors/types/process/
17551760
parent: monitor_types
17561761
identifier: monitor_types_process
1757-
weight: 315
1762+
weight: 415
17581763
- name: Logs
17591764
url: monitors/types/log/
17601765
parent: monitor_types
17611766
identifier: monitor_types_log
1762-
weight: 316
1767+
weight: 416
17631768
- name: Network
17641769
url: monitors/types/network/
17651770
parent: monitor_types
17661771
identifier: monitor_types_network
1767-
weight: 317
1772+
weight: 417
17681773
- name: Cloud Network Monitoring
17691774
url: monitors/types/cloud_network_monitoring/
17701775
parent: monitor_types
17711776
identifier: monitor_types_cnm
1772-
weight: 318
1777+
weight: 418
17731778
- name: NetFlow
17741779
url: monitors/types/netflow/
17751780
parent: monitor_types
17761781
identifier: monitor_types_netflow
1777-
weight: 319
1782+
weight: 419
17781783
- name: Outlier
17791784
url: monitors/types/outlier/
17801785
parent: monitor_types
17811786
identifier: monitor_types_outlier
1782-
weight: 320
1787+
weight: 420
17831788
- name: Process Check
17841789
url: monitors/types/process_check/
17851790
parent: monitor_types
17861791
identifier: monitor_types_process_check
1787-
weight: 321
1792+
weight: 421
17881793
- name: Real User Monitoring
17891794
url: monitors/types/real_user_monitoring/
17901795
parent: monitor_types
17911796
identifier: monitor_types_rum
1792-
weight: 322
1797+
weight: 422
17931798
- name: Service Check
17941799
url: monitors/types/service_check/
17951800
parent: monitor_types
17961801
identifier: monitor_types_service_check
1797-
weight: 323
1802+
weight: 423
17981803
- name: SLO Alerts
17991804
url: monitors/types/slo/
18001805
parent: monitor_types
18011806
identifier: monitor_types_slo
1802-
weight: 324
1807+
weight: 424
18031808
- name: Watchdog
18041809
url: monitors/types/watchdog/
18051810
parent: monitor_types
18061811
identifier: monitor_types_watchdog
1807-
weight: 325
1812+
weight: 425
18081813
- name: Notifications
18091814
url: monitors/notify/
18101815
parent: alerting
18111816
identifier: monitors_notify
1812-
weight: 4
1817+
weight: 5
18131818
- name: Notification Rules
18141819
url: monitors/notify/notification_rules/
18151820
parent: monitors_notify
18161821
identifier: monitors_notify_notification_rules
1817-
weight: 401
1822+
weight: 501
18181823
- name: Variables
18191824
url: monitors/notify/variables/
18201825
parent: monitors_notify
18211826
identifier: monitors_notify_variables
1822-
weight: 402
1827+
weight: 502
18231828
- name: Downtimes
18241829
url: monitors/downtimes/
18251830
parent: alerting
18261831
identifier: monitors_notify_downtimes
1827-
weight: 5
1832+
weight: 6
18281833
- name: Examples
18291834
url: monitors/downtimes/examples
18301835
parent: monitors_notify_downtimes
18311836
identifier: monitors_notify_downtimes_examples
1832-
weight: 501
1837+
weight: 601
18331838
- name: Manage Monitors
18341839
url: monitors/manage/
18351840
parent: alerting
18361841
identifier: monitors_manage
1837-
weight: 6
1842+
weight: 7
18381843
- name: Search Monitors
18391844
url: monitors/manage/search/
18401845
parent: monitors_manage
18411846
identifier: monitors_manage_search
1842-
weight: 601
1847+
weight: 701
18431848
- name: Check Summary
18441849
url: monitors/manage/check_summary/
18451850
parent: monitors_manage
18461851
identifier: monitors_check_summary
1847-
weight: 603
1852+
weight: 702
18481853
- name: Monitor Status
18491854
url: monitors/status/status_page
18501855
parent: alerting
18511856
identifier: monitors_status
1852-
weight: 7
1857+
weight: 8
18531858
- name: Status Graphs
18541859
url: monitors/status/graphs
18551860
parent: monitors_status
18561861
identifier: monitors_status_graphs
1857-
weight: 701
1862+
weight: 801
18581863
- name: Status Events
18591864
url: monitors/status/events
18601865
parent: monitors_status
18611866
identifier: monitors_status_events
1862-
weight: 702
1867+
weight: 802
18631868
- name: Monitor Settings
18641869
url: monitors/settings/
1865-
weight: 8
1870+
weight: 9
18661871
parent: alerting
18671872
identifier: monitor_settings
18681873
- name: Monitor Quality
18691874
url: monitors/quality/
1870-
weight: 9
1875+
weight: 10
18711876
parent: alerting
18721877
identifier: monitor_quality
18731878
- name: Guides
18741879
url: monitors/guide/
1875-
weight: 10
1880+
weight: 11
18761881
parent: alerting
18771882
identifier: alerting_guide
18781883
- name: Metrics

content/en/monitors/draft/_index.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Draft Monitors
3+
further_reading:
4+
- link: "monitors/"
5+
tag: "Documentation"
6+
text: "Monitors and Alerting Overview"
7+
- link: "monitors/configuration/?tab=thresholdalert"
8+
tag: "Documentation"
9+
text: "Configure monitors"
10+
- link: "monitors/manage/"
11+
tag: "Documentation"
12+
text: "Manage monitors"
13+
---
14+
15+
## Overview
16+
17+
Draft Monitors let you safely create, refine, and test alerts without triggering notifications.
18+
19+
Whether you're experimenting with thresholds, iterating on complex queries, or collaborating with teammates, drafts give you a clean, isolated space to work that is free from the noise of unfinished or test monitors. Also, Draft Monitors help reduce alert fatigue during development and ensure only fully vetted monitors go live.
20+
21+
Ideal for engineers and SREs managing alert workflows, Draft Monitors provide clarity across multiple teams and a sure path from idea to reliable alert.
22+
23+
## Create a draft monitor
24+
25+
To create and store monitors in a draft state:
26+
27+
1. Navigate to [**Monitors > New Monitor**][1].
28+
2. [Configure the monitor][2] (add your query, specify conditions, and optionally set notifications). Notification handles set in a draft are only used after the monitor is published.
29+
3. Click **Save as Draft**. No alerts are sent from this draft monitor.
30+
31+
{{< img src="/monitors/draft/save_as_draft.png" alt="Save as Draft button in the monitor creation interface" style="width:100%;" >}}
32+
33+
## Publish a draft monitor
34+
35+
When your monitor is ready:
36+
37+
1. Open the draft from [**Monitors List**][3] by using the draft status facet or filter by `status:draft`.
38+
2. Review the configuration.
39+
3. Click **Publish Monitor.**
40+
4. This publishes your monitor and begins alerting based on your conditions.
41+
42+
## Manage draft monitors
43+
44+
<!-- TODO Add image of Monitors List filtered to view drafts, and final QA of instructions with UI-->
45+
46+
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 without updates, but you can delete draft monitors at any time.
47+
48+
## Permissions
49+
50+
Anyone with [edit permissions][4] can update a draft monitor. You can use events to preview how often the monitor would have triggered without sending actual notifications.
51+
52+
## Best practices
53+
54+
* **Use drafts for peer reviews:** Collaborate before pushing changes live.
55+
* **Avoid noise in production:** Test alert conditions safely in a draft first.
56+
* **Track your work:** Use clear names and tags for drafts during development.
57+
* **Limit stale drafts:** Review and clean up old drafts to reduce clutter.
58+
59+
## Further reading
60+
61+
{{< partial name="whats-next/whats-next.html" >}}
62+
63+
[1]: https://app.datadoghq.com/monitors/create
64+
[2]: https://docs.datadoghq.com/monitors/configuration/?tab=thresholdalert
65+
[3]: https://app.datadoghq.com/monitors/manage
66+
[4]: /monitors/configuration/?tab=thresholdalert#permissions
228 KB
Loading

0 commit comments

Comments
 (0)