Unix 输入编辑

此功能处于测试阶段,可能会发生变化。其设计和代码不如正式的 GA 功能成熟,按原样提供,不作任何保证。测试版功能不受正式 GA 功能支持 SLA 的约束。

使用 unix 输入可以通过面向流的 Unix 域套接字读取事件。

配置示例

filebeat.inputs:
- type: unix
  max_message_size: 10MiB
  path: "/var/run/filebeat.sock"

配置选项编辑

unix 输入支持以下配置选项以及稍后描述的通用选项

max_message_size编辑

通过套接字接收到的消息的最大大小。默认值为 20MiB

path编辑

将接收事件的 Unix 套接字的路径。

socket_type编辑

将接收事件的 Unix 套接字的类型。有效值为 streamdatagram。默认值为 stream

group编辑

Filebeat 将创建的 Unix 套接字的组所有权。默认值为运行 Filebeat 的用户的首选组名称。在 Windows 上,将忽略此选项。

mode编辑

Filebeat 将创建的 Unix 套接字的文件模式。这应该是以八进制字符串表示的文件模式。默认值为系统默认值(通常为 0755)。

framing编辑

指定用于拆分传入事件的成帧方式。可以是 delimiterrfc6587delimiter 使用 line_delimiter 中指定的字符来拆分传入事件。 rfc6587 支持 RFC6587 中描述的八位字节计数和非透明成帧。 line_delimiter 用于在非透明成帧中拆分事件。默认值为 delimiter

line_delimiter编辑

指定用于拆分传入事件的字符。默认值为 \n

max_connections编辑

在任何给定时间点最多接受的连接数。

timeout编辑

关闭连接之前的 inactivate 秒数。默认值为 300s

有关更多信息,请参阅SSL

指标编辑

此输入在HTTP 监控端点下公开指标。这些指标在 /inputs 路径下公开。它们可用于观察输入的活动。

指标 说明

path

Unix 套接字的路径。

received_events_total

已接收到的数据包(事件)总数。

received_bytes_total

接收到的字节总数。

arrival_period

连续数据包之间的时间直方图(以纳秒为单位)。

processing_time

处理数据包所花费的时间直方图(以纳秒为单位)。

通用选项编辑

所有输入均支持以下配置选项。

enabled编辑

使用 enabled 选项可以启用和禁用输入。默认情况下,enabled 设置为 true。

tags编辑

Filebeat 包含在每个已发布事件的 tags 字段中的标记列表。标记可以轻松地在 Kibana 中选择特定事件或在 Logstash 中应用条件过滤。这些标记将附加到常规配置中指定的标记列表中。

示例

filebeat.inputs:
- type: unix
  . . .
  tags: ["json"]
fields编辑

您可以指定可选字段来向输出添加更多信息。例如,您可以添加可用于过滤日志数据的字段。字段可以是标量值、数组、字典或它们的任何嵌套组合。默认情况下,您在此处指定的字段将分组在输出文档的 fields 子字典下。要将自定义字段存储为顶级字段,请将 fields_under_root 选项设置为 true。如果在常规配置中声明了重复字段,则其值将被此处声明的值覆盖。

filebeat.inputs:
- type: unix
  . . .
  fields:
    app_id: query_engine_12
fields_under_root编辑

如果此选项设置为 true,则自定义 字段 将作为顶级字段存储在输出文档中,而不是分组在 fields 子字典下。如果自定义字段名称与 Filebeat 添加的其他字段名称冲突,则自定义字段会覆盖其他字段。

processors编辑

要应用于输入数据的处理器列表。

有关在配置中指定处理器的详细信息,请参阅处理器

pipeline编辑

要为此输入生成的事件设置的摄取管道 ID。

管道 ID 也可以在 Elasticsearch 输出中配置,但此选项通常会导致配置文件更简单。如果在输入和输出中都配置了管道,则使用输入中的选项。

keep_null编辑

如果此选项设置为 true,则值为 null 的字段将在输出文档中发布。默认情况下,keep_null 设置为 false

index编辑

如果存在,则此格式字符串会覆盖此输入的事件索引(对于 elasticsearch 输出),或设置事件元数据的 raw_index 字段(对于其他输出)。此字符串只能引用代理名称和版本以及事件时间戳;要访问动态字段,请使用 output.elasticsearch.index 或处理器。

示例值:"%{[agent.name]}-myindex-%{+yyyy.MM.dd}" 可能会扩展为 "filebeat-myindex-2019.11.01"

publisher_pipeline.disable_host编辑

默认情况下,所有事件都包含 host.name。可以将此选项设置为 true 以禁用将此字段添加到所有事件中。默认值为 false