Docs » Advanced test configurations » Downtime

Downtime 🔗

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.

Downtime configuration

Description

Pause tests

Suppose you are doing some maintenance on your site which impacts the login workflow. Choose to pause tests that are impacted by the maintenance so that you don’t need to monitor the recurring failure messages around the known issue of being unable to login because of site maintenance.

Augment data

If you are obligated to keep monitoring your site for SLAs even while you’re doing maintenance, choose to augment the data with a dimension under_maintenance.Then, you can filter out the augmented data so they don’t impact your average metrics. All tests from a downtime window have the dimension under_maintenance=true.

Schedule a downtime configuration 🔗

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.

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.

Schedule requirements:

  • Downtimes configurations must be at least fifteen minutes long.

  • Downtimes configurations can be a maximum of one year in advance and one year in duration.

How to schedule a downtime configuration:

  1. In Splunk Synthetic Monitoring, go to settings, then Downtime configurations.

  2. Select Create downtime configuration.

  3. Enter a unique name, select a downtime rule, and select the tests that you want this downtime rule to apply to.

  4. In the Schedule section, set a start and end date and time.

  5. Select from the options in Recurrence.

  6. Select Create.

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.

Preview the downtime schedule 🔗

If you selected a value other than Does not repeat in the Recurrence menu, the Create a downtime configuration form displays a preview of the first ten downtime configurations.

Mute alerts during downtime 🔗

To mute any alerts associated with a test included in a downtime configuration window, see Mute alert notifications.

View the downtime configurations that apply to a given test 🔗

To see downtime configurations that apply to any test and time range:

  1. Select that test.

  2. Zoom in on the time span of either of the test’s charts as needed.

    The start and end time of any applicable downtime configurations are marked on the x-axis of the chart as triangles.

Records 🔗

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

During a downtime configuration window, there are gaps in synthetics metrics if you chose to the rule to pause tests. Any metrics with active tests for the rule to augment data have the dimension under_maintenance: true.

This page was last updated on Mar 03, 2025.