Lumberjack 输入插件

编辑
  • 插件版本:v3.1.6
  • 发布日期:2019-04-15
  • 变更日志

其他版本,请参见 版本化插件文档

安装

编辑

对于非默认捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-input-lumberjack轻松安装。更多详情,请参见 使用插件

获取帮助

编辑

如有任何关于插件的问题,请在 Discuss 论坛中发帖提问。如有任何错误或功能请求,请在 Github 中创建一个 Issue。如需查看 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵

描述

编辑

使用 Lumberjack 协议接收事件。

此输入插件可用于在 Logstash 实例之间可靠且安全地传输事件。为此,请在发送 Logstash 实例中使用 lumberjack 输出插件

它还可以用于接收来自已弃用的 logstash-forwarder 工具的事件,该工具已被 Filebeat 替代。

建议改用 Beats 输入插件。Beats 输入插件实现了 Lumberjack 协议 v1 和 v2。

Lumberjack 输入配置选项

编辑

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

设置 输入类型 必填

congestion_threshold

数字

host

字符串

port

数字

ssl_certificate

有效的系统文件路径

ssl_key

有效的系统文件路径

ssl_key_passphrase

密码

另请参见 通用选项,了解所有输入插件支持的选项列表。

 

congestion_threshold

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

在引发超时之前等待的秒数,此选项可用于控制在某些内容阻塞管道时等待的时间。

host

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

要监听的 IP 地址。

port

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

要监听的端口。

ssl_certificate

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

要使用的 SSL 证书。

ssl_key

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

要使用的 SSL 密钥。

ssl_key_passphrase

编辑
  • 值类型为 密码
  • 此设置没有默认值。

要使用的 SSL 密钥密码。

通用选项

编辑

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

设置 输入类型 必填

add_field

哈希表

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

编辑

向事件添加字段

codec

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

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

enable_metric

编辑

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

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

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

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

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

tags

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

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

这可以帮助以后进行处理。

type

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

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

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

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

如果您尝试在已经有一个类型的事件上设置类型(例如,当您将事件从发送方发送到索引器时),则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器,在发送方设置的类型也会一直保留在该事件中。