From 5a50244f618ddf963b6c922d1690cb12a1adeafb Mon Sep 17 00:00:00 2001 From: Paul Bianciardi <70908889+paulb-elastic@users.noreply.github.com> Date: Tue, 28 Nov 2023 12:35:42 +0000 Subject: [PATCH] Add documentation clarification (#3382) * Update how hosts and ports are configured * Add that monitors cannot be run headful (cherry picked from commit 3271331ba6cf0cc20552a93ea68baf20694870c7) --- .../synthetics-configuration.asciidoc | 5 +++ .../synthetics-create-test.asciidoc | 5 +++ .../lightweight-config/http.asciidoc | 6 ++-- .../lightweight-config/icmp.asciidoc | 6 ++-- .../lightweight-config/tcp.asciidoc | 33 +++---------------- 5 files changed, 21 insertions(+), 34 deletions(-) diff --git a/docs/en/observability/synthetics-configuration.asciidoc b/docs/en/observability/synthetics-configuration.asciidoc index 53ad371a7d..36f3cdeb31 100644 --- a/docs/en/observability/synthetics-configuration.asciidoc +++ b/docs/en/observability/synthetics-configuration.asciidoc @@ -77,6 +77,11 @@ Read more in <>. For all available options, refer to the https://playwright.dev/docs/test-configuration[Playwright documentation]. +[NOTE] +==== +Do not attempt to run in headful mode (using `headless:false`) when running through Elastic's global managed testing infrastructure or Private Locations as this is not supported. +==== + Below are details on a few Playwright options that are particularly relevant to Elastic Synthetics including timeouts, timezones, and device emulation. [discrete] diff --git a/docs/en/observability/synthetics-create-test.asciidoc b/docs/en/observability/synthetics-create-test.asciidoc index e0607bf9b7..a7719f6101 100644 --- a/docs/en/observability/synthetics-create-test.asciidoc +++ b/docs/en/observability/synthetics-create-test.asciidoc @@ -167,6 +167,11 @@ user workflows including tasks like: Visit the https://playwright.dev/docs[Playwright documentation] for information. +[NOTE] +==== +Do not attempt to run in headful mode (using `headless:false`) when running through Elastic's global managed testing infrastructure or Private Locations as this is not supported. +==== + However, not all Playwright functionality should be used with Elastic Synthetics. In some cases, there are alternatives to Playwright functionality built into the diff --git a/docs/en/observability/synthetics-reference/lightweight-config/http.asciidoc b/docs/en/observability/synthetics-reference/lightweight-config/http.asciidoc index 992ec8d7fc..0dbaa69eca 100644 --- a/docs/en/observability/synthetics-reference/lightweight-config/http.asciidoc +++ b/docs/en/observability/synthetics-reference/lightweight-config/http.asciidoc @@ -6,8 +6,8 @@ // hosts | [[monitor-http-hosts]] *`hosts`* -(list of <>s) -a| *Required*. A list of URLs to ping. +(<>) +a| *Required*. The URL to ping. //////////////////////// max_redirects @@ -70,7 +70,7 @@ a| The TLS/SSL connection settings for use with the HTTPS endpoint. If you don't - type: http id: my-http-service name: My HTTP Service - hosts: ["https://myhost:443"] + hosts: "https://myhost:443" schedule: '@every 5s' ssl: certificate_authorities: ['/etc/ca.crt'] diff --git a/docs/en/observability/synthetics-reference/lightweight-config/icmp.asciidoc b/docs/en/observability/synthetics-reference/lightweight-config/icmp.asciidoc index 7d360753d4..4566fdf1b4 100644 --- a/docs/en/observability/synthetics-reference/lightweight-config/icmp.asciidoc +++ b/docs/en/observability/synthetics-reference/lightweight-config/icmp.asciidoc @@ -6,14 +6,14 @@ // hosts | [[monitor-icmp-hosts]] *`hosts`* -(list of <>s) -a| *Required*. A list of hosts to ping. +(<>) +a| *Required*. The host to ping. *Example*: [source,yaml] ---- -hosts: ["myhost"] +hosts: "myhost" ---- //////////////////////// diff --git a/docs/en/observability/synthetics-reference/lightweight-config/tcp.asciidoc b/docs/en/observability/synthetics-reference/lightweight-config/tcp.asciidoc index 582583c700..46c269cc05 100644 --- a/docs/en/observability/synthetics-reference/lightweight-config/tcp.asciidoc +++ b/docs/en/observability/synthetics-reference/lightweight-config/tcp.asciidoc @@ -6,11 +6,8 @@ // hosts | [[monitor-tcp-hosts]] *`hosts`* -(list of <>s) -a| *Required*. A list of hosts to ping. The entries in the list can be: - -* *A plain host name, such as `localhost`, or an IP address.* - If you specify this option, you must also specify a value for <>. If the monitor is {heartbeat-ref}/configuration-ssl.html[configured to use SSL], Synthetics establishes an SSL/TLS-based connection. Otherwise, it establishes a plain TCP connection. +(<>) +a| *Required*. The host to ping. The value can be: * *A hostname and port, such as `localhost:12345`.* Synthetics connects to the port on the specified host. If the monitor is {heartbeat-ref}/configuration-ssl.html[configured to use SSL], Synthetics establishes an SSL/TLS-based connection. Otherwise, it establishes a TCP connection. @@ -18,38 +15,18 @@ a| *Required*. A list of hosts to ping. The entries in the list can be: * *A full URL using the syntax `scheme://:[port]`*, where: ** `scheme` is one of `tcp`, `plain`, `ssl` or `tls`. If `tcp` or `plain` is specified, Synthetics establishes a TCP connection even if the monitor is configured to use SSL. If `tls` or `ssl` is specified, Synthetics establishes an SSL connection. However, if the monitor is not configured to use SSL, the system defaults are used (currently not supported on Windows). ** `host` is the hostname. -** `port` is the port number. If `port` is missing in the URL, the <> setting is required. +** `port` is the port number. *Examples*: [source,yaml] ---- -hosts: ["localhost"] ----- - -[source,yaml] ----- -hosts: ["localhost:8000"] ----- - -[source,yaml] ----- -hosts: ["tcp://localhost:8000"] +hosts: "localhost:8000" ---- -//////////////// -ports -//////////////// -| [[monitor-tcp-ports]] *`ports`* -(list of <>s) -a| A list of ports to ping if the host specified in <> does not contain a port number. It is generally preferable to use a single value here, since each port will be monitored using a separate `id`, with the given `id` value, used as a prefix in the Synthetics data, and the configured `name` shared across events sent via this check. - -*Example*: - [source,yaml] ---- -hosts: ["localhost"] -ports: [80, 9200, 5044] +hosts: "tcp://localhost:8000" ---- ////////////////