router

Documentation

Index

• type Config
  • func NewConfig() *Config
  • func NewConfigWithID(operatorID string) *Config
  • func (c Config) Build(set component.TelemetrySettings) (operator.Operator, error)
• type Route
• type RouteConfig
• type Transformer
  • func (t *Transformer) CanOutput() bool
  • func (t *Transformer) CanProcess() bool
  • func (t *Transformer) GetOutputIDs() []string
  • func (t *Transformer) Outputs() []operator.Operator
  • func (t *Transformer) Process(ctx context.Context, entry *entry.Entry) error
  • func (t *Transformer) SetOutputIDs(_ []string)
  • func (t *Transformer) SetOutputs(operators []operator.Operator) error

Types

type Config

type Config struct {
	helper.BasicConfig `mapstructure:",squash"`
	Routes             []*RouteConfig `mapstructure:"routes"`
	Default            []string       `mapstructure:"default"`
}

Config is the configuration of a router operator

func NewConfig

func NewConfig() *Config

NewConfig config creates a new router operator config with default values

func NewConfigWithID

func NewConfigWithID(operatorID string) *Config

NewConfigWithID config creates a new router operator config with default values

func (Config) Build

func (c Config) Build(set component.TelemetrySettings) (operator.Operator, error)

Build will build a router operator from the supplied configuration

type Route

type Route struct {
	helper.Attributer
	Expression      *vm.Program
	OutputIDs       []string
	OutputOperators []operator.Operator
}

Route is a route on a router operator

type RouteConfig

type RouteConfig struct {
	helper.AttributerConfig `mapstructure:",squash"`
	Expression              string   `mapstructure:"expr"`
	OutputIDs               []string `mapstructure:"output"`
}

RouteConfig is the configuration of a route on a router operator

type Transformer

type Transformer struct {
	helper.BasicOperator
	// contains filtered or unexported fields
}

Transformer is an operator that routes entries based on matching expressions

func (*Transformer) CanOutput

func (t *Transformer) CanOutput() bool

CanOutput will always return true for a router operator

func (*Transformer) CanProcess

func (t *Transformer) CanProcess() bool

CanProcess will always return true for a router operator

func (*Transformer) GetOutputIDs

func (t *Transformer) GetOutputIDs() []string

GetOutputIDs will return all connected operators.

func (*Transformer) Outputs

func (t *Transformer) Outputs() []operator.Operator

Outputs will return all connected operators.

func (*Transformer) Process

func (t *Transformer) Process(ctx context.Context, entry *entry.Entry) error

Process will route incoming entries based on matching expressions

func (*Transformer) SetOutputIDs

func (t *Transformer) SetOutputIDs(_ []string)

SetOutputIDs will do nothing.

func (*Transformer) SetOutputs

func (t *Transformer) SetOutputs(operators []operator.Operator) error

SetOutputs will set the outputs of the router operator.