› ›

Xmpp 输出插件

编辑

Xmpp 输出插件

编辑

插件版本: v3.0.8
发布日期: 2018-04-06
更新日志

对于其他版本，请参阅版本化的插件文档。

安装

编辑

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

获取帮助

编辑

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

描述

编辑

此输出允许您通过 XMPP/Jabber 发送事件。

此插件可用于通过 XMPP 将事件发布给人类，或者您可以使用它进行 PubSub 或用于 Logstash 到 Logstash 的常规消息传递。

Xmpp 输出配置选项

编辑

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

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

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

`host`

编辑

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

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

`message`

编辑

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

要发送的消息。这支持动态字符串，例如 %{host}

`password`

编辑

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

用户/身份的 xmpp 密码。

`rooms`

编辑

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

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

`user`

编辑

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

用户或资源 ID，例如 [email protected]。

`users`

编辑

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

要将消息发送到的用户

通用选项

编辑

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

设置	输入类型	必需
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否

`codec`

编辑

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

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

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

« Websocket 输出插件 Zabbix 输出插件 »