xmpp

Status: beta

This input allows you to receive events over XMPP/Jabber.

This plugin can be used for accepting events from humans or applications 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:

input {
  xmpp {
    add_field => ... # hash (optional), default: {}
    debug => ... # boolean (optional)
    format => ... # ["plain", "json", "json_event"] (optional)
    host => ... # string (optional)
    message_format => ... # string (optional)
    password => ... # password (required)
    rooms => ... # array (optional)
    tags => ... # array (optional)
    type => ... # string (required)
    user => ... # string (required)
  }
}

Details

add_field

• Value type is hash
• Default value is {}

Add a field to an event

debug

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

Set to true to enable greater debugging in XMPP. Useful for debugging network/authentication erros.

format

• Value can be any of: "plain", "json", "json_event"
• There is no default value for this setting.

The format of input data (plain, json, json_event)

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_format

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

If format is "json", an event sprintf string to build what the display @message should be given (defaults to the raw JSON). sprintf format strings look like %{fieldname} or %{@metadata}.

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

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

Add any number of arbitrary tags to your event.

This can help with processing later.

type (required setting)

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

Label this input with a type. Types are used mainly for filter activation.

If you create an input with type "foobar", then only filters which also have type "foobar" will act on them.

The type is also stored as part of the event itself, so you can also use the type to search for in the web interface.

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/inputs/xmpp.rb