Loading

Stomp output plugin

  • Plugin version: v3.0.9
  • Released on: 2018-04-06
  • Changelog

For other versions, see the Versioned plugin docs.

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-stomp. See Working with plugins for more details.

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

This output writes events using the STOMP protocol.

This plugin supports the following configuration options plus the Common options described later.

Setting Input type Required
debug boolean No
destination string Yes
headers hash No
host string Yes
password password No
port number No
user string No
vhost string No

Also see Common options for a list of options supported by all output plugins.

  • Value type is boolean
  • Default value is false

Enable debugging output?

  • This is a 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"

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

Custom headers to send with each message. Supports string expansion, meaning %{{foo}} values will expand to the field value.

Example: headers ⇒ ["amq-msg-type", "text", "host", "%{{host}}"]

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

The address of the STOMP server.

  • Value type is password
  • Default value is ""

The password to authenticate with.

  • Value type is number
  • Default value is 61613

The port to connect to on your STOMP server.

  • Value type is string
  • Default value is ""

The username to authenticate with.

  • Value type is string
  • Default value is nil

The vhost to use

These configuration options are supported by all output plugins:

Setting Input type Required
codec codec No
enable_metric boolean No
id string No
  • 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.

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 stomp outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  stomp {
    id => "my_plugin_id"
  }
}
Note

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.