Syslog 输出插件

编辑
  • 插件版本: v3.0.5
  • 发布日期: 2018-04-06
  • 更新日志

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

安装

编辑

对于默认未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-syslog 轻松安装。有关详细信息,请参阅使用插件

获取帮助

编辑

有关插件的问题,请在Discuss论坛中开设一个主题。对于错误或功能请求,请在Github中打开一个 issue。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵

描述

编辑

将事件发送到 Syslog 服务器。

您可以使用 UDP 或 TCP 作为传输协议,发送符合 RFC3164 或 RFC5424 的消息。

默认情况下,message 字段的内容将作为发出的 Syslog 消息的自由格式消息文本部分发送。如果您的消息没有 message 字段,或者由于某些其他原因要更改发出的消息,请修改 message 配置选项。

Syslog 输出配置选项

编辑

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

设置 输入类型 必需

appname

字符串

facility

字符串

host

字符串

message

字符串

msgid

字符串

port

数字

priority

字符串

procid

字符串

protocol

字符串,可以是 ["tcp", "udp", "ssl-tcp"] 中的一个

reconnect_interval

数字

rfc

字符串,可以是 ["rfc3164", "rfc5424"] 中的一个

severity

字符串

sourcehost

字符串

ssl_cacert

有效的文件系统路径

ssl_cert

有效的文件系统路径

ssl_key

有效的文件系统路径

ssl_key_passphrase

password

ssl_verify

布尔值

use_labels

布尔值

另请参阅通用选项,其中列出了所有输出插件支持的选项。

 

appname

编辑
  • 值类型为字符串
  • 默认值为 "LOGSTASH"

Syslog 消息的应用程序名称。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

facility

编辑
  • 值类型为字符串
  • 默认值为 "user-level"

Syslog 消息的 facility 标签,默认回退为 rfc3164 中的 user-level。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

host

编辑
  • 这是一个必需的设置。
  • 值类型为字符串
  • 此设置没有默认值。

要连接的 Syslog 服务器地址

message

编辑
  • 值类型为字符串
  • 默认值为 "%{message}"

要记录的消息文本。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

msgid

编辑

Syslog 消息的消息 ID。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

port

编辑
  • 这是一个必需的设置。
  • 值类型为数字
  • 此设置没有默认值。

要连接的 Syslog 服务器端口

priority

编辑
  • 值类型为字符串
  • 默认值为 "%{syslog_pri}"

Syslog 优先级。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

procid

编辑

Syslog 消息的进程 ID。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

protocol

编辑
  • 值可以是:tcpudpssl-tcp 中的任何一个
  • 默认值为 "udp"

Syslog 服务器协议。您可以选择 udp、tcp 和通过 tcp 的 ssl/tls

reconnect_interval

编辑
  • 值类型为数字
  • 默认值为 1

当连接失败时,重试间隔(秒)。

  • 值可以是:rfc3164rfc5424 中的任何一个
  • 默认值为 "rfc3164"

Syslog 消息格式:您可以选择 rfc3164 或 rfc5424

severity

编辑
  • 值类型为字符串
  • 默认值为 "notice"

Syslog 消息的严重性标签,默认回退为 rfc3164 中的 notice。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

sourcehost

编辑
  • 值类型为字符串
  • 默认值为 "%{host}"

Syslog 消息的源主机。新值可以包含 %{foo} 字符串,以帮助您从事件的其他部分构建新值。

ssl_cacert

编辑
  • 值类型为路径
  • 此设置没有默认值。

SSL CA 证书、链文件或 CA 路径。系统 CA 路径会自动包含。

ssl_cert

编辑
  • 值类型为路径
  • 此设置没有默认值。

SSL 证书路径

ssl_key

编辑
  • 值类型为路径
  • 此设置没有默认值。

SSL 密钥路径

ssl_key_passphrase

编辑
  • 值类型为密码
  • 默认值为 nil

SSL 密钥密码

ssl_verify

编辑

根据 CA 验证 SSL 连接另一端的身份。

use_labels

编辑

使用标签解析严重性和 facility 级别,如果设置为 false 则使用优先级字段

通用选项

编辑

所有输出插件都支持这些配置选项

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑
  • 值类型为 codec
  • 默认值为 "plain"

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

enable_metric

编辑

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

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

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

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

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