Skip to content

Commit

Permalink
[Uptime] Document params browser option, fix docs hierarchy. (#27303)…
Browse files Browse the repository at this point in the history
… (#27305)

* [Uptime] Document `params` browser option, fix docs hierarchy.

Fixes #27217 and also improves the ordering of documentation here,
putting the most used options first, and the least used last.

* Update heartbeat/docs/monitors/monitor-browser.asciidoc

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

* Update heartbeat/docs/monitors/monitor-browser.asciidoc

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
(cherry picked from commit 07b546d)

Co-authored-by: Andrew Cholakian <andrew@andrewvc.com>
  • Loading branch information
mergify[bot] and andrewvc authored Aug 11, 2021
1 parent f947bfc commit a94372c
Showing 1 changed file with 32 additions and 8 deletions.
40 changes: 32 additions & 8 deletions heartbeat/docs/monitors/monitor-browser.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,17 +106,28 @@ Example configuration:
-------------------------------------------------------------------------------

[float]
[[monitor-browser-sandbox]]
==== `sandbox`
[[monitor-browser-params]]
==== `params`

Set this option to `true` to enable the normally disabled chromium sandbox. Defaults to false.
Set this option to add user defined parameters for your scripts. This value takes
arbitrary YAML that is then converted to JSON which is then passed into synthetics
via the `--params` option. See {observability-guide}/synthetics-params-secrets.html[Working with Params]
for more information.

[float]
[[monitor-browser-synthetics-args]]
==== `synthetics_args`
Example:

Extra arguments to pass to the synthetics agent package. Takes a list of
strings.
[source,yaml]
-------------------------------------------------------------------------------
- type: browser
id: local-journeys
name: Local journeys
schedule: '@every 1m'
source: # Omitted in this example for brevity
params:
root_url: http://example.net
my_custom_object:
a_key: ["a value"]
-------------------------------------------------------------------------------

[float]
[[monitor-browser-screenshots]]
Expand Down Expand Up @@ -145,3 +156,16 @@ Example configuration:
path: "/path/to/synthetics/journeys"
-------------------------------------------------------------------------------

[float]
[[monitor-browser-sandbox]]
==== `sandbox`

Set this option to `true` to enable the normally disabled chromium sandbox. Defaults to false.


[float]
[[monitor-browser-synthetics-args]]
==== `synthetics_args`

Extra arguments to pass to the synthetics agent package. Takes a list of
strings.

0 comments on commit a94372c

Please sign in to comment.