IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Stdout output plugin Syslog output plugin »

› ›

Stomp output plugin

edit

Stomp output plugin

edit

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

For other versions, see the Versioned plugin docs.

Installation

edit

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.

Getting Help

edit

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.

Description

edit

This output writes events using the STOMP protocol.

Stomp Output Configuration Options

edit

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.

`debug`

edit

Value type is boolean
Default value is false

Enable debugging output?

`destination`

edit

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"

`headers`

edit

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}"]

`host`

edit

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

The address of the STOMP server.

`password`

edit

Value type is password
Default value is ""

The password to authenticate with.

`port`

edit

Value type is number
Default value is 61613

The port to connect to on your STOMP server.

`user`

edit

Value type is string
Default value is ""

The username to authenticate with.

`vhost`

edit

Value type is string
Default value is nil

The vhost to use

Common Options

edit

The following configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

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

`enable_metric`

edit

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.

`id`

edit

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"
  }
}

« Stdout output plugin Syslog output plugin »