https://github.com/queuekit/queuekit-connector-bullmq
The BullMQ connector for QueueKit.com
https://github.com/queuekit/queuekit-connector-bullmq
bull bullmq job job-queue node nodejs queue queue-workers queuekit redis
Last synced: 2 months ago
JSON representation
The BullMQ connector for QueueKit.com
- Host: GitHub
- URL: https://github.com/queuekit/queuekit-connector-bullmq
- Owner: queuekit
- Created: 2021-05-30T15:58:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-25T12:21:59.000Z (over 3 years ago)
- Last Synced: 2025-02-02T14:35:38.203Z (3 months ago)
- Topics: bull, bullmq, job, job-queue, node, nodejs, queue, queue-workers, queuekit, redis
- Language: TypeScript
- Homepage: https://queuekit.com
- Size: 276 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# QueueKit.com BullMQ Connector
This is a small service which enables you to connect your [BullMQ](https://github.com/taskforcesh/bullmq) queues to [QueueKit.com](https://queuekit.com). It acts as a proxy between your Bull queues and the [QueueKit.com](https://queuekit.com) API, providing bi-directional data transfer which enables advanced queue insights and management with [QueueKit.com](https://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
```sh
npm install queuekit-connector-bullmq
```
## Usage
```sh
Usage: queuekit-connector-bullmq [options]
Options:
-V, --version output the version number
-n, --connector-name Connector name. Defaults to 'Default connector'. (default: "Default connector")
-a, --api-key QueueKit.com organization API key. Get this from https://dashboard.queuekit.com
-h, --host Redis host. Defaults to localhost. (default: "localhost")
-p, --port Redis port. Defaults to 6379. (default: "6379")
-d, --database Redis database. Defaults to 0. (default: "0")
-w, --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 QueueKit.com websocket backend. Defaults to wss://api.queuekit.com (default: "wss://api.queuekit.com")
--help display help for command
```
### Example usage
```sh
npx queuekit-connector-bullmq -u redis://:/ -a
```
Your API key can be obtained from your [queuekit.com Dashboard](https://dashboard.queuekit.com/)
### Usage with Docker
The connector can be run with our pre-built docker image:
```sh
docker run -it --net=host queuekit/queuekit-connector-bullmq -u redis://:/ -a
```
Your API key can be obtained from your [queuekit.com Dashboard](https://dashboard.queuekit.com/)
### Other connectors
[Bull connector](https://github.com/queuekit/queuekit-connector-bull)
[BullMQ connector](https://github.com/queuekit/queuekit-connector-bullmq)
[Celery connector](https://github.com/queuekit/queuekit-connector-celery)