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

« Elasticsearch input plugin File input plugin »

› ›

Exec input plugin

edit

Exec input plugin

edit

Plugin version: v3.4.0
Released on: 2021-11-16
Changelog

For other versions, see the Versioned plugin docs.

Getting Help

edit

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.

Description

edit

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

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.

The exec input ultimately uses fork to spawn a child process. Using fork duplicates the parent process address space (in our case, logstash and the JVM); this is mitigated with OS copy-on-write but ultimately you can end up allocating lots of memory just for a "simple" executable. If the exec input fails with errors like ENOMEM: Cannot allocate memory it is an indication that there is not enough non-JVM-heap physical memory to perform the fork.

Example:

input {
  exec {
    command => "echo 'hi!'"
    interval => 30
  }
}

This will execute echo command every 30 seconds.

Compatibility with the Elastic Common Schema (ECS)

edit

This plugin adds metadata about the event’s source, and can be configured to do so in an ECS-compatible way with ecs_compatibility. This metadata is added after the event has been decoded by the appropriate codec, and will not overwrite existing values.

ECS Disabled	ECS v1 , v8	Description
`host`	`[host][name]`	The name of the Logstash host that processed the event
`command`	`[process][command_line]`	The command run by the plugin
`[@metadata][exit_status]`	`[process][exit_code]`	The exit code of the process
—	`[@metadata][input][exec][process][elapsed_time]`	The elapsed time the command took to run in nanoseconds
`[@metadata][duration]`	—	Command duration in seconds as a floating point number (deprecated)

Exec Input configuration options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting	Input type	Required
`command`	string	Yes
`ecs_compatibility`	string	No
`interval`	number	No
`schedule`	string	No

Also see Common Options for a list of options supported by all input plugins.

`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

`ecs_compatibility`

edit

Value type is string
Supported values are:
- disabled: uses backwards compatible field names, such as [host]
- v1, v8: uses fields that are compatible with ECS, such as [host][name]

Controls this plugin’s compatibility with the Elastic Common Schema (ECS). See Compatibility with the Elastic Common Schema (ECS) for detailed information.

Sample output: ECS enabled

{
    "message" => "hi!\n",
    "process" => {
        "command_line" => "echo 'hi!'",
        "exit_code" => 0
    },
    "host" => {
        "name" => "deus-ex-machina"
    },

    "@metadata" => {
        "input" => {
            "exec" => {
                "process" => {
                    "elapsed_time"=>3042
                }
            }
        }
    }
}

Sample output: ECS disabled

{
    "message" => "hi!\n",
    "command" => "echo 'hi!'",
    "host" => "deus-ex-machina",

    "@metadata" => {
        "exit_status" => 0,
        "duration" => 0.004388
    }
}

`interval`

edit

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

Interval to run the command. Value is in seconds.

Either interval or schedule option must be defined.

`schedule`

edit

Value type is string
There is no default value for this setting.

Schedule of when to periodically run command.

This scheduling syntax is powered by rufus-scheduler. The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support).

Examples:

`* 5 * 1-3 *`	will execute every minute of 5am every day of January through March.
`0 * * * *`	will execute on the 0th minute of every hour every day.
`0 6 * * * America/Chicago`	will execute at 6:00am (UTC/GMT -5) every day.

Further documentation describing this syntax can be found here.

Either interval or schedule option must be defined.

Common Options

edit

The following configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`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.

`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 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 inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

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

« Elasticsearch input plugin File input plugin »