设置	输入类型	必需
`data_timeout`	数字	否
`ecs_compatibility`	字符串	否
`force_unlink`	布尔值	否
`mode`	字符串，其中之一为 `["server", "client"]`	否
`path`	字符串	是
`socket_not_present_retry_interval_seconds`	数字	是

另请参见常用选项，了解所有输入插件支持的选项列表。

`data_timeout`

编辑

值类型为数字
默认值为 -1

以秒为单位的读取超时。如果特定连接空闲时间超过此超时时间段，我们将假定它已断开并关闭它。

如果您不想超时，请使用 -1。

`ecs_compatibility`

编辑

值类型为字符串
支持的值为
- disabled：使用向后兼容的字段名称，例如 [host]
- v1, v8：使用与 ECS 兼容的字段，例如 [host][name]

控制此插件与 Elastic 通用架构 (ECS) 的兼容性。有关详细信息，请参见与 Elastic 通用架构 (ECS) 的兼容性。

示例输出：ECS 已启用

{
    "@timestamp" => 2021-11-16T13:20:06.308Z,
    "file" => {
      "path" => "/tmp/sock41299"
    },
    "host" => {
      "name" => "deus-ex-machina"
    },
    "message" => "foo"
}

示例输出：ECS 已禁用

{
    "@timestamp" => 2021-11-16T13:20:06.308Z,
    "path" => "/tmp/sock41299",
    "host" => "deus-ex-machina",
    "message" => "foo"
}

`force_unlink`

编辑

值类型为布尔值
默认值为 false

在出现 EADDRINUSE 错误时删除套接字文件

`mode`

编辑

值可以是：server, client
默认值为 "server"

操作模式。server 监听客户端连接，client 连接到服务器。

`path`

编辑

此设置是必需的。
值类型为字符串
此设置没有默认值。

当 mode 为 server 时，为监听的路径。当 mode 为 client 时，为连接到的路径。

`socket_not_present_retry_interval_seconds`

编辑

此设置是必需的。
值类型为数字
默认值为 5

以秒为单位的时间，如果套接字文件不存在，则等待此时间后再重试。仅允许正值。

此设置仅在 mode 为 client 时使用。

常用选项

编辑

所有输入插件都支持这些配置选项

设置	输入类型	必需
`add_field`	哈希表	否
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	数组	否
`type`	字符串	否

`add_field`

编辑

值类型为哈希表
默认值为 {}

向事件添加字段

`codec`

编辑

值类型为编解码器
默认值为 "line"

用于输入数据的编解码器。输入编解码器是在数据进入输入之前对其进行解码的便捷方法，无需在 Logstash 管道中使用单独的过滤器。

`enable_metric`

编辑

值类型为布尔值
默认值为 true

禁用或启用此特定插件实例的指标日志记录，默认情况下我们会记录所有可以记录的指标，但您可以为特定插件禁用指标收集。

`id`

编辑

值类型为字符串
此设置没有默认值。

向插件配置添加唯一的 ID。如果没有指定 ID，Logstash 将生成一个。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 unix 输入。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

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

id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

`tags`

编辑

值类型为数组
此设置没有默认值。

向您的事件添加任意数量的标签。

这可以帮助以后的处理。

`type`

编辑

值类型为字符串
此设置没有默认值。

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分，因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已经具有类型的事件上设置类型（例如，当您将事件从发送程序发送到索引程序时），则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器，在发送程序中设置的类型也会一直保留在该事件中。

« Udp 输入插件 Varnishlog 输入插件 »