beat

package

v1.0.0-beta4 Latest Latest Go to latest Published: Oct 22, 2015 License: Apache-2.0 Imports: 9 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Beat struct {
	Name    string
	Version string
	Config  *BeatConfig
	BT      Beater
	Events  publisher.Client
}

Basic beat information

func NewBeat(name string, version string, bt Beater) *Beat

Initiates a new beat object

func (beat *Beat) CommandLineSetup()

Reads and parses the default command line params To set additional cmd line args use the beat.CmdLine type before calling the function

func (b *Beat) LoadConfig()

LoadConfig inits the config file and reads the default config information into Beat.Config. It exists the processes in case of errors.

func (b *Beat) Run()

Run calls the beater Setup and Run methods. In case of errors during the setup phase, it exits the process.

func (beat *Beat) Stop()

Stop calls the beater Stop action.

type BeatConfig struct {
	Output  map[string]outputs.MothershipConfig
	Logging logp.Logging
	Shipper publisher.ShipperConfig
}

Basic configuration of every beat

type Beater interface {
	Config(*Beat) error
	Setup(*Beat) error
	Run(*Beat) error
	Cleanup(*Beat) error
	Stop()
}

Beater interface that every beat must use