Syslog 输出插件编辑

  • 插件版本:v3.0.5
  • 发布时间:2018-04-06
  • 更新日志

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

安装编辑

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

获取帮助编辑

有关插件的问题,请在论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 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

密码

ssl_verify

布尔值

use_labels

布尔值

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

 

appname编辑

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

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

facility编辑

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

syslog 消息的设施标签默认回退到用户级别,如 rfc3164 中所示。新值可以包含 %{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

连接失败时,重试间隔(以秒为单位)。

rfc编辑

  • 值可以是以下任何一项:rfc3164rfc5424
  • 默认值为"rfc3164"

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

severity编辑

syslog 消息的严重性标签默认回退到通知,如 rfc3164 中所示。新值可以包含 %{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编辑

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

通用选项编辑

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

设置 输入类型 必需

enable_metric

布尔值

id

字符串

enable_metric编辑

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

id编辑

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

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

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

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