From 01b186c9d210caf03472f3d70aaf7b9b8d293691 Mon Sep 17 00:00:00 2001 From: paulb-elastic Date: Thu, 3 Aug 2023 10:31:16 +0100 Subject: [PATCH] Added warning about then to use headful mode --- docs/en/observability/synthetics-command-reference.asciidoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/en/observability/synthetics-command-reference.asciidoc b/docs/en/observability/synthetics-command-reference.asciidoc index 66e39d52de..18dd0882c2 100644 --- a/docs/en/observability/synthetics-command-reference.asciidoc +++ b/docs/en/observability/synthetics-command-reference.asciidoc @@ -72,6 +72,11 @@ Runs with the browser in headful mode. + This is the same as running `--playwright-options '{"headless": false}'`. +[NOTE] +===== +Headful mode is only to be used locally when testing, to help see the browser being shown and to interact with DOM elements. Do not attempt to run in headful mode when running through Elastic's global managed testing infrastructure, or {private-location}s. +===== + `-h, --help`:: Shows help for the `npx @elastic/synthetics` command.