› ›

Xmpp 输出插件

编辑

Xmpp 输出插件

编辑

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

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

安装

编辑

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

获取帮助

编辑

如有关于插件的问题，请在 Discuss 论坛中发帖。如发现错误或有功能请求，请在 Github 中提交 issue。如需查看 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。当您有两个或多个相同类型的插件时，这尤其有用。例如，如果您有两个 xmpp 输出。在这种情况下，添加命名 ID 将有助于在使用监控 API 监控 Logstash 时提供帮助。

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

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

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