Skip to content

[synthetics] Add maintenance windows options docs #4035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −0
Open

[synthetics] Add maintenance windows options docs #4035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions solutions/observability/synthetics/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,12 @@ If the journey contains external NPM packages other than the `@elastic/synthetic

This can also be set in the configuration file using [the `monitor.fields` option](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-monitor). The value defined via the CLI will take precedence.

`--maintenance-windows Array<string>`
: A list of maintenance window IDs used to associate every monitor with one or more [maintenance windows](/explore-analyze/alerts-cases/alerts/maintenance-windows.md). This argument accepts a variable number of values as shown in the example.
Example: `--maintenance-windows "maintenance-window-ID-1" "maintenance-window-ID-2`
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Example: `--maintenance-windows "maintenance-window-ID-1" "maintenance-window-ID-2`
Example: `--maintenance-windows "maintenance-window-ID-1" "maintenance-window-ID-2`

Just adding a line here to match the formatting of the other example(s) in the doc.

Copy link
Member

@bmorelli25 bmorelli25 Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's annoying that the GH suggestion UI makes it look like you also increased the indent size. I had to view the raw MD to see that you didn't.


This can also be set in the configuration file using [the `monitor.fields` option](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-monitor). The value defined via the CLI will take precedence.

`--yes`
: The `push` command includes interactive prompts to prevent you from accidentally deleting or duplicating monitors. If running the CLI non-interactively, you can override these prompts using the `--yes` option. When the `--yes` option is passed to `push`:

Expand Down
13 changes: 13 additions & 0 deletions solutions/observability/synthetics/configure-lightweight-monitors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,19 @@ $$$monitor-namespace$$$
namespace: custom-namespace
```

$$$monitor-maintenanceWindows$$$

**`maintenance_windows`**
: Type: [string](/solutions/observability/synthetics/configure-lightweight-monitors.md#synthetics-lightweight-data-string)

A list of maintenance window IDs used to associate this monitor with one or more [maintenance windows](/explore-analyze/alerts-cases/alerts/maintenance-windows.md).

**Examples**:

```yaml
maintenance_windows: ["maintenance-window-ID-1", "maintenance-window-ID-2"]
```

### HTTP options [synthetics-lightweight-http]

The options described here configure Synthetics to connect via HTTP and optionally verify that the host returns the expected response.
Expand Down
3 changes: 3 additions & 0 deletions solutions/observability/synthetics/configure-projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,9 @@ For information on configuring monitors individually, refer to:
* [Configure individual browser monitors](/solutions/observability/synthetics/configure-individual-browser-monitors.md) for browser monitors
* [Configure lightweight monitors](/solutions/observability/synthetics/configure-lightweight-monitors.md) for lightweight monitors

`maintenanceWindows` (`Array<string>`)
: A list of maintenance window IDs used to associate this monitor with one or more [maintenance windows](/explore-analyze/alerts-cases/alerts/maintenance-windows.md).

## `proxy` [synthetics-configuration-proxy]

`uri` (`string`)
Expand Down
Loading