Xmpp output plugin

edit
  • Plugin version: v3.0.8
  • Released on: 2018-04-06
  • Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-xmpp. See Working with plugins for more details.

Getting Help

edit

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.

Description

edit

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.

Xmpp Output Configuration Options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting Input type Required

host

string

No

message

string

Yes

password

password

Yes

rooms

array

No

user

string

Yes

users

array

No

Also see Common Options for a list of options supported by all output plugins.

 

host

edit
  • 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)

message

edit
  • 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}

password

edit
  • This is a required setting.
  • Value type is password
  • There is no default value for this setting.

The xmpp password for the user/identity.

rooms

edit
  • 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

user

edit
  • 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.

users

edit
  • Value type is array
  • There is no default value for this setting.

The users to send messages to

Common Options

edit

The following configuration options are supported by all output plugins:

Setting Input type Required

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

edit
  • 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_metric

edit
  • 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.

  • 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 xmpp outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.