rabbitmq

Milestone: 1

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

Relevant links:

Synopsis

This is what it might look like in your config file:
output {
  rabbitmq {
    codec => ... # codec (optional), default: "plain"
    durable => ... # boolean (optional), default: true
    exchange => ... # string (required)
    exchange_type => ... # string, one of ["fanout", "direct", "topic"] (required)
    host => ... # string (required)
    key => ... # string (optional), default: "logstash"
    password => ... # password (optional), default: "guest"
    persistent => ... # boolean (optional), default: true
    port => ... # number (optional), default: 5672
    ssl => ... # boolean (optional), default: false
    user => ... # string (optional), default: "guest"
    verify_ssl => ... # boolean (optional), default: false
    vhost => ... # string (optional), default: "/"
    workers => ... # number (optional), default: 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 config item is deprecated. It may be removed in a further version.
  • 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 (required setting)

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

The name of the exchange

exchange_type (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 config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

host (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 config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • 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.


This is documentation from lib/logstash/outputs/rabbitmq.rb