ActiveMQ Classic Performance Module Users Manual

Features > Performance > ActiveMQ Classic Performance Module Users Manual

Running Maven 2 Performance Test

This Maven 2 plugin allows you to run performance tests easily using the Maven command line or run tests automatically in Continuum

Prerequisites

Starting with ActiveMQ Classic 5.5 and above the plugin can be obtained from maven or if you download the src from GIT you can build it yourself. Start with a complete build of Apache ActiveMQ Classic and then do

cd activemq-tooling
mvn clean install

To run the following Maven goals make sure you are inside a Maven2 project directory where its POM is enabled with the Maven2 plugin.

Getting started

To get started, switch to the activemq-perftest directory from the sandbox repo, or to a directory containing your own Maven POM with the following plugin defined:

<plugin>
  <groupId>org.apache.activemq.tooling</groupId>
  <artifactId>activemq-perf-maven-plugin</artifactId>
  <version>${activemq-version}</version>
</plugin>

In ActiveMQ Classic versions prior to 5.8, the artifactId was maven-activemq-perf-plugin.

Type the following commands into separate shells (the broker line here is optional if you have a preconfigured one running):

mvn activemq-perf:broker -Durl=broker:tcp://localhost:61616
mvn activemq-perf:consumer
mvn activemq-perf:producer

If you run the broker on a different machine then change the producer and consumer commands to

mvn activemq-perf:consumer -Dfactory.brokerURL=tcp://host:port
mvn activemq-perf:producer -Dfactory.brokerURL=tcp://host:port

where you switch host:port with the actual values.

When you run the producer & consumer, it generates an XML performance report in the current directory, so that you can graph and chart the results etc. See the sample report

Maven goals

Note:The parameters for both consumer and producers are described in the next section. (sample report)

Configuration for running a system of JMS Clients (Producer/Consumer)

Note: If the number of destinations is less than the number of clients and the distribution type is either ‘equal’ or ‘divide’, each client will send/receive from only one destination, distributing the destinations among the clients. i.e. if there are 5 producers and 2 destinations, 3 producers will send to destination 1, and 2 producers will send to destination 2. Also, a consumer can only receive from a single destination, unless composite destination is supported and specified.

Configuration for running a JMS Producer

Configuration for running a JMS Consumer

Note: If you have more than one consumer receiving from multiple destinations, it is a good idea to change the sysTest.destDistro to ‘equal’, since by default it uses ‘all’ and a consumer can only receive from a single destination, hence all consumers will receive from the first destination in the list only.

Configuration for SPI Connection Factory: org.apache.activemq.tool.spi.ActiveMQPojoSPI

Description: This provides details in configuring the JMS Connection Factory created by ActiveMQPojoSPI. Default values are based from the default values of the service provider org.apache.activemq.ActiveMQConnectionFactory.

Configuration for SPI Connection Factory: org.apache.activemq.tool.spi.ActiveMQClassLoaderSPI

Description: This provides details in configuring the JMS Connection Factory created by ActiveMQClassLoaderSPI. Default values are based from the default values of the service provider org.apache.activemq.ActiveMQConnectionFactory.

ActiveMQClassLoaderSPI loads from the classpath org.apache.activemq.ActiveMQConnectionFactory and configures it using reflection. Configuration is generally based on the API of the class loaded. General format is factory.YYY or factory.XXX.YYY, where the last variable (YYY) is the property to set and everything in between is the getter of the class to use to set (YYY). For example:

1. To set the value for asyncSend in ActiveMQConnectionFactory, use:

   factory.useAsyncSend=true
   

   which is equivalent to calling

   factory.setUseAsyncSend(true)
   

2. To set the queue prefetch for ActiveMQConnectionFactory, use:

   factory.prefetchPolicy.queuePrefetch=1
   

   which is equivalent to calling

   factory.getPrefetchPolicy().setQueuePrefetch(1)
   

It should be noted that the loaded class should implement the appropriate getter and setter methods. Nested objects should also be properly instantiated. For more information on configuring this SPI, refer to the specific provider API manual.

As of ActiveMQ Classic 4.0.1, these are the available fields and default values:

Configuration for samplers

There are two samplers built into the perfomance test tool. Both are configured with the same configuration keys, only prefixed with different sampler names.

For example, it is possible to configure the two samplers differently for a single test run, using the prefixes above as follows:

mvn activemq-perf:producer -DtpSampler.duration=10000 -DcpuSampler.duration=15000

By default, both samplers are used within a test run. This however, can be overridden through the use of the sysTest.samplers property.

Before ActiveMQ Classic 5.11

Sampler configurations are not tied in to the test run, so it is possible for the sampler to run for longer than the actual test itself. For short run durations, the sampler may not even have ramped up before the test completes.

From ActiveMQ Classic 5.11

Sampler run duration is tied directly to the behavior of the client (producer/consumer). Due to the non-deterministic nature of count-based tests (where consumer.recvType or producer.sendType are set to count), duration, ramp up and ramp down times are ignored; the samplers are shut down when the client completes.

The time taken to ramp up and ramp down, whether defined through milliseconds or as a percentage cannot exceed the total duration.