Syslog 输入插件编辑

  • 插件版本:v3.7.0
  • 发布时间:2023-10-17
  • 更新日志

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

获取帮助编辑

如果您对插件有任何疑问,请在论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵

描述编辑

通过网络读取 syslog 消息作为事件。

如果您现在已经在使用 syslog,那么此输入是一个不错的选择。如果您想从无法运行自己的日志收集器的设备和网络设备接收日志,那么它也是一个不错的选择。

当然,*syslog* 是一个非常模糊的术语。默认情况下,此输入仅支持进行了一些小修改的 RFC3164 syslog。但是,如果提供了有效的 grok_pattern,则可以读取和解析某些非标准 syslog 格式。日期格式仍然只允许使用 RFC3164 样式或 ISO8601

有关更多信息,请参阅RFC3164 页面

注意:此输入将在 TCP 和 UDP 上启动侦听器。

Syslog 输入配置选项编辑

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

另请参阅通用选项,以获取所有输入插件支持的选项列表。

 

ecs_compatibility编辑

  • 值类型为字符串
  • 支持的值为

    • disabled:不使用与 ECS 兼容的字段名称(例如,syslog 优先级的 priority
    • v1v8:使用与 Elastic Common Schema 兼容的字段(例如,[log][syslog][priority]
  • 默认值取决于运行的 Logstash 版本

    • 当 Logstash 提供 pipeline.ecs_compatibility 设置时,其值将用作默认值
    • 否则,默认值为 disabled

控制此插件与Elastic Common Schema (ECS)的兼容性。

facility_labels编辑

  • 值类型为数组
  • 默认值为 ["kernel", "user-level", "mail", "system", "security/authorization", "syslogd", "line printer", "network news", "UUCP", "clock", "security/authorization", "FTP", "NTP", "log audit", "log alert", "clock", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7"]

RFC3164 中定义的设施级别的标签。

您可以使用此选项覆盖与 RFC 行为不同的 syslog 输入的整数→标签映射。

提供一个零索引数组,其中包含所有设施标签*按顺序*排列。如果日志消息包含没有对应条目的设施编号,则不会将 facility_label 添加到事件中。

grok_pattern编辑

  • 值类型为字符串
  • 默认值为 "<%{POSINT:priority}>%{SYSLOGLINE}"
  • 默认值取决于是否启用了ecs_compatibility

    • ECS 兼容性已禁用:"<%{POSINT:priority}>%{SYSLOGLINE}"
    • ECS 兼容性已启用:"<%{POSINT:[log][syslog][priority]:int}>%{SYSLOGLINE}"

默认值应读取并正确解析完全符合RFC3164的 syslog 行。

您可以覆盖此值,以使用有效的 grok 模式解析非标准行,该模式将解析接收到的行。如果无法解析该行,则会添加 _grokparsefailure_sysloginput 标签。

grok 模式必须提供 timestamp 字段。如果省略了 timestamp 字段,或者无法将其解析为 RFC3164 样式或 ISO8601,则会添加 _dateparsefailure 标签。

host编辑

  • 值类型为字符串
  • 默认值为 "0.0.0.0"

要侦听的地址。

locale编辑

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

使用 IETF-BCP47 或 POSIX 语言标签指定用于日期解析的区域设置。简单的例子是 BCP47 的 enen-US 或 POSIX 的 en_US。如果未指定,则将使用平台默认值。

通常,需要设置区域设置才能解析月份名称(带有 MMM 的模式)和星期几名称(带有 EEE 的模式)。

port编辑

  • 值类型为数字
  • 默认值为 514

要侦听的端口。请记住,小于 1024 的端口(特权端口)可能需要 root 权限才能使用。

proxy_protocol编辑

代理协议支持,目前仅支持 v1 http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt

severity_labels编辑

  • 值类型为数组
  • 默认值为 ["Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Informational", "Debug"]

RFC3164 中定义的严重性级别的标签。

提供一个零索引数组,其中包含所有严重性标签*按顺序*排列。如果日志消息包含没有对应条目的严重性标签,则不会将 severity_label 添加到事件中。

syslog_field编辑

  • 值类型为字符串
  • 默认值为 "message"

编解码器在解析其余数据之前处理数据。某些编解码器(如 CEF)在预处理数据后将 syslog 数据放入另一个字段。在这种情况下,请将此选项与 grok_pattern 配置结合使用,以允许 syslog 输入插件完全解析 syslog 数据。

input {
  syslog {
    port => 12345
    codec => cef
    syslog_field => "syslog"
    grok_pattern => "<%{POSINT:priority}>%{SYSLOGTIMESTAMP:timestamp} CUSTOM GROK HERE"
  }
}

timezone编辑

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

指定用于日期解析的时区规范 ID。有效 ID 列在 [Joda.org 可用时区页面](http://joda-time.sourceforge.net/timezones.html) 上。如果无法从值中提取时区,并且该时区不是平台默认值,则此选项很有用。如果未指定,则将使用平台默认值。规范 ID 很好,因为它会为您处理夏令时。例如,America/Los_AngelesEurope/Paris 是有效的 ID。

use_labels编辑

对严重性和设施级别使用标签解析。

通用选项编辑

以下配置选项受所有输入插件支持

设置 输入类型 是否必需

add_field

哈希

编解码器

编解码器

enable_metric

布尔值

ID

字符串

标签

数组

类型

字符串

详细信息编辑

 

add_field编辑

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

向事件添加字段

codec编辑

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

enable_metric编辑

默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集。

id编辑

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

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

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

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

tags编辑

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

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

这有助于以后的处理。

type编辑

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

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

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

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

如果您尝试在已有类型的事件上设置类型(例如,当您将事件从传送器发送到索引器时),则新输入不会覆盖现有类型。在传送器上设置的类型会伴随该事件的整个生命周期,即使将其发送到另一个 Logstash 服务器也是如此。