https://github.com/inimaz/rabbitmq-describer
See your rabbitmq queues, routing-keys and more in a single interactive graph
https://github.com/inimaz/rabbitmq-describer
cytoscapejs rabbitmq visualisation
Last synced: 4 months ago
JSON representation
See your rabbitmq queues, routing-keys and more in a single interactive graph
- Host: GitHub
- URL: https://github.com/inimaz/rabbitmq-describer
- Owner: inimaz
- License: mit
- Created: 2022-05-08T11:16:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-16T12:21:05.000Z (almost 2 years ago)
- Last Synced: 2025-01-01T07:13:23.515Z (5 months ago)
- Topics: cytoscapejs, rabbitmq, visualisation
- Language: TypeScript
- Homepage:
- Size: 736 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rabbitmq-describer
> Generates a static page that describes the rabbitMQ behavior in a specific app.
It will show a graph with nodes and links, describing which routing keys are being used and which queues are listening to those routing keys.
Very useful to have a graphical overview of a complex rabbitmq system.
# How it works
It will connect to your rabbitMQ management url (default is `http://localhost:15672`) and get the basic metadata of your queues and routing keys. Then it will display the connections in a graph using [Cytoscape.js](https://js.cytoscape.org/), a graphical lib for visualization in graph theory.
# Installation
```
npm install rabbitmq-describer
```
# How to use it
You can serve it with express for instance
```
const rabbitmqDescriber = require('rabbitmq-describer');
const express = require('express')
const app = express()
const port = 3000
app.get('/', (req, res) => {
const html = await rabbitmqDescriber({
user: "guest",
password: "guest",
managementURL: "http://localhost:15672/",
});
res.format({
"text/html": function () {
res.end(html);
},
});
})
app.listen(port, () => {
console.log(`App listening on port ${port}`)
})
```
Save that into `index.js` and run
```
npm start
```
Go to [http://localhost:3000/](http://localhost:3000/) to see the live version description of yout rabbitmq system.
# Example of the output
