pipelined

Documentation

Overview

Package pipelined provides the traditional Sensu event pipeline.

Package pipelined provides the traditional Sensu event pipeline.

Package pipelined provides the traditional Sensu event pipeline.

Package pipelined provides the traditional Sensu event pipeline.

Index

• Constants
• type Config
• type ExtensionExecutorGetterFunc
• type Option
• type Pipelined
  • func New(c Config, options ...Option) (*Pipelined, error)
  • func (p *Pipelined) Err() <-chan error
  • func (p *Pipelined) Name() string
  • func (p *Pipelined) Receiver() chan<- interface{}
  • func (p *Pipelined) Start() error
  • func (p *Pipelined) Stop() error

Constants

const (
	// DefaultSocketTimeout specifies the default socket dial
	// timeout in seconds for TCP and UDP handlers.
	DefaultSocketTimeout uint32 = 60
)

const (
	// PipelineCount specifies how many pipelines (goroutines) are
	// in action.
	PipelineCount int = 10
)

Types

type Config

type Config struct {
	Store                   store.Store
	Bus                     messaging.MessageBus
	ExtensionExecutorGetter ExtensionExecutorGetterFunc
	AssetGetter             asset.Getter
}

Config configures a Pipelined.

type ExtensionExecutorGetterFunc

type ExtensionExecutorGetterFunc func(*types.Extension) (rpc.ExtensionExecutor, error)

ExtensionExecutorGetterFunc gets an ExtensionExecutor. Used to decouple Pipelined from gRPC.

type Option

type Option func(*Pipelined) error

Option is a functional option used to configure Pipelined.

type Pipelined

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

Pipelined handles incoming Sensu events and puts them through a Sensu event pipeline, i.e. filter -> mutator -> handler. The Sensu handler configuration determines which Sensu filters and mutator are used.

func New

func New(c Config, options ...Option) (*Pipelined, error)

New creates a new Pipelined with supplied Options applied.

func (*Pipelined) Err

func (p *Pipelined) Err() <-chan error

Err returns a channel to listen for terminal errors on.

func (*Pipelined) Name

func (p *Pipelined) Name() string

Name returns the daemon name

func (*Pipelined) Receiver

func (p *Pipelined) Receiver() chan<- interface{}

Receiver returns the event channel for pipelined.

func (*Pipelined) Start

func (p *Pipelined) Start() error

Start pipelined, subscribing to the "event" message bus topic to pass Sensu events to the pipelines for handling (goroutines).

func (*Pipelined) Stop

func (p *Pipelined) Stop() error

Stop pipelined.