prospector

Documentation

Index

• type Factory
  • func NewFactory(outlet channel.Outleter, registrar *registrar.Registrar, ...) *Factory
  • func (r *Factory) Create(c *common.Config) (cfgfile.Runner, error)
• type Log
  • func NewLog(p *Prospector) (*Log, error)
  • func (l *Log) LoadStates(states []file.State) error
  • func (l *Log) Run()
• type Prospector
  • func NewProspector(cfg *common.Config, outlet channel.Outleter, beatDone chan struct{}) (*Prospector, error)
  • func (p *Prospector) ID() uint64
  • func (p *Prospector) LoadStates(states []file.State) error
  • func (p *Prospector) Run()
  • func (p *Prospector) Start()
  • func (p *Prospector) Stop()
• type Prospectorer

Types

type Factory

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

Factory is a factory for registrars

func NewFactory

func NewFactory(outlet channel.Outleter, registrar *registrar.Registrar, beatDone chan struct{}) *Factory

NewFactory instantiates a new Factory

func (*Factory) Create

func (r *Factory) Create(c *common.Config) (cfgfile.Runner, error)

Create creates a prospector based on a config

type Log

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

Log contains the prospector and its config

func NewLog

func NewLog(p *Prospector) (*Log, error)

NewLog instantiates a new Log

func (*Log) LoadStates

func (l *Log) LoadStates(states []file.State) error

LoadStates loads states into 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 (*Log) Run

func (l *Log) Run()

Run runs the prospector

type Prospector

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

Prospector contains the prospector

func NewProspector

func NewProspector(cfg *common.Config, outlet channel.Outleter, beatDone chan struct{}) (*Prospector, error)

NewProspector instantiates a new prospector

func (*Prospector) ID

func (p *Prospector) ID() uint64

ID returns prospector identifier

func (*Prospector) LoadStates

func (p *Prospector) LoadStates(states []file.State) error

LoadStates sets up default config for prospector

func (*Prospector) Run

func (p *Prospector) Run()

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

func (*Prospector) Start

func (p *Prospector) Start()

Start starts the prospector

func (*Prospector) Stop

func (p *Prospector) Stop()

Stop stops the prospector and with it all harvesters

type Prospectorer

type Prospectorer interface {
	LoadStates(states []file.State) error
	Run()
}

Prospectorer is the interface common to all prospectors