Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit fadb446

Browse files
authored
Merge pull request #2543 from splunk/adasplunk-O11YDOCS-6667
[O11YDOCS-6667] Downtime configuration updates [Mar 4 release]
2 parents dd78343 + 2809c58 commit fadb446

File tree

1 file changed

+39
-11
lines changed

1 file changed

+39
-11
lines changed

synthetics/test-config/syn-downtimes.rst

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Downtime
55
************************************************************
66

77

8-
When you are working on your site, consider using a downtime configuration to account for maintenance and other planned irregularities in your monitoring. Here is some guidance on how to choose the downtime configuration rule you want to use for your for your situation.
8+
When you're working on your site, consider using a downtime configuration to account for maintenance and other planned irregularities in your monitoring. This page provides guidance on how to choose the downtime configuration rule you want to use for your for your situation.
99

1010
.. list-table::
1111
:header-rows: 1
@@ -20,28 +20,56 @@ When you are working on your site, consider using a downtime configuration to ac
2020

2121

2222
Schedule a downtime configuration
23-
====================================
23+
============================================================
2424

25-
It's a best practice to schedule maintenance windows with a 15 to 30 minute time buffer before and after you start and stop your maintenance work. This gives the system an opportunity to catch up with the maintenance state and reduces the chances of Splunk Synthetic Monitoring generating false positives during maintenance operations.
25+
Schedule a downtime configuration to pause synthetic monitoring or augment test metrics ahead of site maintenance or anomalous behavior so that you don't skew your test data.
26+
27+
The best practice is to schedule a downtime configuration with a 15 to 30 minute buffer before and after you start and stop your maintenance work. This gives the system an opportunity to catch up with the maintenance state and reduces the chances of Splunk Synthetic Monitoring generating false positives during maintenance operations.
2628

2729
Schedule requirements:
2830

29-
* at least fifteen minutes long
30-
* up to one year in advance and one year in duration
31+
* Downtimes configurations must be at least fifteen minutes long.
32+
* Downtimes configurations can be a maximum of one year in advance and one year in duration.
3133

3234
How to schedule a downtime configuration:
3335

34-
1. In Splunk Synthetic Monitoring, go to settings, then :strong:`Downtime configurations`.
35-
2. Select :strong:`Create downtime configuration`.
36-
3. Enter a name, choose a rule, and select the test you want to include.
37-
4. Set up the schedule and select :strong:`Create`.
36+
#. In Splunk Synthetic Monitoring, go to settings, then :guilabel:`Downtime configurations`.
37+
#. Select :guilabel:`Create downtime configuration`.
38+
#. Enter a unique name, select a downtime rule, and select the tests that you want this downtime rule to apply to.
39+
#. In the :guilabel:`Schedule` section, set a start and end date and time.
40+
#. Select from the options in :guilabel:`Recurrence`.
41+
#. Select :guilabel:`Create`.
42+
43+
44+
When a recurring downtime configuration is active, you can't edit, delete, or extend it, but you can end it immediately. When a non-recurring downtime configuration is active, you can't edit or delete it, but you can extend its duration or end it immediately.
45+
46+
47+
Preview the downtime schedule
48+
----------------------------------------
49+
50+
If you selected a value other than :guilabel:`Does not repeat` in the :guilabel:`Recurrence` menu, the :guilabel:`Create a downtime configuration` form displays a preview of the first ten downtime configurations.
51+
52+
53+
Mute alerts during downtime
54+
============================================================
3855

3956
To mute any alerts associated with a test included in a downtime configuration window, see :ref:`mute-notifications`.
4057

41-
When a downtime configuration is active, you can't edit, or delete it. You can extend the duration, or cancel while it is active.
58+
59+
View the downtime configurations that apply to a given test
60+
============================================================
61+
62+
To see downtime configurations that apply to any test and time range:
63+
64+
#. Select that test.
65+
#. Zoom in on the time span of either of the test's charts as needed.
66+
67+
The start and end time of any applicable downtime configurations are marked on the x-axis of the chart as triangles.
68+
69+
4270

4371
Records
44-
======================
72+
============================================================
4573

4674
The downtime configuration record shows when the window started and finished. The records are kept for thirteen months.
4775

0 commit comments

Comments
 (0)