execedit

  • Version: 3.1.0
  • Released on: 2016-12-06
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-exec.

The exec output will run a command for each event received. Ruby’s system() 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"
    }
  }
}
Warning

If you want it non-blocking you should use & or dtach or other such techniques. There is no timeout for the commands being run so misbehaving commands could otherwise stall the Logstash pipeline indefinitely.

Warning

Exercise great caution with %{name} field placeholders. The contents of the field will be included verbatim without any sanitization, i.e. any shell metacharacters from the field values will be passed straight to the shell.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

exec {
    command => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

codec

codec

No

"plain"

command

string

Yes

enable_metric

boolean

No

true

id

string

No

quiet

boolean

No

false

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 execute via subprocess. Use dtach or screen to make it non blocking. This value can include %{name} and other dynamic strings.

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.

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

quietedit

  • Value type is boolean
  • Default value is false

display the result of the command to the terminal

workersedit

  • Value type is string
  • Default value is 1