IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« eventlog file »

› ›

exec

edit

exec

edit

Version: 3.1.2
Released on: 2016-09-15
Changelog
Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

Periodically run a shell command and capture the whole output as an event.

Notes:

The command field of this event will be the command run.
The message field of this event will be the entire stdout of the command.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

exec {
    command => ...
    interval => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`codec`	codec	No	`"plain"`
`command`	string	Yes
`enable_metric`	boolean	No	`true`
`id`	string	No
`interval`	number	Yes
`tags`	array	No
`type`	string	No

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

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

Command to run. For example, uptime

`enable_metric`

edit

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.

`id`

edit

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.

`interval`

edit

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

Interval to run the command. Value is in seconds.

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

« eventlog file »