rmq-cluster-rebalance 1.0.0

Description:

rmqclusterrebalance 1.0.0

CLI application for rebalancing queues in a RabbitMQ cluster


Installation
pip install rmq-cluster-rebalance


Why?
When you specify the queue master location in RabbitMQ
with value of min-masters, RabbitMQ will attempt to balance the distribution
of the master locations for queues across the cluster. However, when you restart
a RabbitMQ node in a cluster with HA queues, the master location for a queue on that
node will move to a different node. Given enough such events and depending on your HA
policies, you can end up with an uneven distribution of queues with a master location
on a minority of nodes. In this scenario, the nodes in cluster may not be utilized
as evenly, with higher CPU, memory, disk, and network utilization on nodes that
carry the larger quantity of master nodes.
Rebalancing queues across nodes can also be useful when adding nodes to a cluster
with no queue_master_locator configuration set (which uses the default value of
client-local), regardless of whether you use HA queues or not.


Methodology
The application use the RabbitMQ management UI to iterate through each queue
in the cluster. The queue is inspected and a policy named rmq-cluster-rebalance
is created using the existing policy configuration used by the queue with the
addition or replacement of ha-mode, setting it to all and removing ha-params
and queue-master-locator if they are set. Once the queue has fully replicated
across all nodes in the cluster, the rmq-cluster-rebalance policy is replaced
with a new policy that setting ha-mode to nodes and specifying only the
new master node in ha-params. When the queue has fully moved, the policy will
then removed and the application will move on to the next queue.
Nodes are assigned in a simple round-robin ordering. If a queue is already living
on the node where it would be assigned to, it will be skipped and no work is
performed on that queue.


Warning
This approach should be safe for production use without interruption of publishers
or consumers. While it has worked for me without issue, your mileage may vary.
This application requires a relatively current version of RabbitMQ and was only
tested with 3.7.16.


CLI Usage
usage: rmq-cluster-rebalance [-h] [-u USERNAME] [-p PASSWORD] [--vhost VHOST]
[-L LOG_FILE] [-v] [--debug] [--version]
[URL]

Rebalances the queues in a RabbitMQ cluster

positional arguments:
URL The RabbitMQ Management API base URL (default:
http://localhost:15672)

optional arguments:
-h, --help show this help message and exit
-u USERNAME, --username USERNAME
The RabbitMQ Management API username (default: guest)
-p PASSWORD, --password PASSWORD
The RabbitMQ Management API password (default: guest)
--vhost VHOST The RabbitMQ VHost to use (default: /)
--version output version information, then exit

Logging options:
-L LOG_FILE, --log-file LOG_FILE
Log to the specified filename (default: STDOUT)
-v, --verbose Increase output verbosity (default: False)
--debug Extra verbose debug logging (default: False)