kafka

Documentation

Index

• func New(config Config) func(ctx context.Context) error
• type Config
• type Consumer
• type Hook
• type MessageClaimer
• type Server

Functions

func New

func New(config Config) func(ctx context.Context) error

New creates new Kafka health check that verifies the following: - connection establishing - publishing a ping message and verifying the response

Types

type Config

type Config struct {
	// Bootstrap of Kafka cluster. Required.
	Bootstrap []string
	// Version of Kafka
	Version string
	// ServiceName name of service which is implementing health check
	ServiceName string
	// Timeout of a cycle of produce and consume
	Timeout time.Duration
	// CustomTopicName optional custom topic name
	CustomTopicName string
}

Config is the Kafka checker configuration settings container.

type Consumer

type Consumer interface {
	AddClaimer(string, MessageClaimer)
	AddSetupHook(hook Hook)
	AddCleanupHook(hook Hook)
}

type Hook

type Hook func(session sarama.ConsumerGroupSession)

type MessageClaimer

type MessageClaimer func(*sarama.ConsumerMessage) bool

type Server

type Server interface {
	Listen(wg *sync.WaitGroup, close <-chan struct{})
	Close() error
	GetConsumer() sarama.ConsumerGroup
}