Guest blog by HaiYan Shi (Kally) and Naren Chejara
StormRunner Load R&D team
StormRunner Load is a SaaS based performance testing application which can help address performance on Web and Mobile applications. It supports both cloud and on-premises locations to generate the required loads for customer applications (both private and public applications).
The StormRunner Load On-Premises (a.k.a on-premises load generator or OPLG) feature is designed to test applications (AUTs) behind a firewall and enables customers to use their own VM’s to test both private and public applications, overcoming any security concerns.
StormRunner Load prepares cloud components and assigns an appropriate task to the on-premises load generator. The load generator generates the load for the customer’s application and sends data back to cloud components -> StormRunner Load application.
StormRunner Load On-Premises Process Flow
To run an on-premises test with StormRunner Load:
- Install the StormRunner Load Generator (Windows / Linux version).
- Create the load generator in the StormRunner Load UI to get the LG key (this step can be skipped for Linux load generators as they support an auto-register key feature).
- Configure the LG key and other required fields in the StormRunner Load Generator and start it.
- Run a test on an on-premises location.
Install a StormRunner Load Generator
The StormRunner load generator supports both Windows and Linux operating systems. This section explains how to install, uninstall, update, and configure the load generator on both systems.
1. StormRunner Load Generator on Windows OS
1.1 Install a StormRunner Load Generator
- Download the StormRunner load generator installation file from the StormRunner Load Home
- Make sure the machine meets the requirements as described in the StormRunner Load Help Center.
-Connect to StormRunner Load.
-Navigate to the Home page.
-Find Get Tools and select the Agents tab.
-Click Get OPLG.
- Unzip the downloaded file and run the StormRunnerLoadGenerator.exe file.
- Accept the terms and conditions of the license and then click Install. The installation process starts and may take some minutes to finish.
- Once installed, click Restart to make sure that the LG is functioning correctly.
You will see that the StormRunner Load generator creates Configure SRL Generator.exe and Start SRL Generator.exe icons on the Desktop and in the Start menu.
1.2 Uninstall a StormRunner Load Generator
- Navigate to Control Panel > All Control Panel Items > Programs and Features, select StormRunner Load Generator, and click Uninstall in the top rail.
- In the StormRunner Load Generator pop-up window, click Uninstall. The uninstallation process will begin and may take some time to complete. Note: If a StormRunner Load upgrade patch has been installed, you must uninstall this patch before uninstalling the full version of the StormRunner load generator.
- Click Close to finish the uninstallation.
1.3 Upgrade a StormRunner Load Generator
StormRunner Load has released an upgrade patch installation together with the full installation. This patch helps to upgrade the old version to the latest version without having to reinstall the full version.
- Download the StormRunner load generator upgrade patch installation file:
-Connect to StormRunner Load.
-Navigate to the Home page.
-Find Get Tools and select the Agents tab.
-Click Get Upgrade Package.
- Run the extracted file SRLUpgradePatch.exe. Accept the terms and conditions of the license and then click Install. The installation process starts and may take some minutes to finish.
- In the pop-up window, click Restart to make sure that the updated LG is functioning correctly.
1.4 Generate the LG key
In StormRunner Load, navigate to Assets > Load Generators and click Create to create a new load generator in the StormRunner Load UI. Configure the required fields, set the maximum v-users limit of the LG, and click Save.
Select the newly created load generator and copy the key from the right panel.
1.5 Configure a StormRunner Load Generator
StormRunner Load has created a UI configuration tool for Windows which can help you configure and connect the agent to StormRunner Load. Follow the steps below to configure a StormRunner load generator.
- Open the Configure SRL Generator.exe
General Tab: This tab includes general configuration related to StormRunner Load such as:
-Key: The key is a string generated by StormRunner Load (either manually or automatically) which is used to identify the agent. Refer to the section “Generate the LG key” to learn about generating a key manually.
-User name: Configure the email address you use to connect to StormRunner Load in the browser.
-Password: Configure your password which you use to connect StormRunner Load in the browser. Password encryption has been enabled by default.
-Tenant: Configure the tenant Id which is listed in the StormRunner Load URL. For example https://stormrunner-load.saas.hpe.com/home/?TENANTID=123456789 ‘123456789’ is the tenant Id in the above URL.
Miscellaneous (Misc) Tab: This tab includes configuration related to the proxy, log Level and interval.
-Proxy: Configure the proxy, if your network requires a proxy to access the public network. If required, the proxy credentials can be configured by clicking Advanced.
-Server: Do not change the Server URL. It should remain as displayed.
-Log Level: Select the appropriate log level from the drop-down list. We recommend using the debug level, which generates additional logs if issues are encountered.
-Interval (ms): Configure the interval (in milliseconds) to send a status request to the StormRunner Load server.
Environment Tab: This tab displays the version number of installed components, which are used by the StormRunner Load installer.
-Load Generator Version, MDRV Version, and Storm Extension: These components are installed by the StormRunner Load installer and set relevant environment variables in the system environment.
-Java Environment and JDK Version: Java is an optional component that is required if you want to run a script that uses java processes. The configuration tool fetches JDK versions from the environment variables.
Update Tab: This tab displays the version of the installed LG.
-Check for update: This link will check if the installed version is the latest version or not. The download link is displayed if the installed version is not the latest.
Options tab: This tab enables the user to enable/disable
For Example: The SRL_AGENT_KEEP_VUSER_LOGS parameter is used to retain script logs after the test has ended. By default, script logs are not retained. Script logs are stored in the %TEMP% folder and start with inj_o_xx.
2. Click Save & Test to make sure that the configuration data is saved and a connection is successfully established.
1.6 Start a StormRunner Load Generator Agent
- Run the Start SRL Generator.exe file to start the StormRunner load generator. The LG starts and communicates with StormRunner Load.
- Navigate to Assets > Load Generators and ensure that the configured LG status changes from Not connected to Connected. The LG can have the following status:
-Connected: The LG started and connected to StormRunner Load successfully.
-Not Connected: The LG has been created, but not started.
-Running: The LG is running a load test.
2. StormRunner Load Generator on Linux OS
A StormRunner Load Generator can also be installed on Linux by a Docker container. This section describes the procedure for installing a StormRunner Load Generator on Linux OS. StormRunner Load has both a full and a light version of an on-premises Docker deployment. Images are available on the Docker Hub.
2.1 Install a StormRunner Load Generator
Note: The Docker client (engine) must be installed on each host machine prior to installing the StormRunner Load Docker container. Refer to the Docker official website for more info.
- Select a StormRunner on-premises Docker version.
-Full version supports more protocols than the Lite version. See the table below.
-Lite version supports less protocols than the full version and it is also smaller than the full version.
- Run the docker pull command to pull the latest StormRunner Load on-premises Docker image. Refer to Docker Hub for more details.
- Run the docker images command to ensure that the image was successfully pulled.
If the image has downloaded successfully, you will see something similar to the following:
2.2 Uninstall a StormRunner Load Generator
- Log in to the StormRunner Load Generator machine and run the docker ps -a command to list all the containers. You will see a response similar to the one below:
- Run the docker stop command to stop a container when the status is Up.
- Run the docker rm command to remove the container related to the StormRunner load generator.
- Run the docker rmi command to remove the downloaded StormRunner load generator image.
2.3 Update a StormRunner Load Generator
Pull the latest Docker images to update a StormRunner load generator.
2.4 Configure and Start a StormRunner Load Generator
There are two ways to configure an LG—Auto and Manual. We recommend using auto configuration. Let’s learn about auto configuration (refer to The StormRunner Load Help Center for details on manual configuration).
StormRunner Load requires you to specify env variables in the docker run command (the docker run command is used to create a container). You can use -e or --env-file options in the docker run command to pass environment variables.
- Configure a container.
-Create a container:-Create a container with proxy:-Create a container with scripts log retained: -Create a container (with --env-file option):
Create a file called srl (you can use any file name) and add the following content to it (changing values as needed)
HTTP_PROXY=<define your proxy">
HTTPS_PROXY =<define your proxy">
2. Validate the newly created LG in the StormRunner Load UI and ensure that the status is Connected.
Note: View test logs in a Linux StormRunner load generator.
-View logs in a running Docker container.
-View logs in the local file system.
Run an On-premises test with StormRunner Load
Running an on-premises test in StormRunner is quite easy and is similar to running a cloud test. Make sure you understand the on-premises limitations prior to running an on-premises test. Let’s start a test with an on-premises location.
- Navigate to the Load Tests page and click Create to create a test.
- Select the Scripts tab, upload a script and select On-Premise from the LOCATION column.
Select the Distribution > On Premise tab and click + Add from Assets to add a connected StormRunner load generator.
Click Run Test to run the test!
Thank you for your time and interest in StormRunner Load.