beater

Documentation

Index

• func New(b *beat.Beat, rawConfig *common.Config) (beat.Beater, error)
• type AutodiscoverAdapter
  • func NewAutodiscoverAdapter(prospectorFactory, moduleFactory cfgfile.RunnerFactory) *AutodiscoverAdapter
  • func (m *AutodiscoverAdapter) CheckConfig(c *common.Config) error
  • func (m *AutodiscoverAdapter) Create(c *common.Config, meta *common.MapStrPointer) (cfgfile.Runner, error)
  • func (m *AutodiscoverAdapter) CreateConfig(e bus.Event) ([]*common.Config, error)
  • func (m *AutodiscoverAdapter) StartFilter() []string
  • func (m *AutodiscoverAdapter) StopFilter() []string
• type Filebeat
  • func (fb *Filebeat) Run(b *beat.Beat) error
  • func (fb *Filebeat) Stop()

Functions

func New

func New(b *beat.Beat, rawConfig *common.Config) (beat.Beater, error)

New creates a new Filebeat pointer instance.

Types

type AutodiscoverAdapter

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

AutodiscoverAdapter for Filebeat modules & prospectors

func NewAutodiscoverAdapter

func NewAutodiscoverAdapter(prospectorFactory, moduleFactory cfgfile.RunnerFactory) *AutodiscoverAdapter

NewAutodiscoverAdapter builds and returns an autodiscover adapter for Filebeat modules & prospectors

func (*AutodiscoverAdapter) CheckConfig

func (m *AutodiscoverAdapter) CheckConfig(c *common.Config) error

CheckConfig tests given config to check if it will work or not, returns errors in case it won't work

func (*AutodiscoverAdapter) Create

func (m *AutodiscoverAdapter) Create(c *common.Config, meta *common.MapStrPointer) (cfgfile.Runner, error)

Create a module or prospector from the given config

func (*AutodiscoverAdapter) CreateConfig

func (m *AutodiscoverAdapter) CreateConfig(e bus.Event) ([]*common.Config, error)

CreateConfig generates a valid list of configs from the given event, the received event will have all keys defined by `StartFilter`

func (*AutodiscoverAdapter) StartFilter

func (m *AutodiscoverAdapter) StartFilter() []string

StartFilter returns the bus filter to retrieve runner start triggering events

func (*AutodiscoverAdapter) StopFilter

func (m *AutodiscoverAdapter) StopFilter() []string

StopFilter returns the bus filter to retrieve runner stop triggering events

type Filebeat

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

Filebeat is a beater object. Contains all objects needed to run the beat

func (*Filebeat) Run

func (fb *Filebeat) Run(b *beat.Beat) error

Run allows the beater to be run as a beat.

func (*Filebeat) Stop

func (fb *Filebeat) Stop()

Stop is called on exit to stop the crawling, spooling and registration processes.