Skip to content

Commit c19113d

Browse files
committed
Port doc updates from 9.1
1 parent 2f70ce3 commit c19113d

4 files changed

Lines changed: 32 additions & 2 deletions

File tree

docs/en/observability/synthetics-configuration.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,10 @@ with the {kib} URL for the deployment from which to fetch available locations.
253253
* Find `Synthetics` in the {kibana-ref}/introduction.html#kibana-navigation-search[global search field] and click *Create monitor*.
254254
{private-location}s will be listed in _Locations_.
255255

256+
`spaces` (`Array<string>`)::
257+
The Kibana spaces in which the monitor will be visible. Monitors can be visible in multiple spaces simultaneously. Use `*` to make the monitor visible in all spaces. The project's default space is always included.
258+
259+
256260
`throttling` (`boolean` | https://github.com/elastic/synthetics/blob/{synthetics_version}/src/common_types.ts#L194-L198[`ThrottlingOptions`])::
257261
Control the monitor's download speeds, upload speeds, and latency to simulate your application's behavior on slower or laggier networks. Set to `false` to disable throttling altogether.
258262
`screenshot` (https://github.com/elastic/synthetics/blob/{synthetics_version}/src/common_types.ts#L192[`ScreenshotOptions`])::

docs/en/observability/synthetics-get-started-ui.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,9 @@ For more information, refer to <<synthetics-recorder>>.
124124
. Click *Advanced options* to see more ways to configure your monitor.
125125
+
126126
** Use *Data options* to add context to the data coming from your monitors.
127+
** Use **Maintenance windows** to prevent alerts from being triggered during scheduled downtime.
127128
** Use the *Synthetics agent options* to provide fine-tuned configuration for the synthetics agent.
129+
** Use **Spaces** to select which {kib} spaces the monitor will be visible in. You can select multiple spaces or choose to make the monitor visible in all spaces.
128130
Read more about available options in <<synthetics-command-reference>>.
129131

130132
. (Optional) Click *Run test* to verify that the test is valid.

docs/en/observability/synthetics-monitor-use.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ You'll need to set a few configuration options:
2121
* **Set the schedule.** Specify the interval at which your tests will run.
2222
* **Specify where the monitors should run.** You can run monitors on Elastic's global managed testing infrastructure
2323
or <<synthetics-private-location,create a {private-location}>> to run monitors from your own premises.
24+
* **Choose which spaces the monitor is visible in.** ({kib} only) You can make the monitor visible in one or more [spaces](/deploy-manage/manage-spaces.md), or use `'*'` for all spaces. Options set in `monitor.use()` override the project-level `spaces` setting in your Synthetics project configuration. For more information, refer to <<synthetics-configuration>>.
2425
* **Set other options as needed.** There are several other options you can set to customize your implementation including params, tags, screenshot options, throttling options, and more.
2526

2627
Configure each monitor directly in your `journey` code using `monitor.use`.
@@ -54,6 +55,5 @@ journey('Ensure placeholder is correct', ({ page, params }) => {
5455
});
5556
----
5657

57-
For each journey, you can specify its `schedule` and the `locations` in which it runs.
58-
When those options are not set, Synthetics will use the default values in the global configuration file.
58+
For each journey, you can specify its `schedule`, the `locations` in which it runs, `spaces` (applies to Stack deployments only), and other options. When an option is not set in `monitor.use()`, Synthetics uses the default from the global configuration file. Options set in `monitor.use()` take precedence over the project-level config—for example, `spaces` here overrides the global `monitor.spaces` setting.
5959
For more details, refer to <<synthetics-configuration>>.

docs/en/observability/synthetics-reference/lightweight-config/common.asciidoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,30 @@ The value defined via the CLI takes precedence over the value defined in the lig
270270
and the value defined in the lightweight monitor configuration takes precedence over the value defined in _project_ configuration file.
271271
====
272272

273+
////////////////////////
274+
spaces
275+
////////////////////////
276+
| [[monitor-spaces]] *`spaces`*
277+
(<<synthetics-lightweight-data-string,list of strings>>)
278+
a| The {kib} spaces in which the monitor will be visible. Monitors can be visible in multiple spaces simultaneously. Use `'*'` to make the monitor visible in all spaces. The project's default space is always included. Only applies to Stackdeployments; not applicable to Serverless.
279+
280+
*Examples*:
281+
282+
[source,yaml]
283+
----
284+
spaces:
285+
- default
286+
- team-ops
287+
----
288+
289+
To make the monitor visible in all spaces:
290+
291+
[source,yaml]
292+
----
293+
spaces:
294+
- '*'
295+
----
296+
273297
////////////////////////
274298
private_locations
275299
////////////////////////

0 commit comments

Comments
 (0)