New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« pipe rackspace »
Elastic Docs ›Logstash Reference [5.0] ›Output plugins

rabbitmq

edit

rabbitmq

edit

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

Relevant links:

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

rabbitmq {
    exchange => ...
    exchange_type => ...
    host => ...
}

Available configuration options:

Setting Input type Required Default value

arguments

array

No

{}

automatic_recovery

boolean

No

true

codec

codec

No

"json"

connect_retry_interval

number

No

1

connection_timeout

number

No

durable

boolean

No

true

exchange

string

Yes

exchange_type

string, one of ["fanout", "direct", "topic"]

Yes

heartbeat

number

No

host

string

Yes

key

string

No

"logstash"

passive

boolean

No

false

password

password

No

"guest"

persistent

boolean

No

true

port

number

No

5672

ssl

boolean

No

false

user

string

No

"guest"

verify_ssl

boolean

No

false

vhost

string

No

"/"

workers

number

No

1

Details

edit

 

arguments

edit
  • Value type is array
  • Default value is {}

automatic_recovery

edit
  • Value type is boolean
  • Default value is true

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.

connect_retry_interval

edit
  • Value type is number
  • Default value is 1

connection_timeout

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

debug (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is boolean
  • Default value is false

Enable or disable logging

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

host

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

key

edit
  • Value type is string
  • Default value is "logstash"

Key to route to by default. Defaults to logstash

  • Routing keys are ignored on fanout exchanges.

passive

edit
  • Value type is boolean
  • Default value is false

password

edit
  • Value type is password
  • Default value is "guest"

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

ssl

edit
  • Value type is boolean
  • Default value is false

user

edit
  • Value type is string
  • Default value is "guest"

verify_ssl

edit
  • Value type is boolean
  • Default value is false

Validate SSL certificate

vhost

edit
  • Value type is string
  • Default value is "/"

The vhost to use. If you don’t know what this is, leave the default.

workers

edit
  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

« pipe rackspace »