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

pipeedit

  • Version: 3.0.2
  • Released on: 2016-07-14
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

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 type Required Default value

codec

codec

No

"plain"

command

string

Yes

enable_metric

boolean

No

true

id

string

No

message_format

string

No

ttl

number

No

10

workers

<<,>>

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

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

idedit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

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 string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne

« pagerduty rabbitmq »