pipe
editpipe
editThis is a community-maintained plugin!
Stream events from a long running command pipe.
By default, each event is assumed to be one line. If you want to join lines, you’ll want to use the multiline filter.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
pipe { command => ... }
Available configuration options:
Details
edit
codec
edit- Value type is codec
-
Default value is
"plain"
The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, 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.
TODO(sissel): This should switch to use the line
codec by default
once we switch away from doing readline
Command to run and read events from, one line at a time.
Example:
command => "echo hello world"
tags
edit- Value type is array
- There is no default value for this setting.
Add any number of arbitrary tags to your event.
This can help with processing later.
type
edit- Value type is string
- There is no default value for this setting.
Add a type
field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.
If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.