tcp

Documentation

Index

• Constants
• type TCPInput
  • func (t *TCPInput) Start() error
  • func (t *TCPInput) Stop() error
• type TCPInputConfig
  • func NewTCPInputConfig(operatorID string) *TCPInputConfig
  • func (c TCPInputConfig) Build(context operator.BuildContext) ([]operator.Operator, error)
• type TLSConfig

Constants

const (

	// DefaultMaxBufferSize is the max buffer sized used
	// if MaxBufferSize is not set
	DefaultMaxBufferSize = 1024 * 1024
)

Types

type TCPInput

type TCPInput struct {
	helper.InputOperator
	// contains filtered or unexported fields
}

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

func (*TCPInput) Start

func (t *TCPInput) Start() error

Start will start listening for log entries over tcp.

func (*TCPInput) Stop

func (t *TCPInput) Stop() error

Stop will stop listening for log entries over TCP.

type TCPInputConfig

type TCPInputConfig struct {
	helper.InputConfig `yaml:",inline"`

	MaxBufferSize helper.ByteSize `json:"max_buffer_size,omitempty" yaml:"max_buffer_size,omitempty"`
	ListenAddress string          `json:"listen_address,omitempty" yaml:"listen_address,omitempty"`
	TLS           TLSConfig       `json:"tls,omitempty" yaml:"tls,omitempty"`
}

TCPInputConfig is the configuration of a tcp input operator.

func NewTCPInputConfig

func NewTCPInputConfig(operatorID string) *TCPInputConfig

NewTCPInputConfig creates a new TCP input config with default values

func (TCPInputConfig) Build

func (c TCPInputConfig) Build(context operator.BuildContext) ([]operator.Operator, error)

Build will build a tcp input operator.

type TLSConfig

type TLSConfig struct {
	// Enable forces the user of TLS
	Enable bool `json:"enable,omitempty" yaml:"enable,omitempty"`

	// Certificate is the file path for the certificate
	Certificate string `json:"certificate,omitempty" yaml:"certificate,omitempty"`

	// PrivateKey is the file path for the private key
	PrivateKey string `json:"private_key,omitempty" yaml:"private_key,omitempty"`
}

TLSConfig is the configuration for a TLS listener