Rabbitmq input pluginedit

  • Plugin version: v5.2.5
  • Released on: 2017-08-18
  • Changelog

Installationedit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-input-rabbitmq. See Working with plugins for more details.

Getting Helpedit

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.

Descriptionedit

Pull events from a RabbitMQ queue.

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 plugin uses the March Hare library for interacting with the RabbitMQ server. Most configuration options map directly to standard RabbitMQ and AMQP concepts. The AMQP 0-9-1 reference guide and other parts of the RabbitMQ documentation are useful for deeper understanding.

The properties of messages received will be stored in the [@metadata][rabbitmq_properties] field if the @metadata_enabled setting is checked. Note that storing metadata may degrade performance. The following properties may be available (in most cases dependent on whether they were set by the sender):

  • app-id
  • cluster-id
  • consumer-tag
  • content-encoding
  • content-type
  • correlation-id
  • delivery-mode
  • exchange
  • expiration
  • message-id
  • priority
  • redeliver
  • reply-to
  • routing-key
  • timestamp
  • type
  • user-id

For example, to get the RabbitMQ message’s timestamp property into the Logstash event’s @timestamp field, use the date filter to parse the [@metadata][rabbitmq_properties][timestamp] field:

filter {
  if [@metadata][rabbitmq_properties][timestamp] {
    date {
      match => ["[@metadata][rabbitmq_properties][timestamp]", "UNIX"]
    }
  }
}

Additionally, any message headers will be saved in the [@metadata][rabbitmq_headers] field.

Rabbitmq Input Configuration Optionsedit

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

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

 

ackedit

  • Value type is boolean
  • Default value is true

Enable message acknowledgements. With acknowledgements messages fetched by Logstash but not yet sent into the Logstash pipeline will be requeued by the server if Logstash shuts down. Acknowledgements will however hurt the message throughput.

This will only send an ack back every prefetch_count messages. Working in batches provides a performance boost here.

argumentsedit

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

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

automatic_recoveryedit

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

  • Value type is number
  • Default value is 1

Time in seconds to wait before retrying a connection

connection_timeoutedit

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

durableedit

  • Value type is boolean
  • Default value is false

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

exchangeedit

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

The name of the exchange to bind the queue to. Specify exchange_type as well to declare the exchange if it does not exist

exchange_typeedit

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

The type of the exchange to bind to. Specifying this will cause this plugin to declare the exchange if it does not exist.

exclusiveedit

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

heartbeatedit

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

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

hostedit

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

keyedit

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

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.

metadata_enablededit

  • Value type is boolean
  • Default value is false

Enable the storage of message headers and properties in @metadata. This may impact performance

passiveedit

  • Value type is boolean
  • Default value is false

If true the queue will be passively declared, meaning it must already exist on the server. To have Logstash create the queue if necessary leave this option as false. If actively declaring a queue that already exists, the queue options for this plugin (durable etc) must match those of the existing queue.

passwordedit

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

RabbitMQ password

portedit

  • Value type is number
  • Default value is 5672

RabbitMQ port to connect on

prefetch_countedit

  • Value type is number
  • Default value is 256

Prefetch count. If acknowledgements are enabled with the ack option, specifies the number of outstanding unacknowledged messages allowed.

queueedit

  • Value type is string
  • Default value is ""

The properties to extract from each message and store in a @metadata field.

Technically the exchange, redeliver, and routing-key properties belong to the envelope and not the message but we ignore that distinction here. However, we extract the headers separately via get_headers even though the header table technically is a message property.

Freezing all strings so that code modifying the event’s @metadata field can’t touch them.

If updating this list, remember to update the documentation above too. The default codec for this plugin is JSON. You can override this to suit your particular needs however. The name of the queue Logstash will consume events from. If left empty, a transient queue with an randomly chosen name will be created.

ssledit

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

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

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

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

Version of the SSL protocol to use.

subscription_retry_interval_secondsedit

  • This is a required setting.
  • Value type is number
  • Default value is 5

Amount of time in seconds to wait after a failed subscription request before retrying. Subscribes can fail if the server goes away and then comes back.

threadsedit

  • Value type is number
  • Default value is 1

tls_certificate_password (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • There is no default value for this setting.

TLS certificate password

tls_certificate_path (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is path
  • There is no default value for this setting.

TLS certifcate path

useredit

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

RabbitMQ username

vhostedit

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

The following configuration options are supported by all input plugins:

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

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

enable_metricedit

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

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

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

tagsedit

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

typeedit

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

This is the base class for Logstash inputs. 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 Kibana.

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.