From 487bd38dfeab0d861baa6d224c9310825e5dd74f Mon Sep 17 00:00:00 2001 From: manel Date: Mon, 4 May 2026 18:51:48 +0200 Subject: [PATCH 1/4] docs: document maintenance window check behavior --- communicate/maintenance-windows/overview.mdx | 52 +++++++++++++++++--- 1 file changed, 45 insertions(+), 7 deletions(-) diff --git a/communicate/maintenance-windows/overview.mdx b/communicate/maintenance-windows/overview.mdx index 2acad6c1..5698b6a6 100644 --- a/communicate/maintenance-windows/overview.mdx +++ b/communicate/maintenance-windows/overview.mdx @@ -1,6 +1,6 @@ --- title: 'Maintenance Windows' -description: 'Schedule planned maintenance periods to prevent false alerts.' +description: 'Schedule planned maintenance periods to prevent false alerts and control check behavior during downtime.' sidebarTitle: 'Maintenance Windows' --- @@ -8,8 +8,17 @@ sidebarTitle: 'Maintenance Windows' **Monitoring as Code**: Learn more about the [Maintenance Window Construct](/constructs/maintenance-window). -Maintenance windows allow you to schedule planned downtime for your services, preventing false alerts and preserving accurate availability metrics during system updates, deployments, and infrastructure maintenance activities. During these windows, Checkly stops executing checks for the targeted services, eliminating false alerts while preserving historical availability data. +Maintenance windows allow you to schedule planned downtime for your services, preventing false alerts and preserving accurate availability metrics during system updates, deployments, and infrastructure maintenance activities. +During a maintenance window you can independently control two behaviors: +- **Pause check execution** — scheduled check runs are skipped entirely. +- **Silence alerts** — checks keep running and collecting data, but alert channel notifications (email, Slack, etc.) are suppressed. + +You can enable either behavior, both, or neither depending on what you need. + + +Manual and triggered check runs (e.g. via the API or the Checkly UI) are **not** affected by maintenance windows — they always execute regardless of whether checks are paused. + ## Creating a maintenance window @@ -34,14 +43,43 @@ If your maintenance window repeats at a certain cadence, toggle the **repeat** o > If you schedule a window on the 31st and add a **monthly repeat cycle**, your schedule will also activate on > the 30th of the relevant months and the 28th or 29th of February depending on the leap year. -### Adding checks and check groups +### Check behavior + +Each maintenance window lets you configure how checks behave during the maintenance period. Toggle the behaviors you need: + +#### Pause check execution -![Maintenance window checks](/images/maintenance-checks-2.png) +When enabled, scheduled check runs are skipped for the duration of the window. You can scope which checks are paused: -You need to select which checks and/or check groups are targeted by your maintenance window. You do this by: +- **All checks** — every check in the account is paused. +- **Checks matching tags** — only checks (and check groups) with matching tags are paused. -- Adding the relevant check tags. -- Adding the relevant check group tags. +#### Silence alerts + +When enabled, alert channel notifications are suppressed while checks continue to run and collect data. This is useful when you want to keep monitoring but avoid noisy alerts during expected degradation. You can scope which checks are silenced: + +- **All checks** — alerts are silenced for every check in the account. +- **Checks matching tags** — only checks (and check groups) with matching tags have their alerts silenced. + + +If a check starts failing during the maintenance window and continues failing after the window ends, Checkly will **not** retroactively send an alert once the window is over — the alert is suppressed. Enable **Firewatch** on your home dashboard to surface checks that started failing during maintenance. + + + +You can use different tag sets for pausing and silencing. For example, pause your `api` checks while silencing alerts for `frontend` checks that might be affected by the same deployment. + + +### Adding checks via tags + +You scope which checks are affected by adding tags to the pause or silence configuration. Any checks or check groups with matching tags will be included. This way, any checks or check groups created *after* creating your maintenance window can still be made part of the window; no need to update the maintenance window configuration. Just set the correct tags. + +## Monitoring maintenance status + +During an active maintenance window, the home dashboard shows: + +- A **banner** at the top summarizing which behaviors are active (paused, silenced, or both). +- A **Maintenance badge** on each affected check row, with a tooltip showing the maintenance window name and whether the check is paused, silenced, or both. +- An **Under maintenance** filter in the status filter dropdown, allowing you to quickly find all checks currently affected by a maintenance window. From ccdb477557e1809e51a0bafb61dc92b21be792f1 Mon Sep 17 00:00:00 2001 From: manel Date: Tue, 5 May 2026 14:59:47 +0200 Subject: [PATCH 2/4] docs: clarify that alert silencing still applies to manual runs --- communicate/maintenance-windows/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/communicate/maintenance-windows/overview.mdx b/communicate/maintenance-windows/overview.mdx index 5698b6a6..e256e5e7 100644 --- a/communicate/maintenance-windows/overview.mdx +++ b/communicate/maintenance-windows/overview.mdx @@ -17,7 +17,7 @@ During a maintenance window you can independently control two behaviors: You can enable either behavior, both, or neither depending on what you need. -Manual and triggered check runs (e.g. via the API or the Checkly UI) are **not** affected by maintenance windows — they always execute regardless of whether checks are paused. +Manual and triggered check runs (e.g. via the API or the Checkly UI) always execute, even when check execution is paused. However, if alert silencing is enabled, alerts from these runs will still be suppressed. ## Creating a maintenance window From bbb4660938c6511f9c8e23c4c7224c0c6b74287f Mon Sep 17 00:00:00 2001 From: Manel Fourati Date: Tue, 5 May 2026 19:34:29 +0200 Subject: [PATCH 3/4] Update communicate/maintenance-windows/overview.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Hervé Labas <431257+thebiglabasky@users.noreply.github.com> --- communicate/maintenance-windows/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/communicate/maintenance-windows/overview.mdx b/communicate/maintenance-windows/overview.mdx index e256e5e7..9bbdc826 100644 --- a/communicate/maintenance-windows/overview.mdx +++ b/communicate/maintenance-windows/overview.mdx @@ -14,7 +14,7 @@ During a maintenance window you can independently control two behaviors: - **Pause check execution** — scheduled check runs are skipped entirely. - **Silence alerts** — checks keep running and collecting data, but alert channel notifications (email, Slack, etc.) are suppressed. -You can enable either behavior, both, or neither depending on what you need. +You can enable a combination of these settings depending on what you need. Manual and triggered check runs (e.g. via the API or the Checkly UI) always execute, even when check execution is paused. However, if alert silencing is enabled, alerts from these runs will still be suppressed. From 893c0293bc5f70c62c5b7d74b557cd32abde1548 Mon Sep 17 00:00:00 2001 From: manel Date: Tue, 5 May 2026 19:41:27 +0200 Subject: [PATCH 4/4] docs: address PR feedback, remove duplication and fix Firewatch description --- communicate/maintenance-windows/overview.mdx | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/communicate/maintenance-windows/overview.mdx b/communicate/maintenance-windows/overview.mdx index 9bbdc826..c09a01df 100644 --- a/communicate/maintenance-windows/overview.mdx +++ b/communicate/maintenance-windows/overview.mdx @@ -8,13 +8,7 @@ sidebarTitle: 'Maintenance Windows' **Monitoring as Code**: Learn more about the [Maintenance Window Construct](/constructs/maintenance-window). -Maintenance windows allow you to schedule planned downtime for your services, preventing false alerts and preserving accurate availability metrics during system updates, deployments, and infrastructure maintenance activities. - -During a maintenance window you can independently control two behaviors: -- **Pause check execution** — scheduled check runs are skipped entirely. -- **Silence alerts** — checks keep running and collecting data, but alert channel notifications (email, Slack, etc.) are suppressed. - -You can enable a combination of these settings depending on what you need. +Maintenance windows allow you to schedule planned downtime for your services, preventing false alerts and preserving accurate availability metrics during system updates, deployments, and infrastructure maintenance activities. During a maintenance window you can pause check execution, silence alert notifications, or both. Manual and triggered check runs (e.g. via the API or the Checkly UI) always execute, even when check execution is paused. However, if alert silencing is enabled, alerts from these runs will still be suppressed. @@ -62,7 +56,7 @@ When enabled, alert channel notifications are suppressed while checks continue t - **Checks matching tags** — only checks (and check groups) with matching tags have their alerts silenced. -If a check starts failing during the maintenance window and continues failing after the window ends, Checkly will **not** retroactively send an alert once the window is over — the alert is suppressed. Enable **Firewatch** on your home dashboard to surface checks that started failing during maintenance. +If a check starts failing during the maintenance window and continues failing after the window ends, Checkly will **not** retroactively send an alert once the window is over — the alert is suppressed. After maintenance, check the **Firewatch** section on the home dashboard — it shows checks that started failing recently. Firewatch can be enabled and configured in your account preferences.