queuekit-connector-bullmq v1.0.3

QueueKit.com BullMQ Connector

This is a small service which enables you to connect your BullMQ queues to QueueKit.com. It acts as a proxy between your Bull queues and the QueueKit.com API, providing bi-directional data transfer which enables advanced queue insights and management with QueueKit.com.

This connector is designed to be used in production-grade environments and does not require the sharing of passwords or SSH tunnels to function. It is also very useful to use the connector in local development environments for rapid queue development and debugging.

The connector is very lightweight and efficient, and uses minimal resources.

Installation

npm install queuekit-connector-bullmq

Usage

Usage: queuekit-connector-bullmq [options]

Options:
  -V, --version                           output the version number
  -n, --connector-name <connection-name>  Connector name. Defaults to 'Default connector'. (default: "Default connector")
  -a, --api-key <api-key>                 QueueKit.com organization API key. Get this from https://dashboard.queuekit.com
  -h, --host <host>                       Redis host. Defaults to localhost. (default: "localhost")
  -p, --port <port>                       Redis port. Defaults to 6379. (default: "6379")
  -d, --database <database>               Redis database. Defaults to 0. (default: "0")
  -w, --password <password>               Redis password, can also be supplied by setting REDIS_PASSWORD environment variable.
  --tls [tls]                             Activate secured TLS connection to Redis
  -u, --uri [uri]                         Redis URI.
  -s, --sentinels [host:port]             Comma-separated list of sentinel host/port pairs
  -m, --master [name]                     Name of master node used in sentinel configuration
  -b, --backend <backend>                 QueueKit.com websocket backend. Defaults to wss://api.queuekit.com (default: "wss://api.queuekit.com")
  --help                                  display help for command

Example usage

npx queuekit-connector-bullmq -u redis://<your-redis-host>:<your-redis-port>/<your-redis-db> -a <your-queuekit-api-key>

Your API key can be obtained from your queuekit.com Dashboard

Usage with Docker

The connector can be run with our pre-built docker image:

docker run -it --net=host queuekit/queuekit-connector-bullmq -u redis://<redis-host>:<redis-port>/<db-number> -a <your-queuekit-api-key>

Your API key can be obtained from your queuekit.com Dashboard

Other connectors

Bull connector BullMQ connector Celery connector