tcp

Documentation

Index

• Constants
• type BaseConfig
• type Config
  • func NewConfig() *Config
  • func NewConfigWithID(operatorID string) *Config
  • func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error)
• type Input
  • func (t *Input) Start(_ operator.Persister) error
  • func (t *Input) Stop() error

Constants

const (

	// DefaultMaxLogSize is the max buffer sized used
	// if MaxLogSize is not set
	DefaultMaxLogSize = 1024 * 1024
)

Types

type BaseConfig

type BaseConfig struct {
	MaxLogSize                  helper.ByteSize             `mapstructure:"max_log_size,omitempty"`
	ListenAddress               string                      `mapstructure:"listen_address,omitempty"`
	TLS                         *configtls.TLSServerSetting `mapstructure:"tls,omitempty"`
	AddAttributes               bool                        `mapstructure:"add_attributes,omitempty"`
	Encoding                    helper.EncodingConfig       `mapstructure:",squash,omitempty"`
	Multiline                   helper.MultilineConfig      `mapstructure:"multiline,omitempty"`
	PreserveLeadingWhitespaces  bool                        `mapstructure:"preserve_leading_whitespaces,omitempty"`
	PreserveTrailingWhitespaces bool                        `mapstructure:"preserve_trailing_whitespaces,omitempty"`
}

BaseConfig is the detailed configuration of a tcp input operator.

type Config

type Config struct {
	helper.InputConfig `mapstructure:",squash"`
	BaseConfig         `mapstructure:",squash"`
}

Config is the configuration of a tcp input operator.

func NewConfig

func NewConfig() *Config

NewConfigWithID creates a new TCP input config with default values

func NewConfigWithID

func NewConfigWithID(operatorID string) *Config

NewConfigWithID creates a new TCP input config with default values

func (Config) Build

func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error)

Build will build a tcp input operator.

type Input

type Input struct {
	helper.InputOperator

	MaxLogSize int
	// contains filtered or unexported fields
}

Input is an operator that listens for log entries over tcp.

func (*Input) Start

func (t *Input) Start(_ operator.Persister) error

Start will start listening for log entries over tcp.

func (*Input) Stop

func (t *Input) Stop() error

Stop will stop listening for log entries over TCP.