How to define a maintenance window

Dynatrace provides two methods for defining maintenance windows

  • Configuration API
  • Dynatrace web UI

This page describes the UI-based approach. For the API reference, see Maintenance windows API.

Define a maintenance window

Each maintenance window you configure has a name and description that you can use to provide contextual information about the purpose of the maintenance window.

To define a maintenance window

  1. From the Dynatrace menu, go to Settings > Maintenance windows > Monitoring, alerting, and availability.
  2. Select Create maintenance window.
  3. Define a Name for the maintenance window.
  4. Provide a Description of the purpose of the maintenance window.
  5. From the Maintenance type list, select Planned or Unplanned.
  6. Use the fields provided to define a recurrence schedule (one-time, daily, weekly, or monthly) and the recurrence timeframe.
  7. From the Problem detection and alerting list, specify what Dynatrace should do if a monitored component experiences a problem during the maintenance window:
    • Detect problems and alert: Dynatrace will automatically detect and report all problems as usual and display a maintenance window icon on each problem that is detected during the maintenance window.
    • Detect problems but don't alert: Dynatrace will detect problems but will not send out alerts for them. Each problem will be listed on the Problems page with a maintenance window icon.
    • Disable problem detection: Dynatrace will not detect problems or send out alerts for them. Problems that occur during scheduled maintenance windows will not be included on the Problems page and no alerts will be sent out.
  8. optional Disable synthetic monitor execution during the maintenance window.
  9. If necessary, define the scope of the new maintenance window. Otherwise, it applies to the entire environment.

Disable synthetic monitor execution

You can opt to Disable synthetic monitor execution during a maintenance window. During the maintenance window, executions of the following types of synthetic monitors will be disabled, as defined within the scope of the maintenance window:

  • Browser monitors
  • HTTP monitors
  • Browser and HTTP monitors associated with services and web, mobile, and custom applications

Important

To disable synthetic monitor execution during a maintenance window, you must add the synthetic monitors (see the supported types above) to the scope of the maintenance window using the entity and tag filters provided. Execution will only be disabled for the subset of synthetic monitors included within the maintenance-window scope.

Define the scope of the maintenance window

By default, a maintenance window applies to your entire environment. You can narrow down the scope of a maintenance window to specific monitored entities while leaving everything else unaffected. You define the scope by specifying one or more entity filters (Add entity filter) and/or tag filters (Add entity tag filter).

To add an entity filter (Add entity filter), select an entity type, for example, Hosts, from the list provided. Optionally, if you narrow the list by selecting specific hosts by name, the maintenance window will apply only to the selected hosts. If you don't select named hosts, the maintenance window will apply to all hosts in your environment.

You can add multiple entity filters—each entity filter is applied independently. So if you add an entity filter for two named hosts and another for two named services, the selected hosts and services will all be included within the scope of your maintenance window.

You can also define tag-based entity filters, in addition to or instead of name-based entity filters. To add a tag filter (Add entity tag filter), first select the entity type from the list provided. Then add one or more tags from the list provided. Any entities of the selected type that match all the added tags will be included within the scope of your maintenance window. If you don't specify any tags, all entities of the selected type will be included in the maintenance window.

You can add multiple tag-based entity filters—each filter is applied independently. So let's say you add a filter for browser monitors tagged with easytravel and frontend and another for HTTP monitors tagged easytravel-api. Your maintenance-window scope will include browser monitors with both the tags easytravel and frontend as well as HTTP monitors with the tag easytravel-api.

To define a scope that includes entities that have any tag from a given set, you need to add a separate tag-based entity filter for every tag in the list.

As you set up filters, you can check the messaging below the filters to see exactly which entities are affected by your maintenance window.

Note

To disable synthetic monitor execution during a maintenance window, you must add the synthetic monitors (see the supported types above) to the scope of the maintenance window.