The container can be deployed into Docker Engine or OpenShift Container Platform. This provides a flexible JMeter container for load testing Kafka on container platform.
- Removed Promethues monitoring for JMeter. JMeter listener has negative impact on the JMeter performance especially obvious for Kafka client.
- Instead of Promethues, a summary of Kafka producer performance statistics is printed on the command prompt output. This provides sufficient and yet effective Kafka producer performance observation data.
- Enhancement on Kafka client implementation.
The following are the support parameters.
For some of the possible configurable values for Kafka settings listed below, please refer to Apache Kafka producer configuration.
| Parameters | Description | Default |
|---|---|---|
| JMETER_THREADS | Number of JMeter threads / users | 1 |
| BOOTSTRAP_SERVERS | Kafka bootstrap server (bootstrap.servers) | localhost:9092 |
| BATCH_SIZE | Kafka batch size (batch.size) | 16384 |
| LINGER_MS | Kafka Linger in ms (linger.ms) | 1 |
| BUFFER_MEMORY | Kafka Buffer memory (buffer.memory) | 33554432 |
| ACKS | Kafka acks | 1 |
| COMPRESSION_TYPE | Kafka Compression Type (compression.type) | none |
| SEND_BUFFER | Kafka send buffer (send.buffer.bytes) | 131072 |
| RECEIVE_BUFFER | Kafka receive buffer (receive.buffer.bytes) | 32768 |
| KAFKA_TOPIC | Kafka Topic | jmeter-test |
| RAMUP_PERIOD | JMeter ramp-up perriod in seconds | 2 |
| LOOP_COUNT | JMeter loop count | -1 |
| SAMPLER_LABEL | JMeter sampler label | Kafka JSR223 |
| KAFKA_MESSAGE | Kafka message | |
| THREADGROUP_SCHEDULER | JMeter thread group scheduler a.k.a Specify Thread Lifetime. | false |
| THREADGROUP_DURATION | JMeter thread group duration in seconds. Required when THREADGROUP_SCHEDULER is true | 0 |
| THREADGROUP_DELAY | JMeter thread group delay in seconds. Required when THREADGROUP_SCHEDULER is true. | 0 |
| THREADGROUP_SAME_USER_EACH_ITERATION | JMeter Same user on each iteration | false |
| THREADGROUP_DELAYSTART | JMeter Delay Thread creation until needed. | false |
| HEAP | JMeter JVM Heap size. Spaces are allowed. | -Xms512m -Xmx2048m |
| MAX_BLOCK_MS | Kafka max.block.ms | 60000 |
| DELIVERY_TIMEOUT_MS | Kafka delivery.timeout.ms | 120000 |
| RECORD_SIZE | Kafka message record size to generate (bytes) | 100 |
| NUMBER_RECORDS | Number of message to send | 100 |
| THROTTLE_RECORD_SIZE | Record size per second to throttle in MB | 0 |
| THROTTLE_MESSAGE_NUM | Number of message per second to throttle | 0 |
Run the container:
docker run -e "JMETER_THREADS=50" -e "BOOTSTRAP_SERVERS=192.168.0.117:9092" \
-e "PROMETHEUS_PORT=9270" -e "PROMETHEUS_HOST=0.0.0.0" \
-e "RAMUP_PERIOD=50" -e "LOOP_COUNT=-1" \
-it chengkuan/jmeter-kafka:latest -e "KAFKA_MESSAGE=This is my kafka message"
Please refer the supported parameters to customize the load test.
Run the following oc command to deploy the container into the OpenShift:
oc run jmeter-kafka -i --image=docker.io/chengkuan/jmeter-kafka:latest \
--rm=true --restart=Never \
--image-pull-policy='Always' \
--env "JMETER_THREADS=1" \
--env "BOOTSTRAP_SERVERS=kafka-cluster-kafka-bootstrap:9092" \
--env "RAMUP_PERIOD=1" \
--env "SAMPLER_LABEL=lt-p10r3" \
--env "LOOP_COUNT=-1" \
--env "KAFKA_TOPIC=lt-p10r3" \
--env "RECORD_SIZE=100" \
--env "NUMBER_RECORDS=50000000" \
--env "LINGER_MS=10" \
--env "BATCH_SIZE=32768" \
--env "THROTTLE_RECORD_SIZE=60" \
--env "ACKS=1"
Please refer the supported parameters to customize the load test.
There is a bash script included that you can use to quickly deploy and configure Red Hat AMQ Streams, Kafka Topic, Promethues and Grafana.
Clone this repo into your local directory and ensure that the Red Hat AMQ Streams Operator is installed and ready. Run the following command from the bin directory to deploy the environment.
./deploy.sh -i
Refer to This is How You Can Load Test Apache Kafka on OpenShift Container Platform Using Apache JMeter for more details.
- You cannot change the test plan included without rebuild the container.
- You can only load test one Kafka Topic at a time with one container. However you can run multiple container for more one Kafka topics with each container for different topic. By running the container on OpenShift, there is no need of JMeter server for huge load test, you can basically run multiple PODs to increase the load test.
- JMeter test plan used in this project. It is built into the container.
- Grafana dashboards for OpenShift platform.
- Sample Prometheus configuration yml file. This is used if you need to run the environment locally in your PC with Promethues container.
- Build the jar file required for JMeter
cd jmeter-kafka-plugin
mvn clean package
- Build the JMeter Container using Docker
docker build -t chengkuan/jmeter-kafka:1.0 .
or Build the JMeter Container using Podman
podman build -t chengkuan/jmeter-kafka:1.0 .
This section is meant for steps required to setup your own local development environment.
In order to do local development and test, you will need to have the following servers:
- Apache Kafka Servers
- Prometheus
- Grafana
This section assumes you have the Kafka servers installed.
Perform the following steps to configure the Kafka Broker and Zookeeper to expose metrics over the JMX Exporter.
-
Head to the Prometheus JMX Exporter GitHub and follow the link provided to download the jar file.
-
Download the sample JMX config file for Kafka from Prometheus JMX Exporter GitHub.
-
You need to configure JMX Exporter in Kafka Broker & Zookeeper startup scripts. You just have to add KAFKA_OPTS line in the startup scripts of all the zookeepers and brokers as follows:
export KAFKA_OPTS="-javaagent:$JMETER_HOME/prometheus/prometheus_agent/jmx_prometheus_javaagent-0.12.0.jar=7073:$JMETER_HOME/prometheus/prometheus_agent/kafka-2_0_0.yml"
Make sure you are using the correct paths.
Note: Please ensure the Kafka broker configuration is with the proper advertised listener so that the Kafka client inside the JMeter container can reply properly to broker. Usually this is not an issue if hostname is resolvable to public IP. But if you running this locally for testing, the default setting will be translated into
localhost:9092which will cause the Kafka client failed to connect back to Kafka broker when Kafka broker responses with the advertised listener. This can be changed in theconfig/server.properties.
advertised.listeners=PLAINTEXT://192.168.0.103:9092
Set environmental variable:
export JMETER_HOME=~/Downloads/apache-jmeter-5.4
export PROJ_HOME=~/git/jmeter-container
Run JMeter in CLI mode with the provided test plan.
$JMETER_HOME/bin/jmeter -n -p $PROJ_HOME/properties/jmeter.properties -t $PROJ_HOME/testplans/kafka-jmeter-testplan.jmx -l /tmp/kafka-jmeter-result.jtl
The easiet way to run Prometheus is using Docker:
docker run \
-p 9090:9090 \
-v ~/git/jmeter-container/templates/docker-prometheus.yml:/etc/prometheus/prometheus.yml \
prom/prometheus
Make sure the path to the
docker-prometheus.ymlis correct.
The following is the sample of prometheus.yml:
# my global config
global:
scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
# scrape_timeout is set to the global default (10s).
# Alertmanager configuration
alerting:
alertmanagers:
- static_configs:
- targets:
# - alertmanager:9093
# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
rule_files:
# - "first_rules.yml"
# - "second_rules.yml"
# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
- job_name: 'prometheus'
# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
static_configs:
- targets: ['localhost:9090']
- job_name: 'kafka'
# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
static_configs:
- targets: ['192.168.0.117:9308']
- job_name: 'zookeeper'
# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
static_configs:
- targets: ['192.168.0.117:9309']
You can use Grafana Docker container for local try out.
docker run -d --name=grafana -p 3000:3000 grafana/grafana
Import the following sample dashboards for JMeter and Kafka. Please refer List of Files for which files to import.
Strimzi Grafana Dashboard
- Apache JMeter v5.4.1
- UBI8 openjdk-11 container image from Red Hat.
- Kafka Client 2.7.0
- Kafka JMX Exporter for Prometheus 0.15.0
- Refer to This is How You Can Load Test Apache Kafka on OpenShift Container Platform Using Apache JMeter for detail explanation and steps.
- Kafka JMX Exporter for Prometheus
- JMeter Prometheus Plugin