› ›

Xmpp 输入插件

编辑

Xmpp 输入插件

编辑

插件版本：v3.1.7
发布日期：2018-04-06
变更日志

其他版本，请查看版本化插件文档。

安装

编辑

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

获取帮助

编辑

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

描述

编辑

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

此插件可用于接收来自人类或应用程序 XMPP 的事件，或者您可以将其用于 PubSub 或 Logstash 之间的通用消息传递。

Xmpp 输入配置选项

编辑

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

设置	输入类型	必填
`host`	字符串	否
`password`	password	是
`rooms`	数组	否
`user`	字符串	是

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

`host`

编辑

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

要连接的 xmpp 服务器。这是可选的。如果您省略此设置，则使用 user/identity 上的主机。（对于 [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`

编辑

值类型为 codec
默认值为 "plain"

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

`enable_metric`

编辑

值类型为布尔值
默认值为 true

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

这可以帮助以后的处理。

`type`

编辑

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

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

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

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

如果您尝试在已经拥有类型的事件上设置类型（例如，当您将事件从发件人发送到索引器时），那么新的输入将不会覆盖现有类型。即使发送到另一个 Logstash 服务器，在发件人处设置的类型也会在整个事件生命周期中保留。

« Wmi 输入插件输出插件 »