IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« websocket zenoss »
Elastic Docs ›Logstash Reference [2.0] ›Logstash Reference ›Input plugins

xmpp

edit

xmpp

edit

load the MUC Client anyway, its mocked in testing 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

edit

This plugin supports the following configuration options:

Required configuration options:

xmpp {
    password => ...
    user => ...
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

codec

codec

No

"plain"

host

string

No

password

password

Yes

rooms

array

No

tags

array

No

type

string

No

user

string

Yes

Details

edit

 

add_field

edit
  • Value type is hash
  • Default value is {}

Add a field to an event

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

debug (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is boolean
  • Default value is false

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

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 [email protected])

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: [email protected]/nick

tags

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

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

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

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

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 [email protected].

« websocket zenoss »