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

Commit 89f24d9

Browse files
authored
Merge pull request #2105 from splunk/gschatzO11YDOCS-6232
bringing over remaining rigor content
2 parents f26fab9 + fe87d84 commit 89f24d9

File tree

10 files changed

+94
-53
lines changed

10 files changed

+94
-53
lines changed

index.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -843,7 +843,18 @@ To keep up to date with changes in the products, see the Splunk Observability Cl
843843
.. toctree::
844844
:maxdepth: 3
845845

846-
Configure your tests TOGGLE <synthetics/test-config/test-config>
846+
Advanced test configurations TOGGLE <synthetics/test-config/test-config>
847+
848+
.. toctree::
849+
:maxdepth: 3
850+
851+
Troubleshoot tests TOGGLE <synthetics/syn-troubleshoot/syn-troubleshoot>
852+
853+
854+
.. toctree::
855+
:maxdepth: 3
856+
857+
Troubleshoot tests <synthetics/syn-troubleshoot/syn-missing-alerts>
847858

848859
.. toctree::
849860
:caption: Splunk On-Call

synthetics/api-test/api-test.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _api-test:
22

33
************************************
4-
Use an API Test to test an endpoint
4+
API Tests for endpoint
55
************************************
66

77
.. meta::

synthetics/browser-test/browser-test-results.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _browser-test-results:
22

33
***********************************************
4-
Interpret Browser Test results
4+
Interpret Browser test results
55
***********************************************
66

77
.. meta::

synthetics/browser-test/browser-test.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _browser-test:
22

33
****************************************
4-
Use a Browser test to test a webpage
4+
Browser tests for webpages
55
****************************************
66

77
.. meta::
@@ -21,7 +21,7 @@ You can configure tests on a schedule so you're continually monitoring your site
2121
.. raw:: html
2222

2323
<embed>
24-
<h2>What happens during a Browser test?</h2>
24+
<h2>What does a Browser test monitor?</h2>
2525
</embed>
2626

2727
During a Browser test, Splunk Synthetic Monitoring continuously collects performance data including metrics, network data, and custom user timings. All requests and responses that occur in the test are captured in a HAR file, which is represented visually in a waterfall chart that illustrates the latency of specific resources on the page. See :ref:`waterfall-chart` to learn more about the waterfall chart, and see :ref:`browser-metrics` to learn about the metrics in a Browser test.

synthetics/set-up-synthetics/set-up-synthetics.rst

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,30 @@ Set up Splunk Synthetic Monitoring
1111

1212
Monitor the performance of your web pages and applications by running synthetic Browser, Uptime, and API tests. These tests let you proactively alert the relevant teams when a site or user flow they manage becomes unavailable, as well as report on the performance of a site or user flow over time. Splunk Synthetic Monitoring does not require extensive installation and setup: you can get started by creating your first test directly in the Splunk Synthetic Monitoring user interface.
1313

14+
.. _synth-configure-app:
15+
16+
Get your site ready to run synthetic tests
17+
============================================
18+
19+
.. meta::
20+
:description: Information about the settings you need to configure for your application or site in order to receive traffic from Splunk Synthetic Monitoring.
21+
22+
There are a couple of settings you might need to add to your application or webpage to receive traffic from Splunk Synthetic Monitoring.
23+
24+
25+
Allow Splunk Synthetic Monitoring IP addresses
26+
-------------------------------------------------
27+
28+
Splunk Synthetic Monitoring runs synthetic tests from a set of dedicated IP addresses. To ensure your internal network or web application firewall (WAF) does not block this traffic, place these IP addresses on your browser or site's allow list.
29+
30+
See :ref:`public-locations` for the list of Splunk Synthetic Monitoring IP addresses, and then refer to your internal network's documentation for instructions on how to add them to your allow list.
31+
32+
Exclude Splunk Synthetic Monitoring from analytics
33+
----------------------------------------------------
34+
If you use a web analytics tool to monitor traffic on your website or application, you might want to exclude Splunk Synthetic Monitoring IP addresses from being counted as traffic.
35+
36+
To do so, filter Splunk Synthetic Monitoring IP addresses in the settings of your web analytics tool. See :ref:`public-locations` for the list of IP addresses, and then refers to your analytics tool's documentation for instructions on how to filter them.
37+
1438

1539
Choose a test
1640
============================================================
@@ -116,12 +140,6 @@ For more examples on Java instrumentation, see :ref:`server-trace-information-ja
116140

117141
Integrate with Splunk RUM so that you can automatically measure Web Vital metrics against your run results. Web vitals capture key metrics that affect user experience and assess the overall performance of your site. For more, see :ref:`rum-synth`.
118142

119-
(Optional) Configure your application
120-
------------------------------------------------------------------------
121-
122-
123-
If you use Splunk Synthetic Monitoring to monitor an application or website with allow/block lists or a web analytics tool, you might want to adjust the settings to accommodate traffic from Splunk Synthetic Monitoring. See :ref:`synth-configure-app` for detailed instructions.
124-
125143

126144
Continue learning
127145
==============================
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. _syn-missing-alerts:
2+
3+
*********************************************************
4+
Troubleshoot missing alerts
5+
*********************************************************
6+
7+
.. meta::
8+
:description: Troubleshoot broken tests
9+
10+
Troubleshoot missing alerts in Synthetic tests.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. _syn-troubleshoot:
2+
3+
****************************************
4+
Troubleshoot broken tests
5+
****************************************
6+
7+
.. meta::
8+
:description: Troubleshoot broken tests
9+
10+
11+
12+
There are a number of reasons why your tests might fail like issues with test validation or application unresponsiveness. For example,
13+
14+
* API endpoint was unreachable
15+
* URL was unreachable
16+
* UI element wasn't found
17+
* Default wait time of 10 seconds is too short for step assertions to complete. A test might fail because it takes longer than 10 seconds for a website to load.
18+
19+
Troubleshoot test validation
20+
===============================
21+
22+
Follow these guidelines to troubleshoot a broken test.
23+
24+
#. (Optional) Make a copy of the test so that you can check various solutions before fixing the original test.
25+
#. Open the test page and see when the test started to fail. Consider the following questions:
26+
27+
* When did the check fail? Is there a pattern among other failed runs?
28+
* Does the check fail consistently on the same step, or intermittently?
29+
* Is this the first time the check has failed on this step? Did you make a recent change to the test?
30+
* Was the failure tied to a specific location or across all locations?
31+
32+
#. Open the run results view of a failed test, find the step that is failing and go to the link.
33+
#. Open inspect element.
34+
#. Duplicate the step and repeat the steps in your test until you find the broken step.
35+
#. Verify that there is one instance only of the selector you want to use in your test. If the selector appears more than once your test might break again in the future. Unique selectors provide optimal test performance.
36+
#. Update your tests with your findings.
37+
38+

synthetics/test-config/synth-configure-app.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

synthetics/test-config/test-config.rst

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
.. _test-config:
22

33
***************************************************
4-
Manage synthetic tests
4+
Advanced test configurations
55
***************************************************
66

77
.. meta::
88
:description: Customize tests run in Splunk Synthetic Monitoring by setting up different devices, variables, locations, test status, and other configurations to best simulate diverse types of traffic to your site or application.
99

1010
.. toctree::
1111

12-
synth-configure-app
1312
synth-alerts
1413
built-in-variables
1514
global-variables
@@ -110,24 +109,13 @@ Choosing informative names for your tests and alerts helps organize content. Her
110109
:alt: This image shows two Browser tests with the prefix [ButtercupGames].
111110

112111

113-
========================================================================================
114-
Troubleshoot broken tests
115-
========================================================================================
116-
Follow these guidelines to troubleshoot a broken test.
112+
================================
113+
Troubleshoot broken tests
114+
================================
117115

118-
#. (Optional) Make a copy of the test so that you can check various solutions before fixing the original test.
119-
#. Open the test page and see when the test started to fail. Consider the following questions:
116+
See, :ref:`syn-troubleshoot`.
120117

121-
* When did the check fail? Is there a pattern among other failed runs?
122-
* Does the check fail consistently on the same step, or intermittently?
123-
* Is this the first time the check has failed on this step? Did you make a recent change to the test?
124-
* Was the failure tied to a specific location or across all locations?
125118

126-
#. Open the run results view of a failed test, find the step that is failing and go to the link.
127-
#. Open inspect element.
128-
#. Duplicate the step and repeat the steps in your test until you find the broken step.
129-
#. Verify that there is one instance only of the selector you want to use in your test. If the selector appears more than once your test might break again in the future. Unique selectors provide optimal test performance.
130-
#. Update your tests with your findings.
131119

132120
========================================================================================
133121
Filter tests

synthetics/uptime-test/uptime-test.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _uptime-test:
33

44
**************************************************
5-
Use an Uptime Test to test port or HTTP uptime
5+
Uptime Tests for port and HTTP
66
**************************************************
77

88
.. meta::

0 commit comments

Comments
 (0)