New Features:
- TLS-encrypted network connections are now supported. This feature is subject to change when Kafka releases built-in TLS support, but for now this is enough to work with TLS-terminating proxies (#154).
Improvements:
- The consumer will not block if a single partition is not drained by the user; all other partitions will continue to consume normally (#485).
- Formatting of error strings has been much improved (#495).
Bug Fixes:
- Fix a potential deadlock in the consumer on shutdown (#475).
Bug Fixes:
- Don't include the partitioner in the producer's "fetch partitions" circuit-breaker (#466).
- Don't retry messages until the broker is closed when abandoning a broker in the producer (#468).
- Update the import path for snappy-go, it has moved again and the API has changed slightly (#486).
Bug Fixes:
- Update the import path for snappy-go, it has moved from google code to github (#456).
Improvements:
- Optimizations when decoding snappy messages, thanks to John Potocny (#446).
Bug Fixes:
New Features:
- The consumer now implements
Topics()
andPartitions()
methods to enable users to dynamically choose what topics/partitions to consume without instantiating a full client (#431). - The partition-consumer now exposes the high water mark offset value returned
by the broker via the
HighWaterMarkOffset()
method (#339). - Added a
kafka-console-consumer
tool capable of handling multiple partitions, and deprecated the now-obsoletekafka-console-partitionConsumer
(#439, #442).
Improvements:
- The producer's logging during retry scenarios is more consistent, more useful, and slightly less verbose (#429).
- The client now shuffles its initial list of seed brokers in order to prevent thundering herd on the first broker in the list (#441).
Bug Fixes:
- The producer now correctly manages its state if retries occur when it is shutting down, fixing several instances of confusing behaviour and at least one potential deadlock (#419).
- The consumer now handles messages for different partitions asynchronously, making it much more resilient to specific user code ordering (#325).
New Features:
- The client now tracks consumer group coordinators using
ConsumerMetadataRequests similar to how it tracks partition leadership using
regular MetadataRequests (#411).
This adds two methods to the client API:
Coordinator(consumerGroup string) (*Broker, error)
RefreshCoordinator(consumerGroup string) error
Improvements:
- ConsumerMetadataResponses now automatically create a Broker object out of the ID/address/port combination for the Coordinator; accessing the fields individually has been deprecated (#413).
- Much improved handling of
OffsetOutOfRange
errors in the consumer. Consumers will fail to start if the provided offset is out of range (#418) and they will automatically shut down if the offset falls out of range (#424). - Small performance improvement in encoding and decoding protocol messages (#427).
Bug Fixes:
- Fix a rare race condition in the client's background metadata refresher if it happens to be activated while the client is being closed (#422).
Improvements:
- The producer's behaviour when
Flush.Frequency
is set is now more intuitive (#389). - The producer is now somewhat more memory-efficient during and after retrying messages due to an improved queue implementation (#396).
- The consumer produces much more useful logging output when leadership changes (#385).
- The client's
GetOffset
method will now automatically refresh metadata and retry once in the event of stale information or similar (#394). - Broker connections now have support for using TCP keepalives (#407).
Bug Fixes:
- The OffsetCommitRequest message now correctly implements all three possible API versions (#390, #400).
Improvements:
- Wrap the producer's partitioner call in a circuit-breaker so that repeatedly broken topics don't choke throughput (#373).
Bug Fixes:
- Fix the producer's internal reference counting in certain unusual scenarios (#367).
- Fix the consumer's internal reference counting in certain unusual scenarios (#369).
- Fix a condition where the producer's internal control messages could have gotten stuck (#368).
- Fix an issue where invalid partition lists would be cached when asking for metadata for a non-existant topic (#372).
Version 1.0.0 is the first tagged version, and is almost a complete rewrite. The primary differences with previous untagged versions are:
- The producer has been rewritten; there is now a
SyncProducer
with a blocking API, and anAsyncProducer
that is non-blocking. - The consumer has been rewritten to only open one connection per broker instead of one connection per partition.
- The main types of Sarama are now interfaces to make depedency injection easy; mock implementations for
Consumer
,SyncProducer
andAsyncProducer
are provided in thegithub.com/Shopify/sarama/mocks
package. - For most uses cases, it is no longer necessary to open a
Client
; this will be done for you. - All the configuration values have been unified in the
Config
struct. - Much improved test suite.