inputs

Documentation

Index

• Variables
• type FileInput
  • func (i *FileInput) Close() error
  • func (i *FileInput) Start(out chan<- *event.Event) error
• type Input
  • func New(name string, options map[string]interface{}) (Input, error)

Variables

var (

	// ErrInputNotRegistered is returned when attempting to create an unregistered Input.
	ErrInputNotRegistered = errors.New("Input doesn't exist")
)

Types

type FileInput

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

A FileInput will read a file and optionally tail it. Each line is considered a separate event.

func (*FileInput) Close

func (i *FileInput) Close() error

Close the FileInput

func (*FileInput) Start

func (i *FileInput) Start(out chan<- *event.Event) error

Start the FileInput reading/tailing.

type Input

type Input interface {
	// Start creates a go routine for the Input to run in. out is an Event
	// channel where the Input will send generated Events.
	Start(out chan<- *event.Event) error

	// Close allows graceful shutdown of an Input.
	Close() error
}

An Input generates events to be processed.

func New

func New(name string, options map[string]interface{}) (Input, error)

New creates an instance of Input name with options. Options are dependent on the Input.