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 MatchAnyRegexps(regexps []*regexp.Regexp, text string) bool
• type Harvester
  • func NewHarvester(cfg *common.Config, path string, state file.State, ...) (*Harvester, error)
  • func (h *Harvester) GetState() file.State
  • func (h *Harvester) Harvest()
  • func (h *Harvester) SendStateUpdate() bool
  • func (h *Harvester) SetOffset(offset int64)

Functions

func MatchAnyRegexps

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

MatchAnyRegexps checks if the text matches any of the regular expressions

Types

type Harvester

type Harvester struct {
	Path   string /* the file path to harvest */
	Config harvesterConfig

	State file.State

	SpoolerChan chan *input.FileEvent

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

func NewHarvester

func NewHarvester(
	cfg *common.Config,
	path string,
	state file.State,
	spooler chan *input.FileEvent,
	offset int64,
	done chan struct{},
) (*Harvester, error)

func (*Harvester) GetState

func (h *Harvester) GetState() file.State

func (*Harvester) Harvest

func (h *Harvester) Harvest()

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

func (*Harvester) SendStateUpdate

func (h *Harvester) SendStateUpdate() bool

SendStateUpdate send an empty event with the current state to update the registry

func (*Harvester) SetOffset

func (h *Harvester) SetOffset(offset int64)