You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: synthetics/browser-test/set-up-browser-test.rst
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,17 @@
2
2
.. _set-up-browser-test:
3
3
4
4
**************************************
5
-
Set up a Browser test
5
+
Set up a browser test
6
6
**************************************
7
7
8
8
.. meta::
9
9
:description: Steps to set up a browser test to track the performance of specific site resources, or a multi-step user flow, in Splunk Synthetic Monitoring.
10
10
11
11
12
-
Use a Browser test to monitor the user experience for a single page or a multi-step user flow by running a synthetic test of the URLs you provide. Use this type of test to monitor conversion paths or any path that requires multiple steps or runs JavaScript. For an example, see :ref:`browser-test-scenario`.
12
+
Use a browser test to monitor the user experience for a single page or a multi-step user flow by running a synthetic test of the URLs you provide. Use this type of test to monitor conversion paths or any path that requires multiple steps or runs JavaScript. For an example, see :ref:`browser-test-scenario`.
13
13
14
14
15
-
For each page checked in a Browser test, Splunk Synthetic Monitoring captures an HTTP Archive (HAR) file, represented in a waterfall chart, which illustrates the performance of specific resources within the page. Browser tests also capture a set of 40+ metrics. See :ref:`waterfall-chart` and :ref:`browser-metrics` to learn more.
15
+
For each page checked in a browser test, Splunk Synthetic Monitoring captures an HTTP Archive (HAR) file, represented in a waterfall chart, which illustrates the performance of specific resources within the page. Browser tests also capture a set of 40+ metrics. See :ref:`waterfall-chart` and :ref:`browser-metrics` to learn more.
16
16
17
17
.. note::
18
18
If the site or application you are monitoring uses allow lists or block lists for visitors or an analytics tool to measure traffic, check that it's configured to accommodate traffic from Splunk Synthetic Monitoring. See :ref:`synth-configure-app` for instructions.
@@ -24,22 +24,22 @@ Set up a Browser test
24
24
=========================
25
25
26
26
27
-
For optimal experience, synthetics browser tests use a stable version of Google Chrome: ``116.0.5845.96-1`` to simulate user activity.
27
+
For optimal experience, browser tests use a stable version of Google Chrome: ``116.0.5845.96-1`` to simulate user activity.
28
28
29
-
Follow these steps to set up a Browser test:
29
+
Follow these steps to set up a browser test:
30
30
31
31
#. From the landing page of Splunk Observability Cloud, navigate to Splunk Synthetic Monitoring.
32
32
33
33
#. Under :guilabel:`Tests`, select :guilabel:`Create new test` and then select :guilabel:`Browser test` from the drop-down list. The test creation view opens.
34
34
35
35
#. In the :guilabel:`Name` field, enter a name for your test.
36
36
37
-
#. To add steps and synthetic transactions to your Browser test, select :guilabel:`Edit steps or synthetic transactions`. See :ref:`add-transactions` to learn more.
37
+
#. To add steps and synthetic transactions to your browser test, select :guilabel:`Edit steps or synthetic transactions`. See :ref:`add-transactions` to learn more.
38
38
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`.
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. See:ref:`try-now`.
40
40
41
-
#. (Optional) Add a wait time before a step executes. See,:ref:`browser-wait-times`.
42
-
#. (Optional) Turn on automatic test retry in the event a test initially fails.
41
+
#. (Optional) Add a wait time before a step executes. See :ref:`browser-wait-times`.
42
+
#. (Optional) Enable automatic test retry in the event a test initially fails.
43
43
44
44
45
45
#. Save your test.
@@ -80,23 +80,23 @@ For steps on how to make a Google Chrome recording, see :new-page:`Record, repla
.. Note:: Included within recordings from Google Chrome Recorder is the specific viewport size of the browser window used in the recording. When imported, this recorded viewport is not imported into the Synthetics Browser test. Check that the Synthetics Browser test device selection accurately represents the viewport size used by the recorded browser window.
83
+
.. Note:: Included within recordings from Google Chrome Recorder is the specific viewport size of the browser window used in the recording. When imported, this recorded viewport is not imported into the browser test. Check that the browser test's device selection accurately represents the viewport size used by the recorded browser window.
84
84
85
85
86
-
Follow these steps to import a JSON file from Google Chrome Recorder to a new or existing Browser test.
86
+
Follow these steps to import a JSON file from Google Chrome Recorder to a new or existing browser test.
87
87
88
88
89
89
#. In Splunk Synthetic Monitoring, select :guilabel:`Edit` on an existing Browser test to open the test configuration page, or create a new test.
90
-
#. Select Import.
90
+
#. Select :guilabel:`Import`.
91
91
#. Upload the Google Chrome Recorder JSON file.
92
-
#. If a step is not supported, you need to edit or delete the step in the test configuration page.
92
+
#. If a step is not supported, edit or delete that step in the test configuration page.
93
93
#. (Optional) Add a name to each step.
94
94
#. Save your changes.
95
95
96
96
97
97
Troubleshoot unsupported steps
98
98
=======================================
99
-
If your recording contains unsupported steps, you need to edit the step to reformat it into one of the supported Synthetic Browser step types. The following table shows how Google Chrome Recorder step names and code snippets map to their counterparts in Splunk Synthetic Browser tests. These examples use Buttercup Games, a fictitious game company.
99
+
If your recording contains unsupported steps, you need to edit the step to reformat it into one of the supported browser step types. The following table shows how Google Chrome Recorder step names and code snippets map to their counterparts in browser tests. These examples use Buttercup Games, a fictitious gaming company.
100
100
101
101
102
102
.. tabs::
@@ -350,21 +350,21 @@ If your recording contains unsupported steps, you need to edit the step to refor
350
350
351
351
352
352
353
-
View your Browser test
353
+
View your browser test
354
354
====================================
355
355
356
356
Now that you created and saved a test, check whether it's collecting data as expected:
357
357
358
358
#. From the :guilabel:`Tests` list, select the three-dot :guilabel:`Actions` menu and select :guilabel:`Play` arrow icon to manually trigger a live run of the test, or wait for at least one duration of the test frequency you set so that the test has time to run and collect data.
359
359
#. Select the test you're interested in to open the :guilabel:`Test history` view, where you can view visualizations of recent test results and metrics.
360
360
361
-
#. See :ref:`browser-test-results` to learn more about Browser test results.
361
+
#. See :ref:`browser-test-results` to learn more about browser test results.
362
362
363
363
364
-
Edit your Browser test
364
+
Edit your browser test
365
365
========================
366
366
367
-
To edit your Browser test, do the following:
367
+
To edit your browser test, do the following:
368
368
369
369
#. Select the row for the test you want to edit in the :guilabel:`Tests` list to open the :guilabel:`Test history` view.
370
370
#. Select :guilabel:`Edit test` to edit your test configuration.
@@ -373,7 +373,7 @@ If you change the name of your test or the name of a synthetic transaction, it m
There are many reasons why you might want to configure advanced settings for your synthetics tests. Here are a few:
@@ -395,7 +395,7 @@ Interactive metrics are collected by default for each page in the test flow, but
395
395
396
396
* First CPU idle: Time until the page is minimally interactive and responds to user input.
397
397
* Time to interactive: This measures the time until the page responds to user input quickly. It is used to identify when the page is actually usable, not just when the page load looks complete.
398
-
* Lighthouse score: A weighted aggregation of several Browser test metric values calculated using v10 of the Lighthouse desktop scoring algorithm. See :new-page:`https://developer.chrome.com/docs/lighthouse/performance/performance-scoring#lighthouse_10` in the Google developer documentation to learn more about Lighthouse scoring.
398
+
* Lighthouse score: A weighted aggregation of several browser test metric values calculated using v10 of the Lighthouse desktop scoring algorithm. See :new-page:`https://developer.chrome.com/docs/lighthouse/performance/performance-scoring#lighthouse_10` in the Google developer documentation to learn more about Lighthouse scoring.
399
399
400
400
401
401
.. _auto-retry:
@@ -473,14 +473,14 @@ You can also indicate whether to retain the original ``HOST`` header by activati
473
473
474
474
Wait times
475
475
---------------------
476
-
Optimize your test coverage by adding custom wait times to capture longer page loads and improve the accuracy of run results. Applications with long load times can cause a Browser test to fail. If you know that there are certain steps in a workflow that take longer than 10 seconds, add a custom wait time to your Browser test.
476
+
Optimize your test coverage by adding custom wait times to capture longer page loads and improve the accuracy of run results. Applications with long load times can cause a browser test to fail. If you know that there are certain steps in a workflow that take longer than 10 seconds, add a custom wait time to your browser test.
477
477
478
-
* Wait times are available with Browser tests only.
478
+
* Wait times are available with browser tests only.
479
479
* The maximum custom wait time for each test is 200 seconds.
480
480
481
-
Follow these steps to configure custom wait times for your Browser tests:
481
+
Follow these steps to configure custom wait times for your browser tests:
482
482
483
-
#. In Splunk Synthetic Monitoring, select :guilabel:`Edit` on the Browser test to open the configuration panel.
483
+
#. In Splunk Synthetic Monitoring, select :guilabel:`Edit` on the browser test to open the configuration panel.
484
484
#. Select :guilabel:`New step > Wait`, from the step type drop down.
485
485
#. Add a name and the wait time in ms.
486
486
#. When you finish instrumenting your test, save the workflow: :guilabel:`Return to test > Save`.
0 commit comments