For other versions, see theVersioned plugin docs.
For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-exec
. See Working with plugins for more details.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
The exec output will run a command for each event received. Ruby’ssystem()
function will be used, i.e. the command string willbe passed to a shell. You can use %{name}
and other dynamic stringsin the command to pass select fields from the event to the childprocess. Example:
output { if [type] == "abuse" { exec { command => "iptables -A INPUT -s %{clientip} -j DROP" } }}
If you want it non-blocking you should use &
or dtach
or other such techniques. There is no timeout for the commands beingrun so misbehaving commands could otherwise stall the Logstashpipeline indefinitely.
Exercise great caution with %{name}
field placeholders.The contents of the field will be included verbatim without anysanitization, i.e. any shell metacharacters from the field valueswill be passed straight to the shell.
This plugin supports the following configuration options plus the Common Options described later.
Also see Common Options for a list of options supported by alloutput plugins.
Command line to execute via subprocess. Use dtach
or screen
tomake it non blocking. This value can include %{name}
and otherdynamic strings.
false
display the result of the command to the terminal
The following configuration options are supported by all output plugins:
"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.
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 collectionfor a specific plugin.
Add a unique ID
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 usefulwhen 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" }}