Close menu
Open menu

JMeter Manager

BETA - This Manager is almost ready. It has been tested and the TPI is stable, but there may be minor changes to come.


This Manager enables a JMeter session to run inside a Docker Container. The JMeter Manager requests a container from the Docker Manager inside which the JMeter scripts, or JMX files can run. The test can access all JMeter-generated files inside the container without worrying about how the container is provisioned, maintained or shut down at the end of test. By using a containerized environment, the test can benefit from the associated standards of scalability and uniformity.

The logfiles and generated CSV files can be accessed once the JMeter tests are complete and the container becomes available for interaction. The JMeter Manager allows as many JMeter sessions as you have available Docker container slots on your machine.


JMeter tests cannot be run remotely on a target host.

You can view the Javadoc documentation for the Manager here.

Code snippets

Use the following code snippets to help you get started with the JMeter Manager.

Creating a JMeter session

The following snippet shows the minimum code that is required to request a JMeter session in a Galasa test:

public IJMeterSession session;

This code requests the Docker Manager to provision a container with all the JMeter binaries that are required to run a JMX test installed. You can provision your JMX file via the Artifact Manager and point it to the bundle resources, the location of which is specified in the input stream of your JMX file. The container is discarded when the test finishes.

The following snippet enables you to add a personal properties file to the test by pointing the Artifact Manager at the JMeter properties file.

@JMeterSession(jmxPath="test.jmx", propPath="")
public IJMeterSession session;

There is no limit in Galasa on the number of JMeter sessions that can be used within a single test. The only limit is the number of containers that can be started in the Galasa Ecosystem. This limit is set by the Galasa Administrator and is typically set to the maximum number of containers that can be supported by the Docker Server or Swarm. If there are not enough slots available for an automated run, the run is put back on the queue in waiting state to retry. Local test runs fail if there are not enough container slots available.

Setting a JMX file in a JMeter session by using the Artifact Manager

Use the following code to provision a JMX file by using the Artifact Manager.

    IBundleResources bundleResources = artifactManager.getBundleResources(getClass());
    InputStream jmxStream = bundleResources.retrieveFile("/test.jmx");
Setting the properties file in a JMeter session by using the Artifact Manager

Just as you would provision a JMX file via the Artifact Manager, you can use the following code to provision a personalized properties file that gets used by JMeter at runtime.

    IBundleResources bundleResources = artifactManager.getBundleResources(getClass());
    InputStream propStream = bundleResources.retrieveFile("/");
Starting a JMeter session

You can set a timeout for a JMeter session or use the default timeout of 60 seconds for a JMeter session. To use this command, you must configure the JMX file correctly by using the session.setJmxFile(inputStream) method. Timeout is in milli-seconds.

Obtaining the JMX file from the JMeter-execution as a String

Use the following snippet to access the JMX file that was used in the JMeter session.

Obtaining the log file from the JMeter execution as a String

Use the following snippet to access the log file that is created when the JMX file that is running inside the container finishes running.

Viewing the console output as a String

Use the following snippet to view any console output that is generated by the JMeter test run. Typically, there is no console output unless the JMX file itself is corrupt or written incorrectly. If a correctly written JMX file generates errors during execution, the errors are held in the log files or in the JTL file.

Obtaining a generated file from the JMeter-execution as a String

Use the following snippet to help you to access any file that is created after execution of a JMX file inside a container completes. In this example, the JTL file test.jtl is returned as a String containing the results of the test run which can be exported to a CSV file. The name of the JTL file has the same prefix as the JMX file.

Checking your test ran correctly

Use the following code to check that the test ran correctly. You can use the logs and JMX files for further investigation. If the JMX file has completed its function successfully, a boolean value of true is returned, otherwise a value of false is returned.

Stopping the JMeter test

Use the following code to stop the JMeter test that is running inside the Docker container.