xmppedit
- Version: 3.0.2
- Released on: July 14, 2016
- Changelog
Getting Helpedit
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Descriptionedit
This output allows you ship events over XMPP/Jabber.
This plugin can be used for posting events to humans over XMPP, or you can use it for PubSub or general message passing for logstash to logstash.
Synopsisedit
This plugin supports the following configuration options:
Required configuration options:
xmpp {
message => ...
password => ...
user => ...
}
Available configuration options:
Detailsedit
codecedit
- Value type is codec
-
Default value is
"plain"
The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.
enable_metricedit
- Value type is boolean
-
Default value is
true
Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
hostedit
- Value type is string
- There is no default value for this setting.
The xmpp server to connect to. This is optional. If you omit this setting, the host on the user/identity is used. (foo.com for user@foo.com)
idedit
- Value type is string
- There is no default value for this setting.
Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one.
It is strongly recommended to set this ID in your configuration. This is particularly useful
when you have two or more plugins of the same type, for example, if you have 2 grok filters.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output {
stdout {
id => "my_plugin_id"
}
}
messageedit
- This is a required setting.
- Value type is string
- There is no default value for this setting.
The message to send. This supports dynamic strings like %{host}
passwordedit
- This is a required setting.
- Value type is password
- There is no default value for this setting.
The xmpp password for the user/identity.
roomsedit
- Value type is array
- There is no default value for this setting.
if muc/multi-user-chat required, give the name of the room that you want to join: room@conference.domain/nick
useredit
- This is a required setting.
- Value type is string
- There is no default value for this setting.
The user or resource ID, like foo@example.com.