Xmpp 输入插件

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

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

安装

编辑

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

获取帮助

编辑

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

描述

编辑

此输入允许您通过 XMPP/Jabber 接收事件。

此插件可用于接受来自人类或应用程序 XMPP 的事件,或者您可以将其用于 PubSub 或通用的消息传递,以实现 logstash 到 logstash 的日志记录。

Xmpp 输入配置选项

编辑

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

设置 输入类型 必需

host

字符串

password

password

rooms

数组

user

字符串

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

 

host

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

要连接的 xmpp 服务器。这是可选的。如果省略此设置,则使用用户/身份上的主机。([email protected]foo.com

password

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

用户/身份的 xmpp 密码。

rooms

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

如果需要 muc/多用户聊天,请提供您要加入的房间的名称:[email protected]/nick

user

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

用户或资源 ID,如 [email protected]

通用选项

编辑

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

设置 输入类型 必需

add_field

哈希

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

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

向事件添加字段

codec

编辑

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

enable_metric

编辑

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

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

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

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

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

tags

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

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

这有助于以后的处理。

type

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

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

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

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

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