﻿---
title: Stomp output plugin
description: Plugin version: v3.0.9 (Other versions), Released on: 2018-04-06, Changelog. For questions about the plugin, open a topic in the Discuss forums. For bugs...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/lsr/plugins-outputs-stomp
---

# Stomp output plugin
- Plugin version: v3.0.9 ([Other versions](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/output-stomp-index))
- Released on: 2018-04-06
- [Changelog](https://github.com/logstash-plugins/logstash-output-stomp/blob/v3.0.9/CHANGELOG.md)


## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-output-stomp). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

This output writes events using the STOMP protocol.

## Stomp Output Configuration Options

This plugin supports the following configuration options plus the [Common options](#plugins-outputs-stomp-common-options) described later.

| Setting                                                          | Input type                                                                       | Required |
|------------------------------------------------------------------|----------------------------------------------------------------------------------|----------|
| [`debug`](#plugins-outputs-stomp-debug)`debug`                   | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`destination`](#plugins-outputs-stomp-destination)`destination` | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | Yes      |
| [`headers`](#plugins-outputs-stomp-headers)`headers`             | [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)hash             | No       |
| [`host`](#plugins-outputs-stomp-host)`host`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | Yes      |
| [`password`](#plugins-outputs-stomp-password)`password`          | [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)password | No       |
| [`port`](#plugins-outputs-stomp-port)`port`                      | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number       | No       |
| [`user`](#plugins-outputs-stomp-user)`user`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |
| [`vhost`](#plugins-outputs-stomp-vhost)`vhost`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |

Also see [Common options](#plugins-outputs-stomp-common-options) for a list of options supported by all output plugins.

### `debug`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `false`

Enable debugging output?

### `destination`

- This is a required setting.
- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- This is a required setting.
- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

The address of the STOMP server.

### `password`

- Value type is [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)
- Default value is `""`

The password to authenticate with.

### `port`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `61613`

The port to connect to on your STOMP server.

### `user`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `""`

The username to authenticate with.

### `vhost`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `nil`

The vhost to use

## Common options

These configuration options are supported by all output plugins:

| Setting                                                                | Input type                                                                    | Required |
|------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`codec`](#plugins-outputs-stomp-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#plugins-outputs-stomp-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#plugins-outputs-stomp-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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"
  }
}
```