package
1.3.3-alpha.0
Repository: https://github.com/yext/burrow.git
Documentation: pkg.go.dev

# Constants

StatusError indicates that a group has one or more partitions that are in the Stop, Stall, or Rewind states.
StatusNotFound indicates that the consumer group does not exist.
StatusOK indicates that a partition is in a good state.
StatusRewind indicates that the consumer has committed an offset for the partition that is less than the previous offset.
StatusStall indicates that the consumer is committing offsets for the partition, but they are not increasing and the lag is non-zero.
StatusStop indicates that the consumer has not committed an offset for that partition in some time, and the lag is non-zero.
StatusWarning indicates that a partition is lagging - it is making progress, but falling further behind.
StorageClearConsumerOwners is the request type to remove all partition owner information for a single group.
StorageFetchClusters is the request type to retrieve a list of clusters.
StorageFetchConsumer is the request type to retrieve all stored information for a single consumer group.
StorageFetchConsumers is the request type to retrieve a list of consumer groups in a cluster.
StorageFetchConsumersForTopic is the request type to obtain a list of all consumer groups consuming from a topic.
StorageFetchTopic is the request type to retrieve the current broker offsets (one per partition) for a topic.
StorageFetchTopics is the request type to retrieve a list of topics in a cluster.
StorageSetBrokerOffset is the request type to store a broker offset.
StorageSetConsumerOffset is the request type to store a consumer offset.
StorageSetConsumerOwner is the request type to store a consumer owner.
StorageSetDeleteGroup is the request type to remove a consumer group.
StorageSetDeleteTopic is the request type to remove a topic from the broker and all consumers.

# Structs

ApplicationContext is a structure that holds objects that are used across all coordinators and modules.
ConsumerGroupStatus is the response object that is sent in reply to an EvaluatorRequest.
ConsumerOffset represents a single offset stored.
ConsumerPartition represents the information stored for a group for a single partition.
EvaluatorRequest is sent over the EvaluatorChannel that is stored in the application context.
Lag is just a wrapper for a uint64, but it can be `nil`.
PartitionStatus represents the state of a single consumed partition.
StorageRequest is sent over the StorageChannel that is stored in the application context.

# Interfaces

Coordinator is a common interface for all subsystem coordinators so that the core routine can manage them in a consistent manner.
Module is a common interface for all modules so that they can be manipulated by the coordinators in the same way.
ZookeeperClient is a minimal interface for working with a Zookeeper connection.
ZookeeperLock is an interface for the operation of a lock in Zookeeper.

# Type aliases

ConsumerPartitions describes all partitions for a single topic.
ConsumerTopics is the response that is sent for a StorageFetchConsumer request.
StatusConstant describes the state of a partition or group as a single value.
StorageRequestConstant is used in StorageRequest to indicate the type of request.