beater

Documentation

Index

• type Filebeat
  • func New() *Filebeat
  • func (fb *Filebeat) Cleanup(b *beat.Beat) error
  • func (fb *Filebeat) Config(b *beat.Beat) error
  • func (fb *Filebeat) Run(b *beat.Beat) error
  • func (fb *Filebeat) Setup(b *beat.Beat) error
  • func (fb *Filebeat) Stop()

Types

type Filebeat

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

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

func New

func New() *Filebeat

New creates a new Filebeat pointer instance.

func (*Filebeat) Cleanup

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

Cleanup removes any temporary files, data, or other items that were created by the Beat.

func (*Filebeat) Config

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

Config setups up the filebeat configuration by fetch all additional config files

func (*Filebeat) Run

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

Run allows the beater to be run as a beat.

func (*Filebeat) Setup

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

Setup applies the minimum required setup to a new Filebeat instance for use.

func (*Filebeat) Stop

func (fb *Filebeat) Stop()

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