syslog

README

Syslog - internal notes

go get github.com/influxdata/go-syslog/v3

https://github.com/influxdata/go-syslog

Documentation

Index

• Constants
• func InitHandler(ctx context.Context, raw config.ConfigRaw, control config.Control) (config.TypeFilterConfig, error)
• type FilterConfig
  • func DefaultFilterConfig() FilterConfig
  • func (f *FilterConfig) Event(ctx context.Context, event logevent.LogEvent) (logevent.LogEvent, bool)

Constants

const AppNameField = "appname" // default appname

const ErrorTag = "gogstash_filter_syslog_error"

ErrorTag tag added to event when process module failed

const HostnameField = "hostname" // default hostname

const MessageField = "syslog_message" // default field for syslog message

const MessageIdField = "message_id" // default message id

const ModuleName = "syslog"

ModuleName is the name used in config file

const PriorityField = "priority" // default priority

const SeverityField = "severity" // default severity

Functions

func InitHandler

func InitHandler(ctx context.Context, raw config.ConfigRaw, control config.Control) (config.TypeFilterConfig, error)

InitHandler initialize the filter plugin

Types

type FilterConfig

type FilterConfig struct {
	config.FilterConfig

	Source         string `json:"source" yaml:"source"`                 // source message field name
	Format         string `json:"format" yaml:"format"`                 // input format, either RFC3164 or RFC5424
	SaveTime       bool   `json:"save_time" yaml:"save_time"`           // if true time from syslog is kept
	RemoveSource   bool   `json:"remove_source" yaml:"remove_source"`   // if true source message is removed (upon success)
	MessageField   string `json:"message_field" yaml:"message_field"`   // syslog message
	HostnameField  string `json:"hostname_field" yaml:"hostname_field"` // hostname
	AppNameField   string `yaml:"app_name_field" json:"app_name_field"` // appname
	SeverityField  string `json:"severity_field" yaml:"severity_field"`
	PriorityField  string `json:"priority_field" yaml:"priority_field"`
	MessageIdField string `json:"message_id_field" yaml:"message_id_field"`
	// contains filtered or unexported fields
}

FilterConfig holds the configuration json fields and internal objects

func DefaultFilterConfig

func DefaultFilterConfig() FilterConfig

DefaultFilterConfig returns an FilterConfig struct with default values

func (*FilterConfig) Event

func (f *FilterConfig) Event(ctx context.Context, event logevent.LogEvent) (logevent.LogEvent, bool)

Event the main filter event