This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Pipe output plugin Redis output plugin »

› ›

Rabbitmq output plugin

edit

Rabbitmq output plugin

edit

A component of the rabbitmq integration plugin
Integration version: v7.4.0
Released on: 2024-09-16
Changelog

For other versions, see the Versioned plugin docs.

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

Push events to a RabbitMQ exchange. Requires RabbitMQ 2.x or later version (3.x is recommended).

Relevant links:

Rabbitmq Output Configuration Options

edit

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

Setting	Input type	Required
`arguments`	array	No
`automatic_recovery`	boolean	No
`connect_retry_interval`	number	No
`connection_timeout`	number	No
`durable`	boolean	No
`exchange`	string	Yes
`exchange_type`	string, one of `["fanout", "direct", "topic", "x-consistent-hash", "x-modulus-hash"]`	Yes
`heartbeat`	number	No
`host`	string	Yes
`key`	string	No
`message_properties`	hash	No
`passive`	boolean	No
`password`	password	No
`persistent`	boolean	No
`port`	number	No
`ssl`	boolean	No
`ssl_certificate_password`	string	No
`ssl_certificate_path`	a valid filesystem path	No
`ssl_version`	string	No
`user`	string	No
`vhost`	string	No

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

`arguments`

edit

Value type is array
Default value is {}

Extra queue arguments as an array. To make a RabbitMQ queue mirrored, use: {"x-ha-policy" => "all"}

`automatic_recovery`

edit

Value type is boolean
Default value is true

Set this to automatically recover from a broken connection. You almost certainly don’t want to override this!!!

`connect_retry_interval`

edit

Value type is number
Default value is 1

Time in seconds to wait before retrying a connection

`connection_timeout`

edit

Value type is number
There is no default value for this setting.

The default connection timeout in milliseconds. If not specified the timeout is infinite.

`durable`

edit

Value type is boolean
Default value is true

Is this exchange durable? (aka; Should it survive a broker restart?)

`exchange`

edit

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

The name of the exchange

`exchange_type`

edit

This is a required setting.
Value can be any of: fanout, direct, topic, x-consistent-hash, x-modulus-hash
There is no default value for this setting.

The exchange type (fanout, topic, direct)

`heartbeat`

edit

Value type is number
There is no default value for this setting.

Heartbeat delay in seconds. If unspecified no heartbeats will be sent

`host`

edit

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

Common functionality for the rabbitmq input/output RabbitMQ server address(es) host can either be a single host, or a list of hosts i.e. host ⇒ "localhost" or host ⇒ ["host01", "host02]

if multiple hosts are provided on the initial connection and any subsequent recovery attempts of the hosts is chosen at random and connected to. Note that only one host connection is active at a time.

`key`

edit

Value type is string
Default value is "logstash"

The default codec for this plugin is JSON. You can override this to suit your particular needs however. Key to route to by default. Defaults to logstash

Routing keys are ignored on fanout exchanges.

`message_properties`

edit

Value type is hash
Default value is {}

Add properties to be set per-message here, such as content_type, priority. Values can be sprintf templates, whose value for each message will be populated from the event.

Example:

    message_properties => {
      "content_type" => "application/json"
      "priority" => 1
    }

`passive`

edit

Value type is boolean
Default value is false

Passive queue creation? Useful for checking queue existance without modifying server state

`password`

edit

Value type is password
Default value is "guest"

RabbitMQ password

`persistent`

edit

Value type is boolean
Default value is true

Should RabbitMQ persist messages to disk?

`port`

edit

Value type is number
Default value is 5672

RabbitMQ port to connect on

`ssl`

edit

Value type is boolean
There is no default value for this setting.

Enable or disable SSL. Note that by default remote certificate verification is off. Specify ssl_certificate_path and ssl_certificate_password if you need certificate verification

`ssl_certificate_password`

edit

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

Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certificate_path

`ssl_certificate_path`

edit

Value type is path
There is no default value for this setting.

Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote host

`ssl_version`

edit

Value type is string
Default value is "TLSv1.2"

Version of the SSL protocol to use.

`user`

edit

Value type is string
Default value is "guest"

RabbitMQ username

`vhost`

edit

Value type is string
Default value is "/"

The vhost (virtual host) to use. If you don’t know what this is, leave the default. With the exception of the default vhost ("/"), names of vhosts should not begin with a forward slash.

Common options

edit

These 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 "json"

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 rabbitmq outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  rabbitmq {
    id => "my_plugin_id"
  }
}

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

« Pipe output plugin Redis output plugin »