Syslog 输出插件

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

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

安装

编辑

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

获取帮助

编辑

有关插件的问题,请在 Discuss 论坛中发起主题。对于错误或功能请求,请在 Github 中提交问题。有关 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵

描述

编辑

将事件发送到 syslog 服务器。

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

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

Syslog 输出配置选项

编辑

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

设置 输入类型 必填

appname

字符串

facility

字符串

主机

字符串

消息

字符串

msgid

字符串

端口

数字

优先级

字符串

procid

字符串

协议

字符串,以下之一 ["tcp", "udp", "ssl-tcp"]

重连间隔

数字

rfc

字符串,以下之一 ["rfc3164", "rfc5424"]

严重性

字符串

源主机

字符串

ssl_cacert

有效的系统文件路径

ssl_cert

有效的系统文件路径

ssl_key

有效的系统文件路径

ssl_key_passphrase

密码

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,则使用 priority 字段

常见选项

编辑

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

设置 输入类型 必填

编解码器

编解码器

enable_metric

布尔值

ID

字符串

codec

编辑

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

enable_metric

编辑

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

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

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

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

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