harvester

Documentation

Overview

The harvester package harvest different inputs for new information. Currently two harvester types exist:

• log
• stdin

The log harvester reads a file line by line. In case the end of a file is found with an incomplete line, the line pointer stays at the beginning of the incomplete line. As soon as the line is completed, it is read and returned.

The stdin harvesters reads data from stdin.

Index

• func InitRegexps(exprs []string) ([]*regexp.Regexp, error)
• func MatchAnyRegexps(regexps []*regexp.Regexp, text string) bool
• type FileSource
• type Harvester
  • func NewHarvester(cfg *config.HarvesterConfig, path string, stat *input.FileStat, ...) (*Harvester, error)
  • func (h *Harvester) Harvest()
  • func (h *Harvester) SetOffset(offset int64)
  • func (h *Harvester) Start()
  • func (h *Harvester) UpdateState()
• type LogSource

Functions

func InitRegexps

func InitRegexps(exprs []string) ([]*regexp.Regexp, error)

InitRegexps initializes a list of compiled regular expressions.

func MatchAnyRegexps

func MatchAnyRegexps(regexps []*regexp.Regexp, text string) bool

MatchAnyRegexps checks if the text matches any of the regular expressions

Types

type FileSource

type FileSource interface {
	LogSource
	Stat() (os.FileInfo, error)
	Continuable() bool // can we continue processing after EOF?
}

type Harvester

type Harvester struct {
	Path   string /* the file path to harvest */
	Config *config.HarvesterConfig

	Stat        *input.FileStat
	SpoolerChan chan *input.FileEvent

	ExcludeLinesRegexp []*regexp.Regexp
	IncludeLinesRegexp []*regexp.Regexp
	// contains filtered or unexported fields
}

func NewHarvester

func NewHarvester(
	cfg *config.HarvesterConfig,
	path string,
	stat *input.FileStat,
	spooler chan *input.FileEvent,
) (*Harvester, error)

func (*Harvester) Harvest

func (h *Harvester) Harvest()

Log harvester reads files line by line and sends events to the defined output

func (*Harvester) SetOffset

func (h *Harvester) SetOffset(offset int64)

func (*Harvester) Start

func (h *Harvester) Start()

func (*Harvester) UpdateState

func (h *Harvester) UpdateState()

type LogSource

type LogSource interface {
	io.ReadCloser
	Name() string
}