hub / github.com/IBM/sarama
github.com/IBM/sarama
Chat with this repo
4,374 symbols
22,212 edges
348 files
⚖ MIT
907 documented · 21%
● updated 2d agov1.61.1 · 2026-09-27★ 12,52315 open issues
Browse by type
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
sarama
Sarama is an MIT-licensed Go client library for Apache Kafka.
Getting started
- API documentation and examples are available via pkg.go.dev.
- 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. However, older releases of Kafka are still likely to work.
Sarama follows semantic versioning and provides API stability via the standard Go module version numbering scheme.
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!
Extension points exported contracts — how you extend this code
Partitioner (Interface)
Partitioner is anything that, given a Kafka message and a number of partitions indexed [0...numPartitions-1], decides to [6 …
partitioner.go
ConsumerGroupHandler (Interface)
-------------------------------------------------------------------- ConsumerGroupHandler instances are used to handle i [14 …
consumer_group_session.go
MockResponse (Interface)
MockResponse is a response builder interface it defines one method that allows generating a response based on a request [51 …
mockresponses.go
BalanceStrategy (Interface)
-------------------------------------------------------------------- BalanceStrategy is used to balance topics and parti [4 …
balance_strategy.go
RebalanceProtocolBalanceStrategy (Interface)
RebalanceProtocolBalanceStrategy is an optional extension of BalanceStrategy that declares which rebalance protocols the [3 …
rebalance_protocol.go
Consumer (Interface)
Consumer manages PartitionConsumers which process Kafka messages from brokers. You MUST call Close() on a consumer to av [2 …
consumer.go
browse all types & interfaces →
Core symbols most depended-on inside this repo
↓ 113 filesdecoder
decoder is the interface that wraps the basic Decode method. Anything implementing Decoder can be extracted from bytes using …
encoder_decoder.go
↓ 110 filespacketDecoderPacketDecoder is the interface providing helpers for reading with Kafka's encoding rules. Types implementing Decoder only need to …
packet_decoder.go
↓ 110 filesencoderEncoder is the interface that wraps the basic Encode method. Anything implementing Encoder can be turned into bytes using Kafka's …
encoder_decoder.go
↓ 108 filespacketEncoderPacketEncoder is the interface providing helpers for writing with Kafka's encoding rules. Types implementing Encoder only need to …
packet_encoder.go
↓ 90 filesTestReporterTestReporter has methods matching go's testing.T to avoid importing `testing` in the main part of the library.
mockresponses.go
↓ 111 filesversionedDecoderencoder_decoder.go
Shape
Languages
Go100%
Modules by API surface
mockresponses.go202 symbols
broker.go116 symbols
async_producer_test.go98 symbols
async_producer.go97 symbols
admin.go96 symbols
consumer.go83 symbols
client.go83 symbols
balance_strategy.go70 symbols
admin_test.go66 symbols
consumer_test.go51 symbols
consumer_group_cooperative_test.go50 symbols
balance_strategy_test.go50 symbols
Dependencies from manifests, versioned
github.com/IBM/saramav1.60.2 · 1×
github.com/cespare/xxhash/v2v2.3.0 · 1×
github.com/davecgh/go-spewv1.1.1 · 1×
github.com/eapache/go-resiliencyv1.7.0 · 1×
github.com/go-logr/logrv1.4.4 · 1×
github.com/go-logr/stdrv1.2.2 · 1×
github.com/google/uuidv1.6.0 · 1×
github.com/hashicorp/go-uuidv1.0.3 · 1×
github.com/jcmturner/aescts/v2v2.0.0 · 1×
github.com/jcmturner/dnsutils/v2v2.0.0 · 1×
github.com/jcmturner/goforkv1.7.6 · 1×
github.com/jcmturner/gokrb5/v8v8.4.4 · 1×
For agents
$ claude mcp add sarama \
-- python -m otcore.mcp_server <graph>