• Plugin version: v3.1.4
• Released on: 2018-04-06
• Changelog

For other versions, see theVersioned plugin docs.

For plugins not bundled by default, it is easy to install by runningbin/logstash-plugin install logstash-output-exec. SeeWorking with plugins for more details.

For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.

The exec output will run a command for each event received. Ruby’ssystem() function will be used, i.e. the command string will be passed to a shell. You can use%{{name}} and other dynamic strings in the command to pass select fields from the event to the child process. Example:

output {  if [type] == "abuse" {    exec {      command => "iptables -A INPUT -s %{clientip} -j DROP"    }  }}

This plugin supports the following configuration options plus theCommon options described later.

Also seeCommon options for a list of options supported by all output plugins.

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

Command line to execute via subprocess. Usedtach orscreen to make it non blocking. This value can include%{{name}} and other dynamic strings.

• Value type isboolean
• Default value isfalse

display the result of the command to the terminal

These configuration options are supported by all output plugins:

• Value type iscodec
• 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.

• Value type isboolean
• Default value istrue

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.

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

Add a uniqueID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 exec outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {  exec {    id => "my_plugin_id"  }}