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

xmpp

edit

xmpp

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.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

host

string

No

message

string

Yes

password

password

Yes

rooms

array

No

user

string

Yes

users

array

No

workers

number

No

1

Details

edit

 

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.

exclude_tags (DEPRECATED)

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

Only handle events without any of these tags. Optional.

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])

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

tags (DEPRECATED)

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

Only handle events with all of these tags. Optional.

type (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • 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

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

users

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

The users to send messages to

workers

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

« websocket zabbix »