Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rahulsinghai/jmeter-backend-listener-kafka
A JMeter plug-in that enables you to send test results to a Kafka server
https://github.com/rahulsinghai/jmeter-backend-listener-kafka
backend-listener cd ci continuous-delivery continuous-integration elasticsearch java jmeter jmeter-plugin jmeter-plugins kafka kibana logstash performance performance-analysis performance-testing plugin reporting
Last synced: 2 months ago
JSON representation
A JMeter plug-in that enables you to send test results to a Kafka server
- Host: GitHub
- URL: https://github.com/rahulsinghai/jmeter-backend-listener-kafka
- Owner: rahulsinghai
- License: apache-2.0
- Created: 2019-06-24T14:47:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-20T21:01:24.000Z (over 2 years ago)
- Last Synced: 2024-01-24T07:09:35.615Z (12 months ago)
- Topics: backend-listener, cd, ci, continuous-delivery, continuous-integration, elasticsearch, java, jmeter, jmeter-plugin, jmeter-plugins, kafka, kibana, logstash, performance, performance-analysis, performance-testing, plugin, reporting
- Language: Java
- Size: 334 KB
- Stars: 25
- Watchers: 2
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jmeter - jmeter-backend-listener-kafka - JMeter plugin to send test results to a Kafka server. (Results Processing / Reporting & Visualization)
README
# jmeter-backend-listener-kafka
[](https://app.codacy.com/app/rahulsinghai/jmeter-backend-listener-kafka?utm_source=github.com&utm_medium=referral&utm_content=rahulsinghai/jmeter-backend-listener-kafka&utm_campaign=Badge_Grade_Dashboard)
[](https://codecov.io/gh/rahulsinghai/jmeter-backend-listener-kafka)
[](https://travis-ci.org/rahulsinghai/jmeter-backend-listener-kafka)
A JMeter plug-in that enables you to send test results to a Kafka server.
## Overview
### Description
JMeter Backend Listener Kafka is a JMeter plugin enabling you to send test results to a Kafka server.
It is inspired from JMeter [ElasticSearch](https://github.com/delirius325/jmeter-elasticsearch-backend-listener) backend listener plug-in.
### Features
- Filters
- Only send the samples you want, by using Filters! Simply type them as follows in the appropriate field: `filter1;filter2;filter3` or `sampleLabel_must_contain_this`.
- Specific fields `field1;field2;field3`
- Specify fields that you want to send to Kafka (possible fields below):
- AllThreads
- BodySize
- Bytes
- SentBytes
- ConnectTime
- ContentType
- DataType
- ErrorCount
- GrpThreads
- IdleTime
- Latency
- ResponseTime
- SampleCount
- SampleLabel
- ThreadName
- URL
- ResponseCode
- TestStartTime
- SampleStartTime
- SampleEndTime
- Timestamp
- InjectorHostname
- Verbose, semi-verbose, error only, and quiet mode:
- **debug** : Send request/response information of all samplers (headers, body, etc.)
- **info** : Sends all samplers to the Kafka server, but only sends the headers, body info for the failed samplers.
- **quiet** : Only sends the response time, bytes, and other metrics
- **error** : Only sends the failing samplers to the Kafka server (Along with their headers and body information).
- Use Logstash/NiFi or any other tool to consume data from Kafka topic and then ingest it into a Database of your liking.
### Maven dependency
```xml
io.github.rahulsinghai
jmeter.backendlistener.kafka
1.0.1
```
### Installing JMeter
- SSH to a Unix machine with X-11 Forwarding enabled, and then set DISPLAY variable:
```bash
export DISPLAY=Your_terminal_IP:0.0
```
- Download [JMeter](https://jmeter.apache.org/download_jmeter.cgi) binary and extract it:
```bash
mkdir -P /home/jmeter
cd /home/jmeter
curl -O -k http://mirror.vorboss.net/apache//jmeter/binaries/apache-jmeter-5.1.1.tgz
tar -zxvf apache-jmeter-5.1.1.tgz
ln -s apache-jmeter-5.1.1 ./current
export JMETER_HOME=/data/elastic/jmeter/current
```
- Download and install [Plugin Manager](https://jmeter-plugins.org/wiki/PluginsManager/) to `lib/ext` folder:
```bash
curl -O -k http://search.maven.org/remotecontent?filepath=kg/apc/jmeter-plugins-manager/1.3/jmeter-plugins-manager-1.3.jar
mv jmeter-plugins-manager-1.3.jar apache-jmeter-5.1.1/lib/ext/
```
Detailed instructions on installing Plug-ins Manager are available at this [blog](https://octoperf.com/blog/2018/04/04/jmeter-plugins-install/).
- Start JMeter:
```bash
cd $JMETER_HOME
JVM_ARGS="-Dhttps.proxyHost=myproxy.com -Dhttps.proxyPort=8080 -Dhttp.proxyUser=user -Dhttp.proxyPass=***" ./bin/jmeter.sh
```
### Packaging and testing your newly added code
- Build the artefact: Execute below mvn command. Make sure JAVA_HOME is set properly
```bash
mvn clean package
```
- Move the resulting JAR to your `JMETER_HOME/lib/ext`.
```bash
mv target/jmeter.backendlistener.kafka-1.0.0-SNAPSHOT.jar $JMETER_HOME/lib/ext/
```
- Restart JMeter
- Go to Options > Plugins Manager
- You will find Kafka Backend listener plug-in mentioned in the Installed plug-ins tab.
### Configuring jmeter-backend-listener-kafka plug-in
- In your **Test Pan**, right click on **Thread Group** > Add > Listener > Backend Listener
- Choose `io.github.rahulsinghai.jmeter.backendlistener.kafka.KafkaBackendClient` as `Backend Listener Implementation`.
- Specify parameters as shown in image below (**bootstrap.servers** and **kafka.topic** are mandatory ones):
### Running your JMeter test plan
You can run the test plan in GUI mode or in CLI mode using command like below:
```bash
bin/jmeter -H [HTTP proxy server] -P [HTTP proxy port] -N "localhost|127.0.0.1|*.singhaiuklimited.com" -n -t test_kafkaserver.jmx -l test_kafkaserver_result.jtl
```
## Screenshots
### Sample Grafana dashboard
### For more info
For more information, here's a little [documentation](https://github.com/rahulsinghai/jmeter-backend-listener-kafka/wiki).
## Contributing
Feel free to contribute by branching and making pull requests, or simply by suggesting ideas through the "Issues" tab.
### Code Styling
- Please find instructions [here](https://github.com/HPI-Information-Systems/Metanome/wiki/Installing-the-google-styleguide-settings-in-intellij-and-eclipse) on how to configure your IntelliJ or Eclipse to format the source code according to Google style.
Once configured in IntelliJ, format code as normal with `Ctrl + Alt + L`.
Adding the XML file alone and auto-formatting the whole document could replace imports with wildcard imports, which isn't always what we want.
- To stop this from happening, Go to `File` → `Settings` → `Editor` → `Code Style` → `Java` and select the `Imports` tab.
- Set `Class Count to use import with '*'` and `Names count to us static import with '*'` to a higher value; anything over `999` should be fine.
You can now reformat code throughout your project without imports being changed to Wildcard imports.
- You also need to use `maven-git-code-format` plugin in `pom.xml` to auto format the code according to Google code style before any Git commit.
### [Markdown formatting](https://github.com/remarkjs/remark/tree/master/packages/remark-cli)
Use **remark-cli** to format markdown files.
It ensures a single style is used: list items use one type of bullet (_, -, +), emphasis (_ or \_) and importance (\_\_ or \*\*) use a standard marker, table fences are aligned, and more.
- Install `remark-cli` and `remark-preset-lint-recommended`
```bash
npm install remark-cli -g
npm install remark-preset-lint-recommended -g
# Add a table of contents to `README.md`
remark README.md --use toc --output
# Lint markdown files in the current directory
# according to the markdown style guide.
remark README.md --use remark-preset-lint-recommended -o
# Rewrite all applicable files
remark . -o
```