kafka

Documentation

Index

• Constants
• type Config
• type Message
• type Meta
  • func NewMeta(name string, version string) Meta
• type MetricsWriter
• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Boot(conf interface{}, dependencies ...interface{}) plugins.Plugin
  • func (p *Plugin) Close() error
  • func (p *Plugin) EnableMetrics(metrics MetricsWriter)
  • func (p *Plugin) IsEnabled() bool
  • func (p *Plugin) Name() string
  • func (p *Plugin) ReadFromTopic(topic string, consumerGroupID string, messageC chan<- Message)
  • func (p *Plugin) ReadFromTopicEnd(topic string, consumerGroupID string, messageC chan<- Message)
  • func (p *Plugin) ReadFromTopicWithContext(ctx context.Context, topic string, consumerGroupID string, useLastOffset bool, ...)
  • func (p *Plugin) Start() error
  • func (p *Plugin) WriteToTopic(topic string, key string, value string) error
  • func (p *Plugin) WriteToTopicAsync(topic string, key string, value string)

Constants

const Name = "kafka"

Types

type Config

type Config struct {
	Enable  bool   `env:"KAFKA_ENABLE" default:"false" yaml:"enable"`
	Brokers string `env:"KAFKA_BROKERS" default:"localhost:9092" yaml:"brokers"`
}

type Message

type Message struct {
	Topic         string
	Partition     int
	Offset        int64
	HighWaterMark int64
	Key           []byte
	Value         []byte
	Time          time.Time
}

type Meta

type Meta struct {
	ID        string    `json:"id" yaml:"id"`
	Name      string    `json:"name" yaml:"name"`
	CreatedAt time.Time `json:"created_at" yaml:"created_at"`
	Version   string    `json:"version" yaml:"version"`
}

func NewMeta

func NewMeta(name string, version string) Meta

type MetricsWriter

type MetricsWriter interface {
	AddCounter(name string, count float64, help string)
}

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func New

func New() *Plugin

func (*Plugin) Boot

func (p *Plugin) Boot(conf interface{}, dependencies ...interface{}) plugins.Plugin

func (*Plugin) Close

func (p *Plugin) Close() error

func (*Plugin) EnableMetrics

func (p *Plugin) EnableMetrics(metrics MetricsWriter)

func (*Plugin) IsEnabled

func (p *Plugin) IsEnabled() bool

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) ReadFromTopic

func (p *Plugin) ReadFromTopic(topic string, consumerGroupID string, messageC chan<- Message)

func (*Plugin) ReadFromTopicEnd

func (p *Plugin) ReadFromTopicEnd(topic string, consumerGroupID string, messageC chan<- Message)

func (*Plugin) ReadFromTopicWithContext

func (p *Plugin) ReadFromTopicWithContext(ctx context.Context, topic string, consumerGroupID string, useLastOffset bool, messageC chan<- Message)

func (*Plugin) Start

func (p *Plugin) Start() error

func (*Plugin) WriteToTopic

func (p *Plugin) WriteToTopic(topic string, key string, value string) error

func (*Plugin) WriteToTopicAsync

func (p *Plugin) WriteToTopicAsync(topic string, key string, value string)