syslog

Documentation

Index

• Constants
• type BaseConfig
• type Case
  • func CreateCases(basicConfig func() *Config) ([]Case, error)
• type Config
  • func NewConfig() *Config
  • func NewConfigWithID(operatorID string) *Config
  • func (c Config) Build(set component.TelemetrySettings) (operator.Operator, error)
• type Parser
  • func (p *Parser) Process(ctx context.Context, entry *entry.Entry) error

Constants

const (
	RFC3164 = "rfc3164"
	RFC5424 = "rfc5424"

	NULTrailer = "NUL"
	LFTrailer  = "LF"
)

const RFC6587OctetCountingPreserveSpaceTest = "RFC6587 Octet Counting Preserve Space"

This is the name of a test which requires setting the PreserveWhitespace flags.

Types

type BaseConfig

type BaseConfig struct {
	Protocol                     string  `mapstructure:"protocol,omitempty"`
	Location                     string  `mapstructure:"location,omitempty"`
	EnableOctetCounting          bool    `mapstructure:"enable_octet_counting,omitempty"`
	AllowSkipPriHeader           bool    `mapstructure:"allow_skip_pri_header,omitempty"`
	NonTransparentFramingTrailer *string `mapstructure:"non_transparent_framing_trailer,omitempty"`
}

BaseConfig is the detailed configuration of a syslog parser.

type Case

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

	// These signal if a test is valid for UDP and/or TCP protocol
	ValidForTCP bool
	ValidForUDP bool
}

func CreateCases

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

type Config

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

Config is the configuration of a syslog parser operator.

func NewConfig

func NewConfig() *Config

NewConfig creates a new syslog parser config with default values

func NewConfigWithID

func NewConfigWithID(operatorID string) *Config

NewConfigWithID creates a new syslog parser config with default values

func (Config) Build

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

Build will build a JSON parser operator.

type Parser

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

Parser is an operator that parses syslog.

func (*Parser) Process

func (p *Parser) Process(ctx context.Context, entry *entry.Entry) error

Process will parse an entry field as syslog.