RabbitMQ HTTP API Client

Common errors

• TypeError: require(...) is not a function

  cause Attempting to call the main module export directly instead of accessing the `client` property.
  fix Use `const client = require('http-rabbitmq-manager').client({ /* config */ });` to correctly access the client factory.

• Error: connect ECONNREFUSED

  cause The RabbitMQ server is not running, the Management UI plugin is not enabled, or the `host` or `port` configuration is incorrect.
  fix Verify RabbitMQ server status and ensure the `rabbitmq_management` plugin is enabled. Check that the configured `host` and `port` (default 15672) match your RabbitMQ management interface.

• 401 Unauthorized (or similar HTTP status in error callback)

  cause Incorrect `user` or `password` provided in the client configuration.
  fix Double-check the username and password for a user with management permissions in your RabbitMQ instance.

• TypeError: client.overview is not a function

  cause The `client` object was not correctly initialized, likely because the `.client()` method was not called or its return value wasn't assigned.
  fix Ensure the client is properly instantiated: `const client = require('http-rabbitmq-manager').client({ /* config */ });`.

• Error: Timeout of XXXXms exceeded (or similar timeout error)

  cause The API request took longer than the configured `timeout` value, or the RabbitMQ HTTP API is experiencing high load or slowness.
  fix Increase the `timeout` option in the client configuration if your network or RabbitMQ server response times are consistently high. Investigate RabbitMQ server performance if timeouts persist.

Warnings

• breaking This package officially supports only RabbitMQ 3.x versions. Modern RabbitMQ versions (e.g., 4.x, 3.12+) have significant changes, and this client may not be compatible or function correctly.
  Fix: Consider using a more current RabbitMQ client library or interacting directly with the HTTP API if you are on newer RabbitMQ versions. Evaluate `rabbitmq-management-client` (Rust, but indicates features of modern clients) or `pulumi/rabbitmq` (Pulumi provider) for alternatives, or other generic HTTP clients.
• gotcha The package is in version 0.0.4 and has seen no commits in over seven years, indicating it is abandoned. There will be no new features, bug fixes, or security updates. The API should be considered unstable.
  Fix: Use with extreme caution. For production environments, consider alternative, actively maintained RabbitMQ clients or management tools.
• gotcha This library relies on the RabbitMQ Management UI plugin being installed and enabled on your RabbitMQ server. Without it, the HTTP API endpoints will not be available, and the client will fail to connect or retrieve data.
  Fix: Ensure the RabbitMQ Management UI plugin is enabled on your RabbitMQ server. Typically, this can be done via `rabbitmq-plugins enable rabbitmq_management`. Verify the default port (15672) is accessible.
• gotcha The API exclusively uses Node.js callback patterns for asynchronous operations. This can lead to 'callback hell' in complex scenarios and is less ergonomic than modern Promise-based or `async/await` patterns.
  Fix: Wrap callback-based functions in Promises using `util.promisify` for better integration into modern `async/await` codebases, or consider using a different, actively maintained client library that offers Promise support.
• gotcha For long-term monitoring, alerting, and advanced visualization of RabbitMQ metrics, official RabbitMQ documentation recommends using Prometheus and Grafana, as the HTTP API is primarily for basic observability. Relying solely on this client for comprehensive monitoring might be insufficient.
  Fix: Integrate dedicated monitoring solutions like Prometheus and Grafana for robust RabbitMQ metric collection and analysis in production environments.

Install

• npm install http-rabbitmq-manager npm
• yarn add http-rabbitmq-manager yarn
• pnpm add http-rabbitmq-manager pnpm

Imports

• client
  wrong:

  const managerClient = require('http-rabbitmq-manager')({ /* config */ });

  correct:

  const managerClient = require('http-rabbitmq-manager').client({ /* config */ });

  The main module export is an object; the `client` factory function is a property on it. This package uses CommonJS `require` syntax.

Quickstart

Instantiate the client and demonstrate fetching basic RabbitMQ cluster information (overview, nodes, connections) using callbacks.

const client = require('http-rabbitmq-manager').client({
  host: process.env.RABBITMQ_HOST ?? 'localhost',
  port: parseInt(process.env.RABBITMQ_MANAGEMENT_PORT ?? '15672'),
  timeout: parseInt(process.env.RABBITMQ_TIMEOUT ?? '25000'),
  user: process.env.RABBITMQ_USER ?? 'guest',
  password: process.env.RABBITMQ_PASSWORD ?? 'guest'
});

console.log('Fetching RabbitMQ cluster overview...');
client.overview(function (err, res) {
  if (err) {
    console.error('Error fetching overview:', err.message);
    return;
  }
  console.log('Overview:', JSON.stringify(res, null, 2));

  console.log('\nListing all nodes...');
  client.listNodes(function (err, nodes) {
    if (err) {
      console.error('Error listing nodes:', err.message);
      return;
    }
    console.log('Nodes:', JSON.stringify(nodes, null, 2));

    console.log('\nListing all connections...');
    client.listConnections(function (err, connections) {
      if (err) {
        console.error('Error listing connections:', err.message);
        return;
      }
      console.log('Connections:', JSON.stringify(connections, null, 2));
    });
  });
});