Pipe input pluginedit

  • Plugin version: v3.1.0
  • Released on: 2021-11-18
  • Changelog

For other versions, see the Versioned plugin docs.

Getting Helpedit

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.

Descriptionedit

Stream events from a long running command pipe.

By default, each event is assumed to be one line. If you want to join lines, you’ll want to use the multiline codec.

Compatibility with the Elastic Common Schema (ECS)edit

This plugin adds extra fields about the event’s source. Configure the ecs_compatibility option if you want to ensure that these fields are compatible with ECS.

These fields are 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

Pipe Input Configuration Optionsedit

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

Setting Input type Required

command

string

Yes

ecs_compatibility

string

No

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

 

commandedit

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

Command to run and read events from, one line at a time.

Example:

input {
  pipe {
    command => "echo ¡Hola!"
  }
}

ecs_compatibilityedit

  • 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

{
    "@timestamp"=>2021-11-16T09:18:45.306Z,
    "message" => "¡Hola!",
    "process" => {
        "command_line" => "echo '¡Hola!'"
    },
    "host" => {
        "name" => "deus-ex-machina"
    }
}

Sample output: ECS disabled

{
    "@timestamp"=>2021-11-16T09:18:45.306Z,
    "message" => "¡Hola!",
    "command" => "echo '¡Hola!'",
    "host" => "deus-ex-machina"
}

Common Optionsedit

The following configuration options are supported by all input plugins:

Setting Input type Required

add_field

hash

No

enable_metric

boolean

No

id

string

No

tags

array

No

type

string

No

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

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.

idedit

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

input {
  pipe {
    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.

tagsedit

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

typeedit

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