stomp

Milestone: 2

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

Synopsis

This is what it might look like in your config file: 
output {
  stomp {
    codec => ... # codec (optional), default: "plain"
    debug => ... # boolean (optional), default: false
    destination => ... # string (required)
    host => ... # string (required)
    password => ... # password (optional), default: ""
    port => ... # number (optional), default: 61613
    user => ... # string (optional), default: ""
    vhost => ... # string (optional), default: nil
    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.

debug

  • Value type is boolean
  • Default value is false

Enable debugging output?

destination (required setting)

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

The destination to read events from. Supports string expansion, meaning %{foo} values will expand to the field value.

Example: “/topic/logstash”

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

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

The address of the STOMP server.

password

  • Value type is password
  • Default value is ""

The password to authenticate with.

port

  • Value type is number
  • Default value is 61613

The port to connect to on your STOMP server.

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

  • Value type is string
  • Default value is ""

The username to authenticate with.

vhost

  • Value type is string
  • Default value is nil

The vhost to use

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/stomp.rb