prospector

Documentation

Index

• type Outlet
• type Prospector
  • func NewProspector(cfg *common.Config, states file.States, outlet Outlet) (*Prospector, error)
  • func (p *Prospector) Init(states file.States) error
  • func (p *Prospector) IsEnabled() bool
  • func (p *Prospector) Run(once bool)
  • func (p *Prospector) Stop()
• type ProspectorLog
  • func NewProspectorLog(p *Prospector) (*ProspectorLog, error)
  • func (p *ProspectorLog) Init(states file.States) error
  • func (p *ProspectorLog) Run()
• type ProspectorStdin
  • func NewProspectorStdin(p *Prospector) (*ProspectorStdin, error)
  • func (p *ProspectorStdin) Init(states file.States) error
  • func (p *ProspectorStdin) Run()
• type Prospectorer

Types

type Outlet

type Outlet interface {
	OnEvent(event *input.Event) bool
}

type Prospector

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

func NewProspector

func NewProspector(cfg *common.Config, states file.States, outlet Outlet) (*Prospector, error)

func (*Prospector) Init

func (p *Prospector) Init(states file.States) error

Init sets up default config for prospector

func (*Prospector) IsEnabled

func (p *Prospector) IsEnabled() bool

IsEnabled returns true if the prospector is eanbled

func (*Prospector) Run

func (p *Prospector) Run(once bool)

Starts scanning through all the file paths and fetch the related files. Start a harvester for each file

func (*Prospector) Stop

func (p *Prospector) Stop()

type ProspectorLog

type ProspectorLog struct {
	Prospector *Prospector
	// contains filtered or unexported fields
}

func NewProspectorLog

func NewProspectorLog(p *Prospector) (*ProspectorLog, error)

func (*ProspectorLog) Init

func (p *ProspectorLog) Init(states file.States) error

Init sets up the prospector It goes through all states coming from the registry. Only the states which match the glob patterns of the prospector will be loaded and updated. All other states will not be touched.

func (*ProspectorLog) Run

func (p *ProspectorLog) Run()

type ProspectorStdin

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

func NewProspectorStdin

func NewProspectorStdin(p *Prospector) (*ProspectorStdin, error)

NewProspectorStdin creates a new stdin prospector This prospector contains one harvester which is reading from stdin

func (*ProspectorStdin) Init

func (p *ProspectorStdin) Init(states file.States) error

func (*ProspectorStdin) Run

func (p *ProspectorStdin) Run()

type Prospectorer

type Prospectorer interface {
	Init(states file.States) error
	Run()
}