Generate rabbit-mq documentation tool

100 views
Skip to first unread message

Kathe Rogova

unread,
Nov 6, 2019, 9:24:45 AM11/6/19
to rabbitmq-users
Hi there,

My name is Kathe, and I'm a newbie here.
I really wonder if there are any tools to generate the documentation about Rabbit MQ usage in the project?
Analogically, as we have documentation generators for API.

Thank you so much in advance for your help.
I'm looking forward to getting any reply as soon as possible!

Best wishes,
Kathe

Wesley Peng

unread,
Nov 6, 2019, 9:46:02 AM11/6/19
to rabbitm...@googlegroups.com
Kathe

Rabbit MQ is well documented on its official website.
What tool you have for documentation API?


Kathe Rogova <kathe....@gmail.com>于2019年11月6日 周三下午10:24写道:
--
You received this message because you are subscribed to the Google Groups "rabbitmq-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rabbitmq-user...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/rabbitmq-users/97b57ffa-6bc3-4ce2-9953-9a45249ee7a2%40googlegroups.com.

Kathe Rogova

unread,
Nov 7, 2019, 4:28:57 AM11/7/19
to rabbitmq-users
Hi Wesley,

Thank you for your reply.
However, I've meant not the documentation about how Rabbit MQ works and how to set it up.

I'd like to get the tool which helps to visualize all the exchanges and queues we have in our project and generate it into the text file with the description and examples.

So, in case if you have some suggestions, please, let me know.

Thank you in advance.

Best wishes,
Kathe



среда, 6 ноября 2019 г., 17:46:02 UTC+3 пользователь Wesley Peng написал:
Kathe

Rabbit MQ is well documented on its official website.
What tool you have for documentation API?


Kathe Rogova <kathe...@gmail.com>于2019年11月6日 周三下午10:24写道:
Hi there,

My name is Kathe, and I'm a newbie here.
I really wonder if there are any tools to generate the documentation about Rabbit MQ usage in the project?
Analogically, as we have documentation generators for API.

Thank you so much in advance for your help.
I'm looking forward to getting any reply as soon as possible!

Best wishes,
Kathe

--
You received this message because you are subscribed to the Google Groups "rabbitmq-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rabbitm...@googlegroups.com.

Wesley Peng

unread,
Nov 7, 2019, 4:34:46 AM11/7/19
to rabbitm...@googlegroups.com
Kathe Rogova wrote:
>
> I'd like to get the tool which helps to visualize all the exchanges and
> queues we have in our project and generate it into the text file with
> the description and examples.
>

May you take a look at this one?
https://jmcle.github.io/rabbitmq-visualizer/

regards.

Kathe Rogova

unread,
Nov 7, 2019, 7:20:05 AM11/7/19
to rabbitmq-users
Wesley,

Thank you so much for your reply.

Anyway, as I can see... I need to put all the data (exchanges, queues, and etc.) to this visualizer manually, right?
Or could you help me please what way it's possible to get the project's data from your Rabbit MQ settings - thank you!

By the way, may be it's possible to get the report like this (please, look at the example for API in the attachment).

Best regards,
Kathe


четверг, 7 ноября 2019 г., 12:34:46 UTC+3 пользователь Wesley Peng написал:
pict123.PNG

Wesley Peng

unread,
Nov 7, 2019, 8:30:55 PM11/7/19
to rabbitm...@googlegroups.com
Kathe Rogova wrote:
> Anyway, as I can see... I need to put all the data (exchanges, queues,
> and etc.) to this visualizer manually, right?
> Or could you help me please what way it's possible to get the project's
> data from your Rabbit MQ settings - thank you!
>
> By the way, may be it's possible to get the report like this (please,
> look at the example for API in the attachment).
>

Kathe,

I have no experience on using this tool.
But can you check their sources to see how to deal with it?
https://github.com/jmcle/rabbitmq-visualizer

You can dump rabbitmq's metadata (exchange, queues etc) via HTTP API,
this can be done automatic with a script.

Regards.

Kathe Rogova

unread,
Nov 12, 2019, 4:51:59 AM11/12/19
to rabbitmq-users
Hi Wesley,

Thank you so much for all the replies I've received from you.

We will find out if this service is helpful for our case to get the documentation about the processes of working with Rabbit MQ in our project.

Have a nice day.

Best regards,
Kathe

пятница, 8 ноября 2019 г., 4:30:55 UTC+3 пользователь Wesley Peng написал:
Reply all
Reply to author
Forward
0 new messages