Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gguridi/benchmark-kafka-go-clients
Benchmark to test different kafka go clients to compare them under the same conditions.
https://github.com/gguridi/benchmark-kafka-go-clients
benchmark kafka kafka-clients
Last synced: 24 days ago
JSON representation
Benchmark to test different kafka go clients to compare them under the same conditions.
- Host: GitHub
- URL: https://github.com/gguridi/benchmark-kafka-go-clients
- Owner: gguridi
- License: mit
- Created: 2020-09-17T16:57:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-04T00:24:27.000Z (over 3 years ago)
- Last Synced: 2024-06-20T22:35:01.947Z (6 months ago)
- Topics: benchmark, kafka, kafka-clients
- Language: Go
- Homepage:
- Size: 1.05 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Benchmark of Kafka Go Clients
Benchmark to test different kafka go clients to compare them under the same conditions.
This started as a proof of concept of creating some benchmarks that could run directly
on github actions, publishing the results in a dashboard associated with the same repository.
This benchmark has been greatly inspired by Matt Howlett's [benchmark](https://gist.github.com/mhowlett/e9491aad29817aeda6003c3404874b35). I shamelessly used what it has instead of reading the documentation of the different clients :S.
## Clients
The clients tested in this benchmark are:
- [Confluent-kafka-Go](github.com/confluentinc/confluent-kafka-go)
- [Sarama](github.com/Shopify/sarama)
- [KafkaGo](github.com/segmentio/kafka-go)
## Setup
In order to run the benchmarks we need the following cli tools installed:
- [Ginkgo](https://github.com/onsi/ginkgo).
## Running
In order to run the benchmark tests we need a working kafka image. In this benchmark I've used
docker-based Kafka instances but it's possible to use any kafka.
To run the benchmarks we use the following syntax:
```bash
ginkgo -focus=${type} ./... -- -test.bench=. -library=${client} -num=${num-messages} -size=${size-messages} -brokers=${brokers} -topic=${topic}
```
### Type
It can be one of the following:
- *producer*: To test the client producers against the kafka brokers selected.
- *consumer*: To test the client consumers against the kafka brokers selected.
- *lag*: To perform a lag check agains a topic to see if the producer sent all the messages as expected.
The syntax of the lag is slightly different to the other two types.
```bash
ginkgo -focus=lag ./... -- -test.bench=. -num=${num-messages} -brokers=${brokers} -topic=${topic}
```
Where `num-messages` is the number of messages we would expect to find in that topic.
### Client
It can be one of the following:
- *confluent*: (producer only). To test the Confluent-kafka-Go producer.
- *confluent-poll*: (consumer only). To test the Confluent-kafka-Go polling-based consumer.
- *confluent-channel*: (consumer only). To test the Confluent-kafka-Go channel-based (and deprecated) consumer.
- *sarama*: To test the Sarama producer/consumer.
- *kafkago*: To test the KafkaGo producer/consumer.
### Num-Messages
It's an integer specifying the number of messages to produce/consume for the benchmark.
### Size-Messages
It's an integer specifying the size of messages to use for the benchmark. In case of the
consumers the Kafka instance will be prepopulated with messages of this size to be consumed.
### Brokers
Location of the kafka brokers to use for this benchmark. It includes the port. For instance `localhost:9092`.
### Topic
The topic as string to use for this benchmark.
## Output
The output of the benchmarks is automatically display in the dashboard. The results
are downloaded from the github actions, where are stored as artifacts, and used
as sources when building the results dashboard.
- https://gguridi.github.io/benchmark-kafka-go-clients/
If a client doesn't appear in the graph is because the time used in the benchmark is so much
higher than I didn't consider it necessary to perform further tests of it.
## Thanks
Special thanks to the components that I used for this:
- Matt Howlett's [Benchmark](https://gist.github.com/mhowlett/e9491aad29817aeda6003c3404874b35)
- Creative Tim [Vue Material Dashboard](https://www.creative-tim.com/product/vue-material-dashboard)