json_decode

README

JSON decode plugin

It decodes a JSON string from the event field and merges the result with the event root. If the decoded JSON isn't an object, the event will be skipped.

Config params

field cfg.FieldSelector required

The event field to decode. Must be a string.

prefix string

A prefix to add to decoded object keys.

log_json_parse_error_mode string default=off options=off|erronly|withnode

Defines how to handle logging of json parse error.

• off – do not log json parse errors
• erronly – log only errors without any other data
• withnode – log errors with json node represented as string

Defaults to off.

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 to decode. Must be a string.
	Field  cfg.FieldSelector `json:"field" parse:"selector" required:"true"` // *
	Field_ []string

	// > @3@4@5@6
	// >
	// > A prefix to add to decoded object keys.
	Prefix string `json:"prefix" default:""` // *

	// > @3@4@5@6
	// >
	// > Defines how to handle logging of json parse error.
	// > @jsonParseErrorMode|comment-list
	// >
	// > Defaults to `off`.
	LogJSONParseErrorMode  string `json:"log_json_parse_error_mode" default:"off" options:"off|erronly|withnode"` // *
	LogJSONParseErrorMode_ logJsonParseErrorMode
}

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