rabbitmq
editrabbitmq
edit
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
rabbitmq { host => ... subscription_retry_interval_seconds => ... }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|||
No |
|
||
No |
|||
No |
|
||
No |
|||
Yes |
|||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
Yes |
|
||
No |
|||
No |
|
||
No |
|||
No |
|
||
No |
|
||
No |
|
Details
edit
arguments
edit- 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
edit- 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_recovery
edit- 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!!!
codec
edit- Value type is codec
-
Default value is
"json"
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.
connect_retry_interval
edit- Value type is number
-
Default value is
1
Time in seconds to wait before retrying a connection
connection_timeout
edit- 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.
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
false
Is this queue durable? (aka; Should it survive a broker restart?)
exchange
edit- Value type is string
- There is no default value for this setting.
The name of the exchange to bind the queue to.
exclusive
edit- 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).
heartbeat
edit- Value type is number
- There is no default value for this setting.
Heartbeat delay in seconds. If unspecified no heartbeats will be sent
host
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
RabbitMQ server address
key
edit- 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.
passive
edit- Value type is boolean
-
Default value is
false
Passive queue creation? Useful for checking queue existance without modifying server state
prefetch_count
edit- Value type is number
-
Default value is
256
Prefetch count. Number of messages to prefetch
queue
edit- Value type is string
-
Default value is
""
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.
subscription_retry_interval_seconds
edit- 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
tags
edit- 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.
type
edit- 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 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.