inputsocket

README

socket input

Synopsis

{
	"input": [
		{
			"type": "socket",

			// Socket type. Must be one of ["tcp", "unix", "unixpacket"].
			"socket": "tcp",

			// For TCP, address must have the form `host:port`.
			// For Unix networks, the address must be a file system path.
			"address": "localhost:9999"
		}
	]
}

Note: at the moment, this input only works with connection-oriented sockets.

Datagram-oriented sockets like UDP or UNIXGRAM socket are not supported.

Documentation

Index

• Constants
• Variables
• func InitHandler(ctx context.Context, raw *config.ConfigRaw) (config.TypeInputConfig, error)
• type InputConfig
  • func DefaultInputConfig() InputConfig
  • func (i *InputConfig) Start(ctx context.Context, msgChan chan<- logevent.LogEvent) error

Constants

const ModuleName = "socket"

ModuleName is the name used in config file

Variables

var (
	ErrorUnknownSocketType1 = errutil.NewFactory("%q is not a valid socket type")
	ErrorSocketAccept       = errutil.NewFactory("socket accept error")
)

errors

Functions

func InitHandler

func InitHandler(ctx context.Context, raw *config.ConfigRaw) (config.TypeInputConfig, error)

InitHandler initialize the input plugin

Types

type InputConfig

type InputConfig struct {
	config.InputConfig
	Socket  string `json:"socket"`  // Type of socket, must be one of ["tcp", "unix", "unixpacket"].
	Address string `json:"address"` // For TCP, address must have the form `host:port`. For Unix networks, the address must be a file system path.
}

InputConfig holds the configuration json fields and internal objects

func DefaultInputConfig

func DefaultInputConfig() InputConfig

DefaultInputConfig returns an InputConfig struct with default values

func (*InputConfig) Start

func (i *InputConfig) Start(ctx context.Context, msgChan chan<- logevent.LogEvent) error

Start wraps the actual function starting the plugin