filtergrok

README

gogstash grok filter module

Synopsis

filter:
  - type: grok
    # (optional) grok pattern, default: "%{COMMONAPACHELOG}"
    match: "%{COMMONAPACHELOG}"
    # (optional) message field to parse, default: "message"
    source: "message"
    # (optional) grok patterns file path, default: empty
    patterns_path: "path/to/file"

Documentation

Index

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

Constants

const ErrorTag = "gogstash_filter_grok_error"

ErrorTag tag added to event when process module failed

const ModuleName = "grok"

ModuleName is the name used in config file

Functions

func InitHandler

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

InitHandler initialize the filter plugin

Types

type FilterConfig

type FilterConfig struct {
	config.FilterConfig

	PatternsPath string `json:"patterns_path"` // path to patterns file
	Match        string `json:"match"`         // match pattern
	Source       string `json:"source"`        // source message field name
	// 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

Event the main filter event