rabbitmq
editrabbitmq
edit- Version: 4.0.6
- Released on: January 17, 2017
- Changelog
Getting Help
editFor 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.
Description
editPush events to a RabbitMQ exchange. Requires RabbitMQ 2.x or later version (3.x is recommended).
Relevant links:
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
rabbitmq { exchange => ... exchange_type => ... host => ... }
Available configuration options:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
Yes |
||
string, one of |
Yes |
|
No |
||
Yes |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
a valid filesystem path |
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"}
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
"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.
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
true
Is this exchange durable? (aka; Should it survive a broker restart?)
enable_metric
edit- 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.
exchange
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
The name of the exchange
exchange_type
edit- This is a required setting.
-
Value can be any of:
fanout
,direct
,topic
,x-consistent-hash
,x-modulus-hash
- There is no default value for this setting.
The exchange type (fanout, topic, direct)
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.
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.
id
edit- 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 grok filters.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { stdout { id => "my_plugin_id" } }
key
edit- Value type is string
-
Default value is
"logstash"
The default codec for this plugin is JSON. You can override this to suit your particular needs however. Key to route to by default. Defaults to logstash
- Routing keys are ignored on fanout exchanges.
passive
edit- Value type is boolean
-
Default value is
false
Passive queue creation? Useful for checking queue existance without modifying server state
persistent
edit- Value type is boolean
-
Default value is
true
Should RabbitMQ persist messages to disk?
ssl
edit- 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_password
edit- 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_path
edit- 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
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