Irc 输入插件

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

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

安装

编辑

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

获取帮助

编辑

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

描述

编辑

从 IRC 服务器读取事件。

Irc 输入配置选项

编辑

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

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

 

catch_all

编辑

捕获所有 IRC 频道/用户事件,而不仅仅是频道消息

channels

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

要加入并从中读取消息的频道。

这些应该是包含 # 符号的完整频道名称,例如“#logstash”。

对于带密码的频道,请添加一个空格和频道密码,例如“#logstash password”。

get_stats

编辑

收集并发送频道的用户数量 - 这需要 catch_all 并将强制启用它

host

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

要连接到的 IRC 服务器的主机。

nick

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

IRC 昵称

password

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

IRC 服务器密码

port

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

IRC 服务器的端口

real

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

IRC 真实姓名

secure

编辑

将其设置为 true 以启用 SSL。

stats_interval

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

获取用户数量统计信息的频率(以分钟为单位)

user

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

IRC 用户名

常用选项

编辑

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

设置 输入类型 必填

add_field

哈希

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

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

向事件添加字段

codec

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

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

enable_metric

编辑

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

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

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

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

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

tags

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

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

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

type

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

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

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

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

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