:plugin: stomp
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Stomp output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

This output writes events using the STOMP protocol.

[id="plugins-{type}s-{plugin}-options"]
==== Stomp Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-debug>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-destination>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-headers>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-vhost>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-debug"]
===== `debug` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

Enable debugging output?

[id="plugins-{type}s-{plugin}-destination"]
===== `destination` 

  * This is a required setting.
  * Value type is <<string,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"

[id="plugins-{type}s-{plugin}-headers"]
===== `headers` 

  * Value type is <<hash,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}"]

[id="plugins-{type}s-{plugin}-host"]
===== `host` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The address of the STOMP server.

[id="plugins-{type}s-{plugin}-password"]
===== `password` 

  * Value type is <<password,password>>
  * Default value is `""`

The password to authenticate with.

[id="plugins-{type}s-{plugin}-port"]
===== `port` 

  * Value type is <<number,number>>
  * Default value is `61613`

The port to connect to on your STOMP server.

[id="plugins-{type}s-{plugin}-user"]
===== `user` 

  * Value type is <<string,string>>
  * Default value is `""`

The username to authenticate with.

[id="plugins-{type}s-{plugin}-vhost"]
===== `vhost` 

  * Value type is <<string,string>>
  * Default value is `nil`

The vhost to use



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]