RabbitMQ Variable Shovel
RabbitMQ vShovel is a WAN-friendly tool for moving messages from a queue residing on an AMQP source broker, to a remote endpoint of any desired type, such as an HTTP endpoint.
Each endpoint is an implementation of the rabbit_vshovel_endpoint behaviour. The following message shovelling operations and protocol endpoints are currently supported, with more to be introduced as the plugin further grows:
- AMQP 0.9.1 (RabbitMQ) to an AMQP 0.9.1 endpoint.
- AMQP 0.9.1 to an HTTP 1.1 endpoint.
Supported RabbitMQ Versions
This plugin is compatible with RabbitMQ 3.5.x and 3.6.x.
Usage
Packaging
Download pre-compiled versions from https://github.com/cloudamqp/rabbitmq-vshovel/releases
Build
Clone and build the plugin by executing make. To create a package, execute make dist and find the .ez package file in the plugins directory.
Configuration
1. Dynamic configuration
Unix
rabbitmqctl set_parameter vshovel my-vshovel \
'{"src-uri": "amqp://fred:[email protected]/my_vhost",
"src-queue": "my-queue", "dest-type":"http",
"dest-uri":"http://remote-host1.domain", "dest-vsn": "1.1",
"dest-args": {"method": "post", "keep_alive_timeout" : 10000}}'
Windows
rabbitmqctl set_parameter vshovel my-vshovel ^
"{""src-uri"": ""amqp://fred:[email protected]/my_vhost"", ^
""src-queue"": ""my-queue"", ""dest-type"":""http"", ^
""dest-uri"":""http://remote-host1.domain"", ""dest-vsn"": ""1.1"", ^
""dest-args"": {""method"": ""post"", ""keep_alive_timeout"":10000}}"
2. Static configuration
[{rabbitmq_vshovel,
[{vshovels,
[{my_first_vshovel,
[{sources,
[{brokers,
["amqp://harry:[email protected]/my_vhost",
"amqp://john:[email protected]/my_vhost"]},
{arguments,
[{declarations,
[{'exchange.declare',
[{exchange, <<"my_fanout">>},
{type, <<"fanout">>},
durable]},
{'queue.declare',
[{arguments,
[{<<"x-message-ttl">>, long, 60000}]}]},
{'queue.bind',
[{exchange, <<"my_direct">>},
{queue, <<>>}]}
]}]}]},
{destinations,
[{protocol, http},
{address, "https://56.12.331.123/server"},
{arguments, [{keepalive, 10},
{method, post},
{ssl, []}]}]},
{queue, <<>>},
{prefetch_count, 10},
{ack_mode, on_confirm},
{publish_properties, [{delivery_mode, 2}]},
{add_forward_headers, true},
{publish_fields, [{exchange, <<"my_direct">>},
{routing_key, <<"from_shovel">>}]},
{reconnect_delay, 5}]}
]}
]}].
3. Verification
Once configured, verify status of the shovel using the following command (on a Unix-like OS):
rabbitmqctl eval 'rabbit_vshovel_status:status().'
and on Windows;
rabbitmqctl eval "rabbit_vshovel_status:status()."
License and Copyright
(c) 84codes AB and Erlang Solutions Ltd. 2016-2017