IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« pagerduty riemann »
Elastic Docs ›Logstash Reference [1.5] ›Logstash Reference ›Output plugins

pipe

edit

pipe

edit

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.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

pipe {
    command => ...
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

command

string

Yes

message_format

string

No

ttl

number

No

10

workers

number

No

1

Details

edit

 

codec

edit
  • 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.

command

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

Command line to launch and pipe to

exclude_tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

message_format

edit
  • 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.

tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

ttl

edit
  • Value type is number
  • Default value is 10

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

type (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s type attribute for more. Optional.

workers

edit
  • 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.

« pagerduty riemann »