xmpp

Milestone: 2

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.

Synopsis

This is what it might look like in your config file:

output {
  xmpp {
    codec => ... # codec (optional), default: "plain"
    host => ... # string (optional)
    message => ... # string (required)
    password => ... # password (required)
    rooms => ... # array (optional)
    user => ... # string (required)
    users => ... # array (optional)
    workers => ... # number (optional), default: 1
  }
}

Details

codec

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

exclude_tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

host

• 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 (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 (required setting)

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

The xmpp password for the user/identity.

rooms

• 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

tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

user (required setting)

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

The user or resource ID, like foo@example.com.

users

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

The users to send messages to

workers

• Value type is number
• Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

---

This is documentation from lib/logstash/outputs/xmpp.rb