pipeedit

Note

This is a community-maintained plugin!

Pipe output.

Pipe events to stdin of another program. You can use fields from the event as parts of the command. WARNING: This feature can cause logstash to fork off multiple children if you are not carefull with per-event commandline.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

pipe {
    command => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

codec

codec

No

"plain"

command

string

Yes

message_format

string

No

ttl

number

No

10

workers

number

No

1

Detailsedit

 

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

commandedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

Command line to launch and pipe to

message_formatedit

  • Value type is string
  • There is no default value for this setting.

The format to use when writing events to the pipe. This value supports any string and can include %{name} and other dynamic strings.

If this setting is omitted, the full json representation of the event will be written as a single line.

ttledit

  • Value type is number
  • Default value is 10

Close pipe that hasn’t been used for TTL seconds. -1 or 0 means never close.

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.