syslog

Documentation

Index

• Constants
• type Case
  • func CreateCases(basicConfig func() *SyslogParserConfig) ([]Case, error)
• type SyslogBaseConfig
• type SyslogParser
  • func (s *SyslogParser) Process(ctx context.Context, entry *entry.Entry) error
• type SyslogParserConfig
  • func NewSyslogParserConfig(operatorID string) *SyslogParserConfig
  • func (c SyslogParserConfig) Build(logger *zap.SugaredLogger) (operator.Operator, error)

Constants

const RFC3164 = "rfc3164"

const RFC5424 = "rfc5424"

Types

type Case

type Case struct {
	Name   string
	Config *SyslogParserConfig
	Input  *entry.Entry
	Expect *entry.Entry
}

func CreateCases

func CreateCases(basicConfig func() *SyslogParserConfig) ([]Case, error)

type SyslogBaseConfig

type SyslogBaseConfig struct {
	Protocol string `mapstructure:"protocol,omitempty" json:"protocol,omitempty" yaml:"protocol,omitempty"`
	Location string `mapstructure:"location,omitempty" json:"location,omitempty" yaml:"location,omitempty"`
}

SyslogBaseConfig is the detailed configuration of a syslog parser.

type SyslogParser

type SyslogParser struct {
	helper.ParserOperator
	// contains filtered or unexported fields
}

SyslogParser is an operator that parses syslog.

func (*SyslogParser) Process

func (s *SyslogParser) Process(ctx context.Context, entry *entry.Entry) error

Process will parse an entry field as syslog.

type SyslogParserConfig

type SyslogParserConfig struct {
	helper.ParserConfig `mapstructure:",squash" yaml:",inline"`
	SyslogBaseConfig    `mapstructure:",squash" yaml:",inline"`
}

SyslogParserConfig is the configuration of a syslog parser operator.

func NewSyslogParserConfig

func NewSyslogParserConfig(operatorID string) *SyslogParserConfig

NewSyslogParserConfig creates a new syslog parser config with default values

func (SyslogParserConfig) Build

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

Build will build a JSON parser operator.