# README
Sarama Cluster
Cluster extensions for Sarama, the Go client library for Apache Kafka 0.8 (and later).
Important
The sarama API is unfortunately very unstable. We are trying to keep this library up-to-date with sarama's latest master and tag new releases with references to sarama's commit SHA1 they were tested against.
Documentation
Documentation and example are available via godoc at http://godoc.org/github.com/bsm/sarama-cluster
Running tests
You need to install Ginkgo & Gomega to run tests. Please see http://onsi.github.io/ginkgo for more details.
To run tests, call:
$ make test
Licence
(The MIT License)
Copyright (c) 2015 Black Square Media Ltd
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# Functions
NewConsumer creates a new consumer instance.
NewConsumerFromClient creates a new consumer for a given list of topics, reusing an existing client See NewConsumer function documentation for more details.
NewZK creates a new connection instance.
# Variables
Standard logger, set to ioutil.Discard by default.
# Structs
Config contains the consumer configuration options.
No description provided by the author
LogNotifier is the standard log notifier, uses a Logger as the backend.
Partition information.
ZK wraps a zookeeper connection.
# Interfaces
Notifier is an abstract event notification handler By default, sarama/cluster uses the LogNotifier which logs events to standard logger.
# Type aliases
A sortable slice of Partition structs.