https://github.com/cockroachdb/sarama

fork of https://github.com/Shopify/sarama
https://github.com/cockroachdb/sarama

Last synced: 5 months ago
JSON representation

fork of https://github.com/Shopify/sarama

• Host: GitHub
• URL: https://github.com/cockroachdb/sarama
• Owner: cockroachdb
• License: mit
• Created: 2023-06-27T14:04:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-27T14:07:08.000Z (over 2 years ago)
• Last Synced: 2025-08-09T12:00:00.808Z (5 months ago)
• Language: Go
• Homepage:
• Size: 9.74 MB
• Stars: 0
• Watchers: 60
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# sarama

[![Go Reference](https://pkg.go.dev/badge/github.com/Shopify/sarama.svg)](https://pkg.go.dev/github.com/Shopify/sarama)

[![Coverage](https://codecov.io/gh/Shopify/sarama/branch/main/graph/badge.svg)](https://codecov.io/gh/Shopify/sarama)

Sarama is an MIT-licensed Go client library for [Apache Kafka](https://kafka.apache.org/).

## Getting started

- API documentation and examples are available via [pkg.go.dev](https://pkg.go.dev/github.com/Shopify/sarama).

- Mocks for testing are available in the [mocks](./mocks) subpackage.

- The [examples](./examples) directory contains more elaborate example applications.

- The [tools](./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](https://github.com/Shopify/sarama/wiki/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. However, older releases of Kafka 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](CHANGELOG.md).

## Contributing

- Get started by checking our [contribution guidelines](https://github.com/Shopify/sarama/blob/main/.github/CONTRIBUTING.md).

- Read the [Sarama wiki](https://github.com/Shopify/sarama/wiki) for more technical and design details.

- The [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol) contains a wealth of useful information.

- For more general issues, there is [a google group](https://groups.google.com/forum/#!forum/kafka-clients) for Kafka client developers.

- If you have any questions, just ask!