join_template

README

Join Template plugin

Alias to join plugin with predefined fast (regexes not used) start and continue checks. Use do_if or match_fields to prevent extra checks and reduce CPU usage.

Example of joining Go panics:

pipelines:
  example_pipeline:
    ...
    actions:
      - type: join_template
        template: go_panic
        field: log
        do_if:
          field: stream
          op: equal
          values:
            - stderr # apply only for events which was written to stderr to save CPU time
    ...

Config params

field cfg.FieldSelector default=log required

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

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.

template string

The name of the template. Available templates: go_panic, cs_exception, go_data_race. Deprecated; use templates instead.

templates []string

Names of templates. Available templates: go_panic, cs_exception, go_data_race.

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" default:"log" required:"true" parse:"selector"` // *
	Field_ []string

	// > @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"` // *

	// > @3@4@5@6
	// >
	// > The name of the template. Available templates: `go_panic`, `cs_exception`, `go_data_race`.
	// > Deprecated; use `templates` instead.
	Template string `json:"template"` // *

	// > @3@4@5@6
	// >
	// > Names of templates. Available templates: `go_panic`, `cs_exception`, `go_data_race`.
	Templates []string `json:"templates"` // *
}

! 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()