Home

Regular user documentation is provided via go.dev: https://pkg.go.dev/github.com/IBM/sarama

This wiki holds more architecture and developer-oriented information.

Contribution Guidelines

Sarama is built with any version of go after 1.17, 1.17 is the language syntax version that go follows, this means that you can use Sarama with any go version after and including go 1.17.

Pull Requests are welcomed on both the code base and documentation, please raise issues for any bugs found.

GitHub Actions

Automated testing is done through GitHub Actions which will run a suite of unittests, functional tests and linting steps. You can run these locally with make (run make install_dependencies to install the necessary tools).

Functional Tests

Sarama includes functional tests that run against a test cluster with a specific topic configuration. A docker-compose file is included to make it easy to set up a Kafka cluster with 5 brokers and the necessary topics inside a virtual machine. This will be started via Go as part of the the running of the functional tests.