Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 5e6a6e9

Browse files
committed
Clarify custom headers usage
1 parent c190d32 commit 5e6a6e9

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

synthetics/browser-test/set-up-browser-test.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -422,21 +422,23 @@ More details on Chrome authentication are available :new-page:`here list <https:
422422

423423
.. Custom content
424424
425-
.. _browser-cookies:
426-
427-
Cookies
428-
-------------
429-
430-
Set cookies in the browser before the test starts. For example, to circumvent a popup modal from randomly appearing and interfering with your test, you can set cookies. Any cookies that are set will apply to the domain of the starting URL of the check. Splunk Synthetics Monitoring uses the :new-page:`public suffix list <https://publicsuffix.org/>` to determine the domain.
431-
432425
.. _browser-headers:
433426

434427
Custom headers
435428
--------------------------
436429

437-
Specify custom headers to send with each request. For example, you can add a header in your request to filter out requests from analytics on the back end by sending a specific header in the requests. You can also use custom headers to set cookies.
430+
Specify custom headers to send with each request. For example, you can add a header in your request to filter out data from back-end analytics. To add a custom header, a name and value are required. You may optionally provide a domain to scope the header to. If a domain is specified, only requests sent to that domain will include the header. Otherwise the header will be included in requests to all domains.
431+
432+
You can also use headers to change the user agent. The default user agent is the given one for the selected device, which updates whenever the Chrome version changes for synthetic runners. To customize the user agent header for all domains, turn off the "Use device default" toggle next to the user agent field and then enter the new value. To change the user agent for specific domains, add a custom header and provide the domain you wish to apply that user agent to. If a domain is not specified, the top-level user agent setting takes precedence.
438433

439-
The default user agent is the given one for the selected device, which updates whenever the Chrome version changes for synthetic runners. You can customize the user agent header for specific domains by adding a custom header. If a domain is not specified, the top-level user agent setting takes precedence.
434+
Custom headers can be used to set cookies, but we recommend using the Cookies settings instead outlined in the section below.
435+
436+
.. _browser-cookies:
437+
438+
Cookies
439+
-------------
440+
441+
Set cookies in the browser before the test starts. For example, to circumvent a popup modal from randomly appearing and interfering with your test, you can set cookies. Any cookies that are set will apply to the domain of the starting URL of the check. Splunk Synthetics Monitoring uses the :new-page:`public suffix list <https://publicsuffix.org/>` to determine the domain.
440442

441443

442444
.. _browser-host-overrides:

0 commit comments

Comments
 (0)