Skip to content
This repository has been archived by the owner on Mar 22, 2022. It is now read-only.

Commit

Permalink
fixed README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Luca Barzè committed Feb 10, 2017
1 parent 321e3e5 commit eea0617
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Gatling-Kafka

An unofficial [Gatling](http://gatling.io/) 2.1 stress test plugin
for [Apache Kafka](http://kafka.apache.org/) 0.8 protocol.
An unofficial [Gatling](http://gatling.io/) 2.2 stress test plugin
for [Apache Kafka](http://kafka.apache.org/) 0.10 protocol.

This plugin supports the Kafka producer API only
and doesn't support the Kafka consumer API.
Expand All @@ -24,7 +24,7 @@ If you want to change the version of Gatling used to create a jar file,
change the following line in [`build.sbt`](build.sbt):

```scala
"io.gatling" % "gatling-core" % "2.1.3" % "provided",
"io.gatling" % "gatling-core" % "2.2.3" % "provided",
```

and run `sbt assembly`.
Expand All @@ -33,34 +33,34 @@ If you don't want to include kafka-clients library to the jar file,
change a line on kafka-clients in [`build.sbt`](build.sbt) from

```scala
("org.apache.kafka" % "kafka-clients" % "0.8.2.0")
("org.apache.kafka" % "kafka-clients" % "0.10.1.1")
```

to

```scala
("org.apache.kafka" % "kafka-clients" % "0.8.2.0" % "provided")
("org.apache.kafka" % "kafka-clients" % "0.10.1.1" % "provided")
```

and run `sbt assembly`.

Note that Apache Kafka 0.8.1.1 or below doesn't contain kafka-clients library.
Note that Apache Kafka 0.10.1.1 or below doesn't contain kafka-clients library.

### Putting the jar file to lib directory

Put the jar file to `lib` directory in Gatling:

$ cp target/scala-2.11/gatling-kafka-assembly-*.jar /path/to/gatling-charts-highcharts-bundle-2.1.*/lib
$ cp target/scala-2.11/gatling-kafka-assembly-*.jar /path/to/gatling-charts-highcharts-bundle-2.2.*/lib

If you edited `build.sbt` in order not to include kafka-clients library
to the jar file, you also need to copy kafka-clients library to `lib` directory:

$ cp /path/to/kafka-clients-*.jar /path/to/gatling-charts-highcharts-bundle-2.1.*/lib
$ cp /path/to/kafka-clients-*.jar /path/to/gatling-charts-highcharts-bundle-2.2.*/lib


### Creating a simulation file

$ cd /path/to/gatling-charts-highcharts-bundle-2.1.*
$ cd /path/to/gatling-charts-highcharts-bundle-2.2.*
$ vi user-files/simulations/KafkaSimulation.scala

You can find sample simulation files in the [test directory](src/test/scala/com/github/mnogu/gatling/kafka/test).
Expand Down

0 comments on commit eea0617

Please sign in to comment.