Skip to content

Commit 2f2d152

Browse files
author
ada
committed
[O11YDOCS-6956] Excluded files
1 parent b046278 commit 2f2d152

File tree

2 files changed

+43
-3
lines changed

2 files changed

+43
-3
lines changed
141 KB
Loading

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

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Follow these steps to set up a Browser test:
3636

3737
#. To add steps and synthetic transactions to your Browser test, select :guilabel:`Edit steps or synthetic transactions`. See :ref:`add-transactions` to learn more.
3838

39-
#. As you build your test, you can use :guilabel:`Try now` to check that the configuration of your test is valid. Try now results are ephemeral and dont impact persisted run metrics. For more, see :ref:`try-now`.
39+
#. As you build your test, you can use :guilabel:`Try now` to check that the configuration of your test is valid. Try now results are ephemeral and don't impact persisted run metrics. For more, see :ref:`try-now`.
4040

4141
#. (Optional) Add a wait time before a step executes. See, :ref:`browser-wait-times`.
4242
#. (Optional) Turn on automatic test retry in the event a test initially fails.
@@ -528,6 +528,46 @@ Here are the limits for each type of wait time. The maximum limit for a run is 3
528528

529529

530530

531+
Excluded files
532+
------------------------------
533+
534+
You can configure your browser test to ignore specific file types or patterns so that it skips all HTTP requests that match those file types or patterns.
535+
536+
Exclusion rules are useful to:
537+
538+
539+
* Prevent false alerts from test analytics.
540+
* Test the performance of a page with or without specific resources loading.
541+
* Prevent specific third party services from loading, such as random pop-ups from third party services.
542+
* Ignore files that are known to cause performance problems.
543+
544+
545+
To create an exclusion rule:
546+
547+
#. On the browser test's configuration page, select the :guilabel:`Advanced toggle`.
548+
#. Scroll down to the :guilabel:`Custom content` section.
549+
#. Select :guilabel:`Add excluded file`.
550+
#. Select a value in :guilabel:`File type`:
551+
552+
.. image:: /_images/synthetics/synthetics-browser-test-excluded-files.png
553+
:width: 60%
554+
:alt: This image shows an exclusion rule for all files of type Crazy Egg.
555+
556+
* To exclude all files of a common predefined type, select that type.
557+
* To exclude all file types except those that match the value you specify, select :guilabel:`All Except` and specify a value or regular expression.
558+
* To use regular expressions, select :guilabel:`Custom` and specify a value or regular expression.
559+
For example:
560+
561+
* To exclude specific domains, enter ``domainname\.com``
562+
* To exclude specific subdomains, enter ``.+\.domainname\.com``
563+
* To exclude a JavaScript app, enter ``domainname\.com/appname\.js``
564+
* To exclude entire directories, enter ``domainname\.com/scripts\/.+``
565+
566+
.. note::
567+
If you use multiple exclusions or multiple :guilabel:`All Except` rules, the :guilabel:`All Except` inclusions always take precedence over other exclusions. Order is always ignored unless you are using a combination :guilabel:`All Except` and :guilabel:`Custom` exclusions.
568+
569+
570+
531571
Chrome flags
532572
----------------
533573
Google Chrome flags are a helpful tool for troubleshooting. Activate browser features that are not available by default to test custom browser configurations and specialized use cases, like a proxy server.
@@ -568,14 +608,14 @@ Add custom properties in the test creation page in advanced settings. Use key-va
568608
:alt: This image shows two custom property key value pairs, env:prod and role:developer.
569609

570610

571-
Custom properties are single-valued and dont support multiple values, like ``region:eu, us``. For each test, you can only use one and unique key. For example, you can have ``env1:test`` and ``env:test`` in the same test, but you can't have ``env:test``, and ``env:prod``.
611+
Custom properties are single-valued and don't support multiple values, like ``region:eu, us``. For each test, you can only use one and unique key. For example, you can have ``env1:test`` and ``env:test`` in the same test, but you can't have ``env:test``, and ``env:prod``.
572612

573613

574614
Key requirements:
575615

576616
* Keys must start with an uppercase or lowercase letter. Keys can't start with special characters or numbers.
577617
* The remainder of the key can contain letters, numbers, underscores and hyphens.
578-
* Keys cant be named ``test_id`` or ``test``.
618+
* Keys can't be named ``test_id`` or ``test``.
579619
* Key size can't exceed 128 characters.
580620

581621
See, :ref:`custom-properties`.

0 commit comments

Comments
 (0)