xmpp

Status: beta

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 {
    host => ... # string (optional)
    message => ... # string (required)
    password => ... # password (required)
    tags => ... # array (optional), default: []
    targets => ... # array (required)
    type => ... # string (optional), default: ""
    user => ... # string (required)
  }
}

Details

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 %{@source_host}

password (required setting)

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

The xmpp password for the user/identity.

tags

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

targets (required setting)

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

The targets to send messages to (users, chat rooms, etc)

type

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

---

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