Node.js Interface for RabbitMQ Management Statistics
JavaScript
Pull request Compare This branch is 3 commits ahead, 13 commits behind timisbusy:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
node_modules
tests
README.md
index.js
package.json

README.md

Node.js Interface for RabbitMQ Management Statistics

This package creates an easy interface for getting statistics from a RabbitMQ instance with the management plugin installed. Read more about the management plugin here:

Required

You will need:

  1. An instance of RabbitMQ (running locally or in the cloud)
  2. The Management Plugin

Installation

npm install amqp-stats

Usage

Require the amqp-stats package:

var AMQPStats = require('amqp-stats');

Instantiate and provide authentication details (defaults to standard setup for a local instance).

var stats = new AMQPStats({
  username: "AMQP_USERNAME", // default: guest
  password: "AMQP_PASSWORD", // default: guest
  hostname: "AMQP_HOSTNAME"  // default: localhost:55672
});

NOTE: for RabbitMQ instances running on heroku, the hostname should look something like:

heroku.srs.rabbitmq.com/rabbitmq/sdaewywqh

From there you can use the stats instance to get data about your system's usage:

stats.overview(function(err, res, data){
  if (err) { throw err; }
  console.log('data: ', data);
});

This will return a list of your queues with lots of data about their rate of use, total messages sent, etc:

stats.queues(callback);

Note that when you lack admin privileges (on heroku instances for example) you may not be able to get at certain parts of this API. You can check your status with:

stats.whoami(callback);