Skip to content

Commit

Permalink
[8.10](backport #3300) Fix browser project monitor alert config (#3357)
Browse files Browse the repository at this point in the history
* Fix browser project monitor alert config (#3300)

(cherry picked from commit 653bbdd)

# Conflicts:
#	docs/en/observability/synthetics-configuration.asciidoc

* fix merge conflict

---------

Co-authored-by: Paul Bianciardi <[email protected]>
Co-authored-by: Colleen McGinnis <[email protected]>
  • Loading branch information
3 people authored Nov 13, 2023
1 parent 9583f06 commit e26be41
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions docs/en/observability/synthetics-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Read more in <<synthetics-params-secrets>>.
[[synthetics-configuration-playwright-options]]
= `playwrightOptions`

For all available options, refer to the https://playwright.dev/docs/test-configuration[Playwright documentation].
For all available options, refer to the https://playwright.dev/docs/test-configuration[Playwright documentation].

Below are details on a few Playwright options that are particularly relevant to Elastic Synthetics including timeouts, timezones, and device emulation.

Expand Down Expand Up @@ -194,7 +194,7 @@ To list available locations you can:
Locations will be listed in _Locations_.

`privateLocations` (`Array<string>`)::
The <<synthetics-private-location,{private-location}s>> to which the monitors will be deployed. These {private-location}s refer to locations hosted and managed by you, whereas
The <<synthetics-private-location,{private-location}s>> 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:
Expand All @@ -209,17 +209,11 @@ Control the monitor's download speeds, upload speeds, and latency to simulate yo
`screenshot` (https://github.com/elastic/synthetics/blob/{synthetics_version}/src/common_types.ts#L192[`ScreenshotOptions`])::
Control whether or not to capture screenshots. Options include `'on'`, `'off'`, or `'only-on-failure'`.

`alert` (https://github.com/elastic/synthetics/blob/{synthetics_version}/src/dsl/monitor.ts#L47-L54[`AlertConfig`])::
Enable or disable alerts. Read more about alerts in <<synthetics-settings-alerting>>.
+
`status.enabled` (`boolean`):::
Enable monitor status alerts.
+
`tls.enabled` (`boolean`):::
Enable TLS certificate alerts.
`alert.status.enabled` (`boolean`)::
Enable or disable monitor status alerts. Read more about alerts in <<synthetics-settings-alerting>>.
// end::monitor-config-options[]

For information on configuring monitors individually, refer to:

* <<synthetics-monitor-use>> for browser monitors
* <<synthetics-monitor-use>> for browser monitors
* <<synthetics-lightweight>> for lightweight monitors

0 comments on commit e26be41

Please sign in to comment.