Private Location

Creating Private Location and Agent

Private location is a system dedicated to perform load tests using your own systems with our agents, which allows you to bypass or satisfy the conditions for security environments such as firewall. Since the feature utilizes Docker containers, its installation and usage requires Docker software pre-installed.

Creating a Private Location

  • You can access to Private Location Page from the Account Page.

  • You can simply click on the Add Private Location button and enter the desired parameters to create your private location.

On Premise Parameters

  1. Name: Name of the private location.

  2. Override number of CPUs: Amount of CPUs to be consumed by the engines. It can be fractional number (i.e 3.5 will use 3 and a half CPU).

  3. Override memory: Amount of memory (MB) to be consumed by the engines.

  4. JVM XMX: Specifies the maximum memory allocation pool for the Java Virtual Machine (JVM)

  5. JVM XMS: Specifies the initial memory allocation pool for the Java Virtual Machine (JVM)

  • Once you create the private location, you will be directed to its details page, where you can edit the location or add agents to it.

Note: Before you can add an agent, you need to generate Access Key from the Account Page. This key ensures the security of transactions between your requests and our services.

Creating Agent and Running on Docker

  • Only name is required for creating an agent. Once you create the agent, you will be presented with the docker command which you can use to create and run docker container for your private location.

Note: If you have lost your docker command for the agent, you can simply Regenerate it.

  • After you generated the command, just run it on console and the installation process will start.

Note: If you are using Windows operating system, there are additional steps to setup docker containers before running. You can find the details here.

Note: In case you changed the agent’s name, docker command will be regenerated automatically. However, to start the container with the new name, you need to delete the previous container with the old name from docker.

  • After installation process is finished, you can confirm if the operation is successful by checking its Status and Last Heartbeat in the Private Location page (you might need to refresh the page).

Agent Statuses

  • Idle: Node is connected, available for a test run.

  • Running: Node is currently busy, running a test.

  • Finished: Node has just completed a test (still busy), finalizing the processes then will become Idle.

  • Time Out: Node is disconnected, no updates received from the node.

Starting Test With Private Location

In order to use the created private location, you can simply select it from Geolocation segment in Test Create/Edit Page. It will use the first available (idle) agents to start the test.

Note: Considering the test's configuration, each engine requires an available agent from the selected private location. If there aren't enough agents then the test will not start.

Additional Note: If there is a VPN requirement for the endpoint you are testing, and since the test will run on a Docker container, sometimes Docker cannot utilize the VPN connection. So make sure to start VPN connection first then start Docker, or restart Docker after VPN connection is established.

Enjoy Load testing!

pageReport MetricspageJMeter TestpageSandbox

If you don't see the answer to your question here, please reach out to us to let us know! We're always improving our documentation.

Last updated