Skip to content
This repository has been archived by the owner on Nov 16, 2020. It is now read-only.
/ rabbitmq-top Public archive

Adds top-like information on the Erlang VM to the management plugin.

License

Unknown, MPL-2.0 licenses found

Licenses found

Unknown
LICENSE
MPL-2.0
LICENSE-MPL-RabbitMQ
Notifications You must be signed in to change notification settings

rabbitmq/rabbitmq-top

RabbitMQ Top Plugin

This repository has been moved to the main unified RabbitMQ "monorepo", including all open issues. You can find the source under /deps/rabbitmq_top. All issues have been transferred.

Introduction

Adds UNIX top-like information on the Erlang VM to the management UI. The closest interactive CLI alternative in recent releases is rabbitmq-diagnostics observer.

This is what it looks like:

Installation

This plugin ships with RabbitMQ as of 3.6.3. Enable it with

# use sudo as necessary
rabbitmq-plugins enable rabbitmq_top

RabbitMQ 3.5.x

You can download a pre-built binary of this plugin for RabbitMQ 3.5.x from RabbitMQ Community plugins page.

Usage

Sort by process ID, memory use or reductions/sec (an approximate measure of CPU use).

Click on the process description (e.g. "my queue") to see that object's management view.

Click on the process ID (e.g. "<0.3423.0>") to see some more Erlang process details.

See Memory Use Analysis guide on RabbitMQ website for more information.

HTTP API

You can drive the HTTP API yourself. It installs into the management plugin's API; you should understand that first. Once you do, the additional paths look like:

/api/top/<node-name>

List of processes. Takes similar query string parameters to other lists, sort, sort_reverse and columns. Sorting is quite important as it currently hard-codes returning the top 20 processes.

/api/process/<pid>

Individual process details.

More Screenshots

Individual process metrics are also available:

Building from Source

You can build and install it like any other plugin (see the plugin development guide).

License and Copyright

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

Released under the same license as RabbitMQ.