rabbitmq

Milestone: 1

Pull events from a RabbitMQ exchange.

The default settings will create an entirely transient queue and listen for all messages by default. If you need durability or any other advanced settings, please set the appropriate options

This has been tested with Bunny 0.9.x, which supports RabbitMQ 2.x and 3.x. You can find links to both here:

Synopsis

This is what it might look like in your config file:
input {
  rabbitmq {
    ack => ... # boolean (optional), default: true
    add_field => ... # hash (optional), default: {}
    arguments => ... # array (optional), default: {}
    auto_delete => ... # boolean (optional), default: false
    codec => ... # codec (optional), default: "plain"
    durable => ... # boolean (optional), default: false
    exchange => ... # string (optional)
    exclusive => ... # boolean (optional), default: false
    host => ... # string (required)
    key => ... # string (optional), default: "logstash"
    passive => ... # boolean (optional), default: false
    password => ... # password (optional), default: "guest"
    port => ... # number (optional), default: 5672
    prefetch_count => ... # number (optional), default: 256
    queue => ... # string (optional), default: ""
    ssl => ... # boolean (optional), default: false
    tags => ... # array (optional)
    threads => ... # number (optional), default: 1
    type => ... # string (optional)
    user => ... # string (optional), default: "guest"
    verify_ssl => ... # boolean (optional), default: false
    vhost => ... # string (optional), default: "/"
  }
}

Details

ack

  • Value type is boolean
  • Default value is true

Enable message acknowledgement

add_field

  • Value type is hash
  • Default value is {}

Add a field to an event

arguments

  • Value type is array
  • Default value is {}

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

auto_delete

  • Value type is boolean
  • Default value is false

Should the queue be deleted on the broker when the last consumer disconnects? Set this option to ‘false’ if you want the queue to remain on the broker, queueing up messages until a consumer comes along to consume them.

charset DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value can be any of: "ASCII-8BIT", "Big5", "Big5-HKSCS", "Big5-UAO", "CP949", "Emacs-Mule", "EUC-JP", "EUC-KR", "EUC-TW", "GB18030", "GBK", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8-U", "Shift_JIS", "US-ASCII", "UTF-8", "UTF-16BE", "UTF-16LE", "UTF-32BE", "UTF-32LE", "Windows-1251", "GB2312", "IBM437", "IBM737", "IBM775", "CP850", "IBM852", "CP852", "IBM855", "CP855", "IBM857", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM869", "Windows-1258", "GB1988", "macCentEuro", "macCroatian", "macCyrillic", "macGreek", "macIceland", "macRoman", "macRomania", "macThai", "macTurkish", "macUkraine", "CP950", "CP951", "stateless-ISO-2022-JP", "eucJP-ms", "CP51932", "GB12345", "ISO-2022-JP", "ISO-2022-JP-2", "CP50220", "CP50221", "Windows-1252", "Windows-1250", "Windows-1256", "Windows-1253", "Windows-1255", "Windows-1254", "TIS-620", "Windows-874", "Windows-1257", "Windows-31J", "MacJapanese", "UTF-7", "UTF8-MAC", "UTF-16", "UTF-32", "UTF8-DoCoMo", "SJIS-DoCoMo", "UTF8-KDDI", "SJIS-KDDI", "ISO-2022-JP-KDDI", "stateless-ISO-2022-JP-KDDI", "UTF8-SoftBank", "SJIS-SoftBank", "BINARY", "CP437", "CP737", "CP775", "IBM850", "CP857", "CP860", "CP861", "CP862", "CP863", "CP864", "CP865", "CP866", "CP869", "CP1258", "Big5-HKSCS:2008", "eucJP", "euc-jp-ms", "eucKR", "eucTW", "EUC-CN", "eucCN", "CP936", "ISO2022-JP", "ISO2022-JP2", "ISO8859-1", "CP1252", "ISO8859-2", "CP1250", "ISO8859-3", "ISO8859-4", "ISO8859-5", "ISO8859-6", "CP1256", "ISO8859-7", "CP1253", "ISO8859-8", "CP1255", "ISO8859-9", "CP1254", "ISO8859-10", "ISO8859-11", "CP874", "ISO8859-13", "CP1257", "ISO8859-14", "ISO8859-15", "ISO8859-16", "CP878", "CP932", "csWindows31J", "SJIS", "PCK", "MacJapan", "ASCII", "ANSI_X3.4-1968", "646", "CP65000", "CP65001", "UTF-8-MAC", "UTF-8-HFS", "UCS-2BE", "UCS-4BE", "UCS-4LE", "CP1251", "external", "locale"
  • There is no default value for this setting.

The character encoding used in this input. Examples include “UTF-8” and “cp1252”

This setting is useful if your log files are in Latin-1 (aka cp1252) or in another character set other than UTF-8.

This only affects “plain” format logs since json is UTF-8 already.

codec

  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, 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 false

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

exchange

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

(Optional) Exchange binding

Optional.

The name of the exchange to bind the queue to.

exclusive

  • Value type is boolean
  • Default value is false

Is the queue exclusive? Exclusive queues can only be used by the connection that declared them and will be deleted when it is closed (e.g. due to a Logstash restart).

format DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value can be any of: "plain", "json", "json_event", "msgpack_event"
  • There is no default value for this setting.

The format of input data (plain, json, json_event)

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"

Optional.

The routing key to use when binding a queue to the exchange. This is only relevant for direct or topic exchanges.

  • Routing keys are ignored on fanout exchanges.
  • Wildcards are not valid on direct exchanges.

message_format DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • There is no default value for this setting.

If format is “json”, an event sprintf string to build what the display @message should be given (defaults to the raw JSON). sprintf format strings look like %{fieldname}

If format is “json_event”, ALL fields except for @type are expected to be present. Not receiving all fields will cause unexpected results.

passive

  • Value type is boolean
  • Default value is false

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

password

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

RabbitMQ password

port

  • Value type is number
  • Default value is 5672

RabbitMQ port to connect on

prefetch_count

  • Value type is number
  • Default value is 256

Prefetch count. Number of messages to prefetch

queue

  • Value type is string
  • Default value is ""

Queue & Consumer

The name of the queue Logstash will consume events from.

ssl

  • Value type is boolean
  • Default value is false

Enable or disable SSL

tags

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

Add any number of arbitrary tags to your event.

This can help with processing later.

threads

  • Value type is number
  • Default value is 1

Set this to the number of threads you want this input to spawn. This is the same as declaring the input multiple times

type

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

Add a ‘type’ field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in the web interface.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

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.


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