Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Tinkoff/gatling-kafka-plugin
Plugin for support Kafka in Gatling
https://github.com/Tinkoff/gatling-kafka-plugin
gatling kafka performance
Last synced: about 1 month ago
JSON representation
Plugin for support Kafka in Gatling
- Host: GitHub
- URL: https://github.com/Tinkoff/gatling-kafka-plugin
- Owner: Tinkoff
- License: apache-2.0
- Archived: true
- Created: 2019-06-20T13:49:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-07T22:01:30.000Z (over 1 year ago)
- Last Synced: 2024-01-26T05:13:33.911Z (11 months ago)
- Topics: gatling, kafka, performance
- Language: Scala
- Size: 146 KB
- Stars: 60
- Watchers: 5
- Forks: 24
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gatling - gatling-kafka-plugin - Plugin for support Kafka in Gatling. (Tools / Plugins)
README
# Gatling Kafka Plugin
 [](https://search.maven.org/search?q=ru.tinkoff.gatling-kafka) [](https://scala-steward.org)
[](https://codecov.io/github/Tinkoff/gatling-kafka-plugin?branch=master)
# Introduction
Plugin to support Kafka in Gatling (3.9.x)
# Usage
### Getting Started
Plugin is currently available for Scala 2.13, Java 17, Kotlin.
You may include plugin as dependency in project with your tests. Write
### Scala
```scala
libraryDependencies += "ru.tinkoff" %% "gatling-kafka-plugin" % % Test
```
### Java
Write this to your dependencies block in build.gradle:
```java
gatling "ru.tinkoff:gatling-kafka-plugin_2.13:"
```
### Kotlin
Write this to your dependencies block in build.gradle:
```kotlin
gatling("ru.tinkoff:gatling-kafka-plugin_2.13:")
```
## Example Scenarios
### Scala
Examples [here](src/test/scala/ru/tinkoff/gatling/kafka/examples)
### Java
Examples [here](src/test/java/ru/tinkoff/gatling/kafka/javaapi/examples)
### Kotlin
Examples [here](src/test/kotlin/ru/tinkoff/gatling/kafka/javaapi/examples)
## Download and create Avro schema
Avro schema is downloaded using the plugin [sbt-schema-registry-plugin](https://github.com/Tinkoff/sbt-schema-registry-plugin)
and for that you need to configure schemas and url in `build.sbt` and run the command:
```bash
sbt schemaRegistryDownload
```
To create java classes you should add use capabilities, that provide plugin [sbt-avro](https://github.com/sbt/sbt-avro).
This plugin is included in project and will do all needed for creating java classes in compile stage.
To run you should create scala object in root project directory and type `sbt run`.
### Example download avro-schema
Example [here](https://github.com/TinkoffCreditSystems/gatling-kafka-plugin/tree/master/src/test/scala/ru/tinkoff/gatling/kafka/examples)
## Avro support in Request-Reply
### Scala
To use avro messages as payload in key or value, you must:
- define implicit for schema registry url:
```scala
implicit val schemaRegUrl: String = "http://localhost:9094"
```
- or define serde for your class:
```scala
val ser =
new KafkaAvroSerializer(
new CachedSchemaRegistryClient("schRegUrl".split(',').toList.asJava, 16),
)
val de =
new KafkaAvroDeserializer(
new CachedSchemaRegistryClient("schRegUrl".split(',').toList.asJava, 16),
)
implicit val serdeClass: Serde[MyAvroClass] = new Serde[MyAvroClass] {
override def serializer(): Serializer[MyAvroClass] = ser.asInstanceOf[Serializer[MyAvroClass]]
override def deserializer(): Deserializer[MyAvroClass] = de.asInstanceOf[Deserializer[MyAvroClass]]
}
```
### Java
To use avro messages as payload in key or value, you must define serde for your class:
```java
public static Serializer ser = (Serializer) new KafkaAvroSerializer(new CachedSchemaRegistryClient(Arrays.asList("schRegUrl".split(",")), 16));
public static Deserializer de = (Deserializer) new KafkaAvroDeserializer(new CachedSchemaRegistryClient(Arrays.asList("schRegUrl".split(",")), 16));
```
### Kotlin
To use avro messages as payload in key or value, you must define serde for your class:
```kotlin
val ser = KafkaAvroSerializer(CachedSchemaRegistryClient("schRegUrl".split(','), 16),) as Serializer
val de = KafkaAvroDeserializer(CachedSchemaRegistryClient("schRegUrl".split(','), 16),) as Deserializer
```
### Example usage Avro in Request-Reply
Example [scala](src/test/scala/ru/tinkoff/gatling/kafka/examples/AvroClassWithRequestReplySimulation.scala)
Example [java](src/test/java/ru/tinkoff/gatling/kafka/javaapi/examples/AvroClassWithRequestReplySimulation.java)
Example [kotlin](src/test/kotlin/ru/tinkoff/gatling/kafka/javaapi/examples/AvroClassWithRequestReplySimulation.kt)