Skip to content

Commit de7711b

Browse files
[synthetics] Add maintenance windows options docs (#4035)
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Add maintenance windows options to synthetics docs. Relates to elastic/synthetics#1103. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> --------- Co-authored-by: Mike Birnstiehl <[email protected]>
1 parent e4b3e5a commit de7711b

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

solutions/observability/synthetics/cli.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,13 @@ If the journey contains external NPM packages other than the `@elastic/synthetic
180180

181181
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.
182182

183+
`--maintenance-windows Array<string>`
184+
: 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.
185+
186+
Example: `--maintenance-windows "maintenance-window-ID-1" "maintenance-window-ID-2`
187+
188+
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.
189+
183190
`--yes`
184191
: 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`:
185192

solutions/observability/synthetics/configure-lightweight-monitors.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,19 @@ $$$monitor-namespace$$$
377377
namespace: custom-namespace
378378
```
379379

380+
$$$monitor-maintenanceWindows$$$
381+
382+
**`maintenance_windows`**
383+
: Type: [string](/solutions/observability/synthetics/configure-lightweight-monitors.md#synthetics-lightweight-data-string)
384+
385+
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).
386+
387+
**Examples**:
388+
389+
```yaml
390+
maintenance_windows: ["maintenance-window-ID-1", "maintenance-window-ID-2"]
391+
```
392+
380393
### HTTP options [synthetics-lightweight-http]
381394

382395
The options described here configure Synthetics to connect via HTTP and optionally verify that the host returns the expected response.

solutions/observability/synthetics/configure-projects.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,9 @@ For information on configuring monitors individually, refer to:
295295
* [Configure individual browser monitors](/solutions/observability/synthetics/configure-individual-browser-monitors.md) for browser monitors
296296
* [Configure lightweight monitors](/solutions/observability/synthetics/configure-lightweight-monitors.md) for lightweight monitors
297297

298+
`maintenanceWindows` (`Array<string>`)
299+
: 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).
300+
298301
## `proxy` [synthetics-configuration-proxy]
299302

300303
`uri` (`string`)

0 commit comments

Comments
 (0)