logstash
logstash

stomp

Status: beta

Synopsis

This is what it might look like in your config file:
input {
  stomp {
    add_field => ... # hash (optional), default: {}
    debug => ... # boolean (optional)
    destination => ... # string (required)
    format => ... # ["plain", "json", "json_event"] (optional)
    host => ... # string (required), default: "localhost"
    message_format => ... # string (optional)
    password => ... # password (optional), default: ""
    port => ... # number (optional), default: 61613
    tags => ... # array (optional)
    type => ... # string (required)
    user => ... # string (optional), default: ""
  }
}

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.

Enable debugging output?

destination (required setting)

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

The destination to read events from.

Example: "/topic/logstash"

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

  • Value type is string
  • Default value is "localhost"

The address of the STOMP server.

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

  • Value type is password
  • Default value is ""

The password to authenticate with.

port

  • Value type is number
  • Default value is 61613

The port to connet to on your STOMP server.

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

  • Value type is string
  • Default value is ""

The username to authenticate with.


This is documentation from lib/logstash/inputs/stomp.rb