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

Commit e581a95

Browse files
authored
Merge pull request #2514 from splunk/adasplunk-O11YDOCS-6771
[O11YDOCS-6771] Normalize, alphabetize, deduplicate the "advanced test config" section
2 parents 4e5a89c + 29bdb1e commit e581a95

File tree

13 files changed

+94
-107
lines changed

13 files changed

+94
-107
lines changed

index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -758,17 +758,17 @@ To keep up to date with changes in the products, see the Splunk Observability Cl
758758
.. toctree::
759759
:maxdepth: 3
760760

761-
Uptime Tests for port and HTTP TOGGLE <synthetics/uptime-test/uptime-test>
761+
Uptime tests for port and HTTP TOGGLE <synthetics/uptime-test/uptime-test>
762762

763763
.. toctree::
764764
:maxdepth: 3
765765

766-
Use an API test to test an endpoint TOGGLE <synthetics/api-test/api-test>
766+
API tests for endpoints TOGGLE <synthetics/api-test/api-test>
767767

768768
.. toctree::
769769
:maxdepth: 3
770770

771-
synthetics/test-kpis/test-kpis
771+
Test status TOGGLE <synthetics/test-status/test-status>
772772

773773
.. toctree::
774774
:maxdepth: 3

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-
API Tests for endpoint
4+
API tests for endpoints
55
************************************
66

77
.. meta::

synthetics/test-config/built-in-variables.rst

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

33
***********************************
4-
Built-in variables to use in tests
4+
Built-in variables
55
***********************************
66

77
.. meta::

synthetics/test-config/devices.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _devices:
2+
3+
*****************************************
4+
Devices
5+
*****************************************
6+
7+
.. meta::
8+
:description: Select a predefined device to simulate a specific viewport size and network connection for a test.
9+
10+
When you set up a test in Splunk Synthetic Monitoring, you can select a predefined device to simulate a specific viewport size and network connection for that test. Every predefined device is a combination of a specific viewport size and network connection.
11+
12+
* A viewport is the framed area on a device's screen for viewing information, such as the browser window on a desktop. Since a viewport is an integral part of the visual experience of a user interacting with your application or site, viewport settings only apply to visual tests (browser tests). Viewport settings don't apply to API or uptime tests, because these tests are non-visual -- they only capture response data from your application or site.
13+
* A network connection is the network type, speed, bandwidth, and latency experienced by a device. Since a network connection is an integral part of all experiences, network connection settings apply to all test types. Testing your site or application from a variety of network connections helps you to monitor the experience of users in a variety of environments.
14+
15+
16+
Select a device type for Splunk Synthetic Monitoring tests
17+
==========================================================
18+
19+
All tests have the device type :guilabel:`Default Desktop` by default. To change this for any test, follow these steps:
20+
21+
#. From the landing page of Splunk Observability Cloud, navigate to Splunk Synthetic Monitoring.
22+
#. Select the test that you want to change.
23+
#. Select :guilabel:`Edit test`. The test creation view opens.
24+
#. In the :guilabel:`Device` field, select one of the predefined devices.
25+
#. Select :guilabel:`Save`.
26+

synthetics/test-config/global-variables.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.. _global-variables:
22

33
*****************************************
4-
Create and use global variables
4+
Global variables
55
*****************************************
66

77
.. meta::
88
:description: Define a variable that you can use in multiple browser and API tests in Splunk Synthetic Monitoring.
99

10-
Define a global variable once, and then use it across all of your browser and API tests.
10+
Global variables are pre-saved, reusable variables that you define once and use across all your browser and API tests.
1111

1212

1313
How can you use a global variable?

synthetics/test-config/private-locations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Private locations
55
*****************
66

77
.. meta::
8-
:description: Run synthetic tests from an internal site or private web application to quickly find defects using Splunk Synthetic Monitoring.
8+
:description: Run synthetic tests from private locations such as internal sites, private web applications, or private networks.
99

1010
A private location is a software package that offers a quick and easy deployment of Splunk Synthetic Monitoring solutions beyond the public network so that you can find, fix, and prevent web performance defects on any internal web application, in any environment - whether inside or outside of your firewalls. Private locations allow Splunk Synthetics Monitoring users to test sooner in the development cycle and against internal sites or applications that aren't available to the public.
1111

synthetics/test-config/public-locations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Public locations
55
*****************
66

77
.. meta::
8-
:description: Run synthetic tests from locations set by infrastructure and connectivity providers to simulate performance for users in that location.
8+
:description: Run synthetic tests from locations set by infrastructure and connectivity providers to simulate performance from a range of checkpoints around the world.
99

1010
Public locations are global checkpoints from which you can run synthetic tests to simulate performance for users in that location.
1111

synthetics/test-config/syn-downtimes.rst

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

33
************************************************************
4-
Schedule a downtime configuration
4+
Downtime
55
************************************************************
66

77

synthetics/test-config/synth-alerts.rst

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

33
************************************************************
4-
Set up detectors and alerts in Splunk Synthetic Monitoring
4+
Detectors and alerts
55
************************************************************
66

77
.. meta::

synthetics/test-config/test-config.rst

Lines changed: 6 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -9,92 +9,19 @@ Advanced test configurations
99

1010
.. toctree::
1111

12-
synth-alerts
1312
built-in-variables
13+
synth-alerts
14+
devices
15+
syn-downtimes
1416
global-variables
15-
public-locations
1617
private-locations
18+
public-locations
1719
rum-synth
1820
try-now
19-
syn-downtimes
21+
2022

2123
To simulate diverse types of traffic to your site or application, use a range of configuration options to customize each of your tests.
2224

23-
========================================================================================
24-
Devices
25-
========================================================================================
26-
27-
When you set up a test in Splunk Synthetic Monitoring, you can configure the viewport and network connection of the device from which the test is simulated.
28-
29-
Because Browser tests capture the visual experience of a page, while Uptime and API tests only capture response data, viewport applies to Browser tests only. Network connection applies to all test types.
30-
31-
----------------------------------------------------------------------------------------
32-
Viewport
33-
----------------------------------------------------------------------------------------
34-
Browser tests in Splunk Synthetic Monitoring capture the visual experience of a user interacting with your application. The viewport is the framed area on a device's screen for viewing information, such as the browser window on a desktop. By default, Browser tests run from a desktop-sized viewport. You can configure tests to run from other viewport sizes to test the user experience from a variety of window sizes and device types.
35-
36-
When you set up a test, you can choose the viewport size from a list of common devices, or set a custom viewport by height and width.
37-
38-
----------------------------------------------------------------------------------------
39-
Network connection
40-
----------------------------------------------------------------------------------------
41-
You can run Browser, Uptime, or API tests to simulate network connections of various latencies, including Mobile LTE, Mobile 3G, DSL, Mobile 5G, and cable internet. Testing your site from a variety of connection types lets you monitor the experience of users in a variety of settings.
42-
43-
========================================================================================
44-
Variables
45-
========================================================================================
46-
Use variables to fill in fields, provide URLs, and enter other information during your tests.
47-
48-
.. list-table::
49-
:header-rows: 1
50-
:widths: 20 80
51-
52-
* - :strong:`Variable type`
53-
- :strong:`Description`
54-
* - Built-in variables
55-
- Built-in variables such as random values, dates and times, or location names, for use in your Browser and API Tests. See :ref:`built-in-variables` to learn more.
56-
* - Global variables
57-
- Pre-saved, reusable variables you can define once and use across all your Browser and API tests. See :ref:`global-variables` to learn more.
58-
59-
========================================================================================
60-
Locations
61-
========================================================================================
62-
Specify locations for your tests to simulate traffic from a range of checkpoints around the world, or use private locations to test sites from within a private network.
63-
64-
For more, see:
65-
66-
* :ref:`public-locations`
67-
* :ref:`private-locations`
68-
69-
.. * See :ref:`private-locations` to set up private locations.
70-
71-
72-
========================================================================================
73-
Test state and current status
74-
========================================================================================
75-
You can use the play and pause buttons in the more menu (|more|) of your tests to pause or resume data collection.
76-
77-
The current status of a test is updated every time you load the :guilabel:`Test Overview` page in Splunk Synthetic Monitoring. The following table describes the possible status types for each test.
78-
79-
.. list-table::
80-
:header-rows: 1
81-
:widths: 20, 80
82-
83-
* - :strong:`Current status`
84-
- :strong:`Description`
85-
86-
* - Pending
87-
- Splunk Synthetic Monitoring is still retrieving the status of this test.
88-
89-
* - Available
90-
- The test is functioning properly. If the test is active, data is being collected at the set interval and can be viewed in the :guilabel:`Test History` page. If the test is paused, it can be unpaused and will resume collecting data.
91-
92-
* - No Data
93-
- The test isn't currently collecting data.
94-
95-
* - Failure
96-
- The test encountered a failure.
97-
9825
========================================================================================
9926
Test naming conventions
10027
========================================================================================
@@ -106,22 +33,6 @@ Choosing informative names for your tests and alerts helps organize content. Her
10633

10734
.. image:: /_images/synthetics/ButtercupGames-naming-convention.png
10835
:width: 60%
109-
:alt: This image shows two Browser tests with the prefix [ButtercupGames].
110-
111-
112-
================================
113-
Troubleshoot broken tests
114-
================================
115-
116-
See, :ref:`syn-troubleshoot`.
36+
:alt: This image shows two browser tests with the prefix [ButtercupGames].
11737

11838

119-
120-
========================================================================================
121-
Filter tests
122-
========================================================================================
123-
You can filter by test type, key-value pairs, and more.
124-
125-
.. image:: /_images/synthetics/syn-filter-test.png
126-
:width: 60%
127-
:alt: This image shows the filter env:prod for all tests on the Synthetic homepage..

0 commit comments

Comments
 (0)