Getting Started

Quickstart

Install the SDK, attach your queue, and start seeing jobs in the dashboard.

Get monitoring started fast – the SDK auto-detects your queue type and streams job events in real time.

Prereqs

Node.js 18+
BullMQ, Bull, or Bee-Queue
A Queuedash account

Install the SDK

pnpm add @queuedash/sdk
# npm install @queuedash/sdk
# yarn add @queuedash/sdk

Add your API key

In your project, go to API Keys → Create API Key
Copy it (shown once) and store it in your secrets manager

QUEUEDASH_API_KEY=sk_live_...

Attach your queue

BullMQ example:

import { Queue } from "bullmq";
import { Queuedash } from "@queuedash/sdk";
 
const qd = new Queuedash({
  apiKey: process.env.QUEUEDASH_API_KEY,
});
 
const myQueue = new Queue("my-queue", {
  connection: { host: "localhost", port: 6379 },
});
 
qd.attach(myQueue); // that's it

The SDK auto-detects BullMQ, Bull, and Bee-Queue.

Supported queues at a glance

Queue	Version	Events tracked	Delayed jobs	Progress events
BullMQ	4.x	added, waiting, delayed, active, progress, completed, failed, stalled, removed	Yes	Yes
Bull	4.x	active, progress, completed, failed, removed	Yes	Yes
Bee-Queue	1.x	succeeded, failed, retrying	No	Partial
GroupMQ	1.x	added, active, completed, failed	Yes	Yes

Next Steps

Configure the SDK for batching/timeouts
Set up alerts to catch stalls and failures
Invite your team so ops and devs share the same view

Configuration