Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aliesbelik committed Oct 29, 2021
1 parent 1680d83 commit 62c5363
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,60 @@ A [JMeter](http://jmeter.apache.org/) plugin to publish & consume messages from

## Installation

To install the plugin, build the project and copy the generated **jmeter-amqp-plugin-VERSION-jar-with-dependencies.jar** from `target/dist` to `$JMETER_HOME/lib/ext` directory, then restart JMeter GUI.
1. Download the [latest release](https://github.com/aliesbelik/jmeter-amqp-plugin/releases/latest) or [build your own](#build) from the source code.
2. Put `jmeter-amqp-plugin-VERSION-jar-with-dependencies.jar` into `$JMETER_HOME/lib/ext` directory.\
It contains the necessary AMQP client dependency, no other jars are required.
3. Restart JMeter GUI.

In case if you need the plugin without the AMQP client included, you can use the **jmeter-amqp-plugin-VERSION.jar**, but you have to ensure that the [RabbitMQ client library](https://www.rabbitmq.com/java-client.html) - **amqp-client-VERSION.jar** - is installed in `$JMETER_HOME/lib` directory.
In case if you need the plugin without the AMQP client included, you can use the `jmeter-amqp-plugin-VERSION.jar`,
but you have to ensure that the [RabbitMQ client library](https://www.rabbitmq.com/java-client.html) - `amqp-client-VERSION.jar` - is installed in `$JMETER_HOME/lib` directory.

## Usage

//TODO
This plugin includes 2 samplers:

- **AMQP Publisher**
- **AMQP Consumer**

![amqp-plugin-samplers](assets/images/amqp-plugin-samplers.png)

## Build

### Build requirements

In order to build JMeter AMQP plugin from source, you will need:

- [Java 8](https://www.oracle.com/downloads/)
- [Apache Maven 3](https://maven.apache.org/)

Build dependencies are managed by Maven.\
JARs should automatically be downloaded by Maven as part of the build process.

In addition, you'll need to copy or symlink the following from `$JMETER_HOME/lib/ext` directory:
* ApacheJMeter_core.jar

- ApacheJMeter_core.jar

### Build from source

The project is built using Maven.\
To execute the build script, just execute:
To build, just execute:

```
mvn clean package
```

This will create 2 jars in `/target` directory, the original jar and the jar with all the dependencies within (this is the one you need):

```
jmeter-amqp-plugin-VERSION.jar
jmeter-amqp-plugin-VERSION-jar-with-dependencies.jar
```

To install, execute:

```
cp target/jmeter-amqp-plugin-VERSION-jar-with-dependencies.jar $JMETER_HOME/lib/ext
```

## Contributing

Contributions are welcome.
Binary file added assets/images/amqp-plugin-samplers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 62c5363

Please sign in to comment.