rabbitmq

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

Relevant links:

 

Synopsis

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

durable

boolean

No

true

exchange

string

Yes

exchange_type

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

Yes

host

string

Yes

key

string

No

"logstash"

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

 

codec

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

debug (DEPRECATED)

  • 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

  • Value type is boolean
  • Default value is true

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

exchange

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

The name of the exchange

exchange_type

  • This is a required setting.
  • Value can be any of: fanout, direct, topic
  • There is no default value for this setting.

Exchange

The exchange type (fanout, topic, direct)

exclude_tags (DEPRECATED)

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

host

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

Connection

RabbitMQ server address

key

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

Key to route to by default. Defaults to logstash

  • Routing keys are ignored on fanout exchanges.

password

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

RabbitMQ password

persistent

  • Value type is boolean
  • Default value is true

Should RabbitMQ persist messages to disk?

port

  • Value type is number
  • Default value is 5672

RabbitMQ port to connect on

ssl

  • Value type is boolean
  • Default value is false

Enable or disable SSL

tags (DEPRECATED)

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

type (DEPRECATED)

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

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s type attribute for more. Optional.

user

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

RabbitMQ username

verify_ssl

  • Value type is boolean
  • Default value is false

Validate SSL certificate

vhost

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

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

workers

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