rabbitmq / support-tools

A staging area for various support and troubleshooting tools that are not (or not yet) included into RabbitMQ distribution

RabbitMQ Support and Troubleshooting Extras

This repository contains tools that are not yet ready to be included into RabbitMQ distribution, cannot be a plugin or cannot ship with RabbitMQ for any other reason:

• rabbitmq-collect-env - Linux/POSIX: collects RabbitMQ and selected OS logs, system-level metrics and other environment information (iostat, kernel limits and similar) that is not always directly related to RabbitMQ but can provide additional insights about the overall state of the node

• rabbitmq-collect-env.ps1 - Windows: collects RabbitMQ logs, system-level information and other environment information that can provide additional insights about the overall state of the node

• rebalance-queue-masters: given a RabbitMQ cluster with unevenly spread queue masters, this script will rebalance queue masters evenly, across all RabbitMQ nodes in the cluster

Copyright & License

(c) VMware, Inc or its affiliates. 2007-2023

See LICENSE.

support-tools's Issues

Port rabbitmq-collect-env to Windows

Use Powershell, of course.

rabbitmq-collect-env should probably skip certificate files

Files ending in these extensions:

• .pem
• .crt
• .p12
• ???

cc @michaelklishin

rabbitmq-collect-env should grab info out of erl_crash.dump

rebalance-queue-masters -r regex option causes an error after having processed all matching queues

The error :
20220222-13:49:28 [INFO] Updating queue master for queue '' from '' to 'rabbit@rabbitmq2'
20220222-13:49:28 [INFO] Error (argument validation): Invalid options for this command:
-ha-temp :
Arguments given:
set_policy -p EasyClip.PostProcess --priority 990 --apply-to queues -ha-temp ^$ {"ha-mode":"exactly","ha-params":1}

The regex match result includes an empty line (=>empty queue name).

Improvements to "Reporting RabbitMQ Issues" and support docs

https://github.com/rabbitmq/support-tools/blob/master/docs/Reporting_RabbitMQ_Issues.md

• Does this document live in the "correct" place? Should it be part of the website?
• Should there be recommendations for getting support, i.e -
  • monitoring is required
  • log history is required
• Each bullet point in the "reporting issues" could give a rationale for the information, and tips for collecting it.
• A document or flow-chart with how to diagnose issues could be added (runbooks)

rabbitmq-collect-env should grab conf.d files

For example:

  Config file(s): /var/vcap/jobs/rabbitmq-server/etc/advanced.config
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/10-clusterDefaults.conf
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/11-tlsConfig.conf
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/12-managementConfig.conf
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/13-oAuth.conf
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/14-webSTOMP.conf
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/15-webMQTT.conf
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/16-stream.conf
                  /var/vcap/jobs/rabbitmq-server/etc/conf.d/50-overrideConfig.conf

rabbitmq-collect-env should run "epmd -names"

`rabbitmq-collect-env` should support k8s environments

rebalance-queue-masters fails silently

When I run the script, it silently fails at line 141 (after #19). I am not sure if this happens to you as well, but I had to change the line as below to make it work.

-    (( total_queue_count += node_queue_count ))
+    total_queue_count=$(( total_queue_count += node_queue_count ))

I am running bash 4.4 on Alpine (if that makes a difference).

bash-4.4# bash --version
GNU bash, version 4.4.19(1)-release (x86_64-alpine-linux-musl)
Copyright (C) 2016 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
bash-4.4# 

Environment summary file

When rabbitmq-collect-env creates its archive there should be a top-level file that has the most important info in it:

• Hostname
• IP Address(es)
• RabbitMQ version
• Erlang version