Syslog 输入插件

编辑

对于其他版本,请参阅版本化的插件文档

获取帮助

编辑

有关插件的问题,请在Discuss论坛中开一个主题。对于错误或功能请求,请在Github中开一个 issue。有关 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 输入的 integer→label 映射。

提供一个零索引数组,其中包含所有设施标签,按顺序排列。如果日志消息包含没有相应条目的设施编号,则不会将 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

哈希

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

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

向事件添加字段

codec

编辑

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

enable_metric

编辑

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

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

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

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

id 字段中的变量替换仅支持环境变量,不支持使用来自 secret store 的值。

tags

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

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

这有助于以后的处理。

type

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

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

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

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

如果您尝试在已经具有类型的事件上设置类型(例如,当您将事件从发货人发送到索引器时),则新的输入将不会覆盖现有类型。在发货人处设置的类型在该事件的生命周期内都会保留,即使发送到另一台 Logstash 服务器也是如此。