Syslog 输入编辑

[8.14.0] 已弃用 8.14.0。

Syslog 输入已被弃用。请使用 syslog 处理器来处理 syslog 消息。

syslog 输入通过 TCP、UDP 或 Unix 流套接字读取 RFC 3164 和 RFC 5424 指定的 Syslog 事件。

示例配置

filebeat.inputs:
- type: syslog
  format: rfc3164
  protocol.udp:
    host: "localhost:9000"
filebeat.inputs:
- type: syslog
  format: rfc5424
  protocol.tcp:
    host: "localhost:9000"
filebeat.inputs:
- type: syslog
  format: auto
  protocol.unix:
    path: "/path/to/syslog.sock"

配置选项编辑

syslog 输入配置包括格式、特定于协议的选项以及稍后描述的 通用选项

format编辑

要使用的 syslog 变体,rfc3164rfc5424。要从日志条目中自动检测格式,请将此选项设置为 auto。默认值为 rfc3164

timezone编辑

解析不包含时区的 syslog 时间戳时使用的 IANA 时区名称(例如 America/New_York)或固定时间偏移量(例如 +0200)。可以指定 Local 来使用机器的本地时区。默认为 Local

协议 udp编辑

max_message_size编辑

通过 UDP 接收的消息的最大大小。默认为 10KiB

host编辑

要侦听事件流的主机和 UDP 端口。

read_buffer编辑

UDP 套接字上读取缓冲区的大小。如果未指定,将使用操作系统的默认值。

timeout编辑

套接字操作的读写超时时间。默认为 5m

协议 tcp编辑

max_message_size编辑

通过 TCP 接收的消息的最大大小。默认为 20MiB

host编辑

要侦听事件流的主机和 TCP 端口。

framing编辑

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

line_delimiter编辑

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

max_connections编辑

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

timeout编辑

关闭远程连接之前不活动秒数。默认为 300s

ssl编辑

SSL 参数的配置选项,例如要使用的证书、密钥和证书颁发机构。

有关更多信息,请参阅 SSL

协议 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编辑

关闭连接之前不活动秒数。默认为 300s

有关更多信息,请参阅 SSL

通用选项编辑

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

enabled编辑

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

tags编辑

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

示例

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

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

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

如果此选项设置为 true,则自定义 fields 将作为顶级字段存储在输出文档中,而不是分组在 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