diff --git a/docs/en/observability/synthetics-configuration.asciidoc b/docs/en/observability/synthetics-configuration.asciidoc index 364522f054..39e465c839 100644 --- a/docs/en/observability/synthetics-configuration.asciidoc +++ b/docs/en/observability/synthetics-configuration.asciidoc @@ -219,4 +219,7 @@ Enable monitor status alerts. Enable TLS certificate alerts. // end::monitor-config-options[] -For information on configuring monitors individually, refer to <>. +For information on configuring monitors individually, refer to: + +* <> for browser monitors +* <> for lightweight monitors diff --git a/docs/en/observability/synthetics-reference/lightweight-config/common.asciidoc b/docs/en/observability/synthetics-reference/lightweight-config/common.asciidoc index bf96c27192..2f1e929de3 100644 --- a/docs/en/observability/synthetics-reference/lightweight-config/common.asciidoc +++ b/docs/en/observability/synthetics-reference/lightweight-config/common.asciidoc @@ -46,7 +46,7 @@ name (<>) a| Human readable name for this monitor. -*Examples*: +*Examples*: [source,yaml] ---- @@ -218,6 +218,78 @@ Enable TLS certificate alerts on this monitor. alert.tls.enabled: true ---- +//////////////////////// +locations +//////////////////////// +| [[monitor-locations]] *`locations`* +(list of https://github.com/elastic/synthetics/blob/{synthetics_version}/src/locations/public-locations.ts#L28-L37[`SyntheticsLocationsType`]) +a| Where to deploy the monitor. You can deploy monitors in multiple locations to detect differences in availability and response times across those locations. + +To list available locations you can: + +* Run the <>. +* Go to *Synthetics* -> *Management* and click *Create monitor*. Locations will be listed in _Locations_. + +*Examples*: + +[source,yaml] +---- +locations: ["japan", "india"] +---- + +[source,yaml] +---- +locations: + - japan + - india +---- + +[NOTE] +==== +This can also be set using +<> +or via the CLI using the <>. + +The value defined via the CLI takes precedence over the value defined in the lightweight monitor configuration, +and the value defined in the lightweight monitor configuration takes precedence over the value defined in _project_ configuration file. +==== + +//////////////////////// +private_locations +//////////////////////// +| [[monitor-private_locations]] *`private_locations`* +(list of <>s) +a| The <> to which the monitors will be deployed. These {private-location}s refer to locations hosted and managed by you, whereas `locations` are hosted by Elastic. You can specify a {private-location} using the location's name. + +To list available {private-location}s you can: + +* Run the <> and specify the {kib} URL of the deployment. This will fetch all available private locations associated with the deployment. +* Go to *Synthetics* -> *Management* and click *Create monitor*. {private-location}s will be listed in _Locations_. + +*Examples*: + +[source,yaml] +---- +private_locations: ["Private Location 1", "Private Location 2"] +---- + +[source,yaml] +---- +private_locations: + - Private Location 1 + - Private Location 2 +---- + +[NOTE] +==== +This can also be set using +<> +or via the CLI using the <>. + +The value defined via the CLI takes precedence over the value defined in the lightweight monitor configuration, +and the value defined in the lightweight monitor configuration takes precedence over the value defined in _project_ configuration file. +==== + |=== :!hardbreaks-option: