Skip to content

Commit 9090759

Browse files
authored
Merge pull request #2532 from splunk/adasplunk-O11YDOCS-6843
[O11YDOCS-6843] Reorder some paragraphs
2 parents a82e8a6 + 8de3a97 commit 9090759

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

synthetics/test-config/private-locations.rst

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,33 @@ Private locations
77
.. meta::
88
:description: Run synthetic tests from private locations such as internal sites, private web applications, or private networks.
99

10-
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.
10+
A private location is a name you create in Splunk Synthetic Monitoring to represent a custom location from which you can run synthetic tests. The name you give to a private location allows you to specify that name in a synthetic test's :guilabel:`Locations` field. To run synthetic tests from private locations, you must also set up one or more private runners within the private location to do the actual communication with your test targets and with Splunk Synthetic Monitoring.
1111

12-
Customers can, through the Splunk Synthetics Monitoring web interface, create new private locations and open a runner to run any checks assigned to them.
1312

14-
What is a runner?
15-
===================
16-
17-
A runner is a Docker container set up to run tests from a particular private location. A single private location can have one or more runners.
18-
19-
A location consists of a queue of tests assigned to a particular private location. Runners pick up runs from the queue, so the more active runners you have, the faster the queue of tests is processed.
20-
21-
Splunk Synthetic Monitoring doesn't track how many runners there are for a given location. It is up to you to manage your own fleet of runners.
13+
Use cases for private locations
14+
====================================
2215

16+
Private locations provide a way for you to find, fix, and prevent performance problems in internal applications in any environment, inside or outside of your firewalls. You can use private locations to run tests earlier in your development cycle against internal sites or applications that aren't available to the public. You can also use private locations to test public endpoints from locations that aren't included in the :ref:`list of Splunk Synthetic Monitoring public locations <public-locations>`.
2317

24-
Use cases for private locations
25-
=================================
18+
To summarize, here are sample use cases for private locations:
2619

2720
* Test private applications that aren't exposed to the public.
2821
* Test pre-production applications which don't have public staging sites.
29-
* Gain a higher level of flexibility in giving Splunk Synthetic Monitoring access to applications.
22+
* Gain a higher level of flexibility by giving Splunk Synthetic Monitoring access to applications.
3023
* Test from locations not currently supported by Splunk Synthetic Monitoring's public locations.
3124

3225

33-
Requirements
34-
=============
26+
What is a private runner?
27+
================================
28+
29+
A private runner is a Docker image which you deploy on your own infrastructure, within your own internal network. It picks up test runs from the queue of tests assigned to its associated private location, performs the actions in the test run on the test target, and reports the results back to Splunk Synthetic Monitoring.
30+
31+
32+
If you create multiple private runners for a private location, they can process that location's test queue faster. Splunk Synthetic Monitoring doesn't track how many private runners there are for a given private location. It's up to you to manage your own fleet of private runners.
33+
34+
35+
Requirements for private runners
36+
==========================================
3537

3638

3739
.. list-table::
@@ -55,21 +57,21 @@ Requirements
5557
- Linux, Windows, or macOS
5658

5759

58-
For optimal performance when running Browser tests:
60+
For optimal performance when running browser tests:
5961

6062
* Linux
6163
* 2.3 GHz Dual-Core Intel Xeon (or equivalent) processor
6264
* 8 GB RAM, 2 cores
6365

6466

6567
Set up a new private location
66-
===============================
68+
=====================================
6769

6870
Follow these steps to set up a new private location:
6971

7072
1. In Splunk Synthetic Monitoring, select the settings gear icon, then :guilabel:`Private locations`.
7173
2. Select :guilabel:`+ Add` and add a name.
72-
3. Follow the steps in the guided setup to set up your runner.
74+
3. Follow the steps in the guided setup to set up one or more private runners for that private location.
7375
4. Save your private location.
7476

7577

@@ -139,7 +141,7 @@ For example, here is what a command might look like after you modify it to fit y
139141

140142

141143

142-
Configuring Proxy Settings for Private Locations
144+
Configuring proxy settings for a private location
143145
===================================================
144146

145147
In environments where direct internet access is restricted, you can route synthetic test traffic through a proxy server by configuring the following environment variables:
@@ -194,7 +196,7 @@ When using runner, it's important to correctly configure the proxy settings to a
194196

195197

196198

197-
Assess the health of your private location
199+
Assess the health of a private location
198200
==============================================
199201

200202
A private location's health depends on three factors:

0 commit comments

Comments
 (0)