› ›

Unix 输入插件

编辑

Unix 输入插件编辑

插件版本：v3.1.2
发布时间：2022-10-03
更新日志

有关其他版本，请参阅版本化插件文档。

获取帮助编辑

如果您对该插件有任何疑问，请在论坛中发帖。如有错误或功能请求，请在Github中提交问题。有关 Elastic 支持的插件列表，请参阅Elastic 支持矩阵。

描述编辑

通过 UNIX 套接字读取事件。

与stdin和file输入一样，每个事件都被假定为一行文本。

可以接受来自客户端的连接，也可以连接到服务器，具体取决于mode。

与 Elastic 通用架构 (ECS) 的兼容性编辑

此插件添加了有关事件来源的额外字段。如果您想确保这些字段与ECS兼容，请配置ecs_compatibility选项。

这些字段是在事件由相应的编解码器解码后添加的，不会覆盖现有值。

ECS 已禁用	ECS v1、v8	描述
`host`	`[host][name]`	处理事件的 Logstash 主机的名称
`path`	`[file][path]`	插件中配置的套接字路径

Unix 输入配置选项编辑

此插件支持以下配置选项以及稍后描述的通用选项。

设置	输入类型	是否必需
`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`编辑

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

当模式为server时，为要侦听的路径。当模式为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。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时，例如，如果您有两个 unix 输入，这将特别有用。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

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

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

`tags`编辑

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

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

这有助于以后的处理。

`type`编辑

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

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

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

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

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

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

Unix 输入插件

Unix 输入插件编辑

获取帮助编辑

描述编辑

与 Elastic 通用架构 (ECS) 的兼容性编辑

Unix 输入配置选项编辑

data_timeout编辑

ecs_compatibility编辑

force_unlink编辑

mode编辑

path编辑

socket_not_present_retry_interval_seconds编辑