kafka

README

Kafka plugin

It reads events from multiple Kafka topics using sarama library.

It guarantees at "at-least-once delivery" due to the commitment mechanism.

Config params

brokers []string required

The name of kafka brokers to read from.

topics []string required

The list of kafka topics to read from.

consumer_group string default=file-d

The name of consumer group to use.

Generated using insane-doc

Documentation

Index

• func Factory() (pipeline.AnyPlugin, pipeline.AnyConfig)
• type Config
• type Plugin
  • func (p *Plugin) Cleanup(sarama.ConsumerGroupSession) error
  • func (p *Plugin) Commit(event *pipeline.Event)
  • func (p *Plugin) ConsumeClaim(_ sarama.ConsumerGroupSession, claim sarama.ConsumerGroupClaim) error
  • func (p *Plugin) Setup(session sarama.ConsumerGroupSession) error
  • func (p *Plugin) Start(config pipeline.AnyConfig, params *pipeline.InputPluginParams)
  • func (p *Plugin) Stop()

Functions

func Factory

func Factory() (pipeline.AnyPlugin, pipeline.AnyConfig)

Types

type Config

type Config struct {
	//> @3@4@5@6
	//>
	//> The name of kafka brokers to read from.
	Brokers []string `json:"brokers" required:"true"` //*

	//> @3@4@5@6
	//>
	//> The list of kafka topics to read from.
	Topics []string `json:"topics" required:"true"` //*

	//> @3@4@5@6
	//>
	//> The name of consumer group to use.
	ConsumerGroup string `json:"consumer_group" default:"file-d"` //*
}

! config-params ^ config-params

type Plugin

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

func (*Plugin) Cleanup

func (p *Plugin) Cleanup(sarama.ConsumerGroupSession) error

func (*Plugin) Commit

func (p *Plugin) Commit(event *pipeline.Event)

func (*Plugin) ConsumeClaim

func (p *Plugin) ConsumeClaim(_ sarama.ConsumerGroupSession, claim sarama.ConsumerGroupClaim) error

func (*Plugin) Setup

func (p *Plugin) Setup(session sarama.ConsumerGroupSession) error

func (*Plugin) Start

func (p *Plugin) Start(config pipeline.AnyConfig, params *pipeline.InputPluginParams)

func (*Plugin) Stop

func (p *Plugin) Stop()