Unix input plugin
editUnix input plugin
edit- Plugin version: v3.1.2
- Released on: 2022-10-03
- Changelog
For other versions, see the Versioned plugin docs.
Getting help
editFor 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
editRead events over a UNIX socket.
Like stdin
and file
inputs, each event is assumed to be one line of text.
Can either accept connections from clients or connect to a server,
depending on mode
.
Compatibility with the Elastic Common Schema (ECS)
editThis 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 |
---|---|---|
|
|
The name of the Logstash host that processed the event |
|
|
The socket path configured in the plugin |
Unix Input Configuration Options
editThis plugin supports the following configuration options plus the Common options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
string, one of |
No |
|
Yes |
||
Yes |
Also see Common options for a list of options supported by all input plugins.
data_timeout
edit- Value type is number
-
Default value is
-1
The read timeout in seconds. If a particular connection is idle for more than this timeout period, we will assume it is dead and close it.
If you never want to timeout, use -1.
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
{ "@timestamp" => 2021-11-16T13:20:06.308Z, "file" => { "path" => "/tmp/sock41299" }, "host" => { "name" => "deus-ex-machina" }, "message" => "foo" }
Sample output: ECS disabled
{ "@timestamp" => 2021-11-16T13:20:06.308Z, "path" => "/tmp/sock41299", "host" => "deus-ex-machina", "message" => "foo" }
force_unlink
edit- Value type is boolean
-
Default value is
false
Remove socket file in case of EADDRINUSE failure
mode
edit-
Value can be any of:
server
,client
-
Default value is
"server"
Mode to operate in. server
listens for client connections,
client
connects to a server.
Common options
editThese configuration options are supported by all input plugins:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
codec
edit- Value type is codec
-
Default value is
"line"
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 unix inputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { unix { 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.