sarama

sarama

Sarama is an MIT-licensed Go client library for Apache Kafka version 0.8 (and later).

Getting started

• API documentation and examples are available via godoc.
• Mocks for testing are available in the mocks subpackage.
• The examples directory contains more elaborate example applications.
• The tools directory contains command line tools that can be useful for testing, diagnostics, and instrumentation.

You might also want to look at the Frequently Asked Questions.

Compatibility and API stability

Sarama provides a "2 releases + 2 months" compatibility guarantee: we support the two latest stable releases of Kafka and Go, and we provide a two month grace period for older releases. This means we currently officially support Go 1.8 through 1.10, and Kafka 0.11 through 1.1, although older releases are still likely to work.

Sarama follows semantic versioning and provides API stability via the gopkg.in service. You can import a version with a guaranteed stable API via http://gopkg.in/Shopify/sarama.v1. A changelog is available here.

Contributing

• Get started by checking our contribution guidelines.
• Read the Sarama wiki for more technical and design details.
• The Kafka Protocol Specification contains a wealth of useful information.
• For more general issues, there is a google group for Kafka client developers.
• If you have any questions, just ask!