It uses the RabbitMQ management plugin API to query multiple endpoints: overview, queues, exchanges, bindings, consumers, and producers - then parses the data to re-pipe it into a D3 app. The app is meant to focus on traffic flowing into the system and show which exchanges are getting hit and how hard.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
We have pre-built packages available for Windows, MacOSX, Linux. Please visit AliceMQ download page.
For MacOSX and Linux platforms, please ensure to have git and npm installed.
If you want build your own electron app, please follow the following instruction.
git clone https://github.com/alicelabs/alicemq.git
cd alicemq
npm run buildapp
For platform specific build:
npm run buildappwin
npm run buildappmac
npm run buildapplinux
Once the command finishes, please find the executable electron app in its subfolder. The app is specific built for the platform which you are running.
To help you test the app is working correctly with your RabbitMQ server, we provide you with AliceMQ testing suite. It is a series of producer and consumer scripts that can simulate all types of RabbitMQ messages: Direct, Topic, Header and Fanout. Please see detailed instruction on its readme.
Since the current script is built for electron app, the web app may not work out of the box. Please modify
## Main.jsx - Change isWeb false to true ##
isWeb: true
## Run Script ##
npm run web
AliceMQ suppports both local and cloud RabbitMQ instance like AWS. If you have problem with connection please check:
- Check internet connectivity.
- RabbitMQ server is running.
- Double check username and password to log into RabbitMQ.
- Ensure RabbitMQ port is correct, open and forward.
- Still having issues, continue reading below.
When accessing the rabbitmq API remotely on a network, you'll need to whitelist your ip to allow for cross origin fetching. Check out this page on how to setup configure file
If running on AWS EC2 server:
- SSH into your EC2 server.
- Edit your RabbitMQ config file.
- Edit EC2 security group to open RabbitMQ port in inbound rules.
If you'd like to modify the color legend ranges to better suit your RabbitMQ instance's throughput. Two simple modifications need to be made.
## /client/Components/Legend.jsx ##
let ranges = [['0', '#bdbdbd'], ['1-50', '#b9f6ca'], ['50-150', '#ffeb3b'], ['150-500', '#f9a825'], ['500-2000', '#ff5722'] , ['> 2000', '#b71c1c']]
The ranges are static values in the 1st element of the sub arrays
## /client/Components/NetworkGraph.jsx ##
function setRateColor(rate){
let lineColor = '';
if (rate === 0) { lineColor = '#bdbdbd' }
else if (rate > 0 && rate <= 50) { lineColor = '#b9f6ca' }
else if (rate > 50 && rate <= 150) { lineColor = '#ffeb3b' }
else if (rate > 150 && rate <= 500) { lineColor = '#f9a825' }
else if (rate > 500 && rate <= 2000) { lineColor = '#ff5722' }
else if (rate > 2000) { lineColor = '#b71c1c' }
return lineColor;
}
Be sure to have the static ranges in the Legend component match in the setRateColor function and you're all set.
- React - Framework used
- Electron - Build cross-platform application
- D3 - Used to draw graphs
- RabbitMQ - Message broker and underlining technology
v1.0.1
Anthony Valentin, Christian Niedermayer, Parket Allen, Siye Sam Yu