join

README

Join plugin

It makes one big event from the sequence of the events. It is useful for assembling back together "exceptions" or "panics" if they were written line by line. Also known as "multiline".

⚠ Parsing the whole event flow could be very CPU intensive because the plugin uses regular expressions. Consider match_fields parameter to process only particular events. Check out an example for details.

Example of joining Go panics:

pipelines:
  example_pipeline:
    ...
    actions:
    - type: join
      field: log
      start: '/^(panic:)|(http: panic serving)/'
      continue: '/(^\s*$)|(goroutine [0-9]+ \[)|(\([0-9]+x[0-9,a-f]+)|(\.go:[0-9]+ \+[0-9]x)|(\/.*\.go:[0-9]+)|(\(...\))|(main\.main\(\))|(created by .*\/.*\.)|(^\[signal)|(panic.+[0-9]x[0-9,a-f]+)|(panic:)/'
      match_fields:
        stream: stderr // apply only for events which was written to stderr to save CPU time
    ...

Config params

field cfg.FieldSelector required

The event field which will be checked for joining with each other.

start cfg.Regexp required

A regexp which will start the join sequence.

continue cfg.Regexp required

A regexp which will continue the join sequence.

max_event_size int default=0

Max size of the resulted event. If it is set and the event exceeds the limit, the event will be truncated.

Understanding start/continue regexps

No joining:

event 1
event 2 – matches start regexp
event 3
event 4 – matches continue regexp
event 5

Events event 2 and event 3 will be joined:

event 1
event 2 – matches start regexp
event 3 – matches continue regexp
event 4

Events from event 2 to event N will be joined:

event 1
event 2 matches start regexp
event 3 matches continue regexp
event ... matches continue regexp
event N matches continue regexp
event N+1

Generated using insane-doc

Documentation

Index

• type Config
• type Plugin
  • func (p *Plugin) Do(event *pipeline.Event) pipeline.ActionResult
  • func (p *Plugin) Start(config pipeline.AnyConfig, params *pipeline.ActionPluginParams)
  • func (p *Plugin) Stop()

Types

type Config

type Config struct {
	//> @3@4@5@6
	//>
	//> The event field which will be checked for joining with each other.
	Field  cfg.FieldSelector `json:"field" required:"true" parse:"selector"` //*
	Field_ []string

	//> @3@4@5@6
	//>
	//> A regexp which will start the join sequence.
	Start  cfg.Regexp `json:"start" required:"true" parse:"regexp"` //*
	Start_ *regexp.Regexp

	//> @3@4@5@6
	//>
	//> A regexp which will continue the join sequence.
	Continue  cfg.Regexp `json:"continue" required:"true" parse:"regexp"` //*
	Continue_ *regexp.Regexp

	//> @3@4@5@6
	//>
	//> Max size of the resulted event. If it is set and the event exceeds the limit, the event will be truncated.
	MaxEventSize int `json:"max_event_size" default:"0"` //*
}

! config-params ^ config-params

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func (*Plugin) Do

func (p *Plugin) Do(event *pipeline.Event) pipeline.ActionResult

func (*Plugin) Start

func (p *Plugin) Start(config pipeline.AnyConfig, params *pipeline.ActionPluginParams)

func (*Plugin) Stop

func (p *Plugin) Stop()