bullmq-dash 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -4
- package/dist/index.js +1548 -1430
- package/package.json +4 -1
package/README.md
CHANGED
|
@@ -7,10 +7,11 @@ Terminal UI dashboard for [BullMQ](https://bullmq.io/)
|
|
|
7
7
|
## Features
|
|
8
8
|
|
|
9
9
|
- **Real-time monitoring** - Watch queues and jobs update live with configurable polling
|
|
10
|
-
- **Queue overview** - View all BullMQ queues with job counts and
|
|
10
|
+
- **Queue overview** - View all BullMQ queues with job counts, failure counts, and task-size sorting
|
|
11
11
|
- **Job inspection** - Browse jobs by status, view details, data, and error stacktraces
|
|
12
|
+
- **Failed-job recovery** - Find failed jobs quickly and retry one job by ID or a filtered batch
|
|
12
13
|
- **Scheduler monitoring** - View Job Schedulers (repeatable jobs) with patterns, iterations, and job history
|
|
13
|
-
- **Job management** -
|
|
14
|
+
- **Job management** - Delete jobs from the TUI and retry failed jobs from headless mode
|
|
14
15
|
- **Global metrics** - Track enqueue/dequeue rates across all queues
|
|
15
16
|
|
|
16
17
|
## Requirements
|
|
@@ -85,6 +86,29 @@ bullmq-dash --tui --redis-url <redis-url> --queues email,notifications,payments
|
|
|
85
86
|
bullmq-dash --tui --redis-url <redis-url> --poll-interval 5000
|
|
86
87
|
```
|
|
87
88
|
|
|
89
|
+
### Headless Queue Operations
|
|
90
|
+
|
|
91
|
+
Headless commands print JSON by default, so they are safe to pipe through `jq`
|
|
92
|
+
or run from automation.
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
# Rank queues by task size, largest first
|
|
96
|
+
bullmq-dash queues list --redis-url <redis-url> --sort-by task-size
|
|
97
|
+
|
|
98
|
+
# Rank queues by failed jobs
|
|
99
|
+
bullmq-dash queues list --redis-url <redis-url> --sort-by failed
|
|
100
|
+
|
|
101
|
+
# Find failed jobs in a queue
|
|
102
|
+
bullmq-dash jobs failed email --redis-url <redis-url>
|
|
103
|
+
|
|
104
|
+
# Preview retrying one failed job, then run it
|
|
105
|
+
bullmq-dash jobs retry email --redis-url <redis-url> --job-id 42 --dry-run
|
|
106
|
+
bullmq-dash jobs retry email --redis-url <redis-url> --job-id 42 --yes
|
|
107
|
+
|
|
108
|
+
# Preview a filtered batch retry
|
|
109
|
+
bullmq-dash jobs retry email --redis-url <redis-url> --job-state failed --since 1h --dry-run
|
|
110
|
+
```
|
|
111
|
+
|
|
88
112
|
## Connection Profiles
|
|
89
113
|
|
|
90
114
|
Save Redis connections as named profiles so you don't have to remember (or paste)
|
|
@@ -98,14 +122,15 @@ and reference it with `--profile`:
|
|
|
98
122
|
"local": { "redis": { "url": "<local-redis-url>" } },
|
|
99
123
|
"prod": {
|
|
100
124
|
"redis": { "url": "${REDIS_PROD_URL}" },
|
|
101
|
-
"queues": ["payments", "notifications"]
|
|
125
|
+
"queues": ["payments", "notifications"],
|
|
126
|
+
"cacheTtlMs": 86400000
|
|
102
127
|
},
|
|
103
128
|
"upstash": { "redis": { "url": "${REDIS_URL}" } }
|
|
104
129
|
}
|
|
105
130
|
}
|
|
106
131
|
```
|
|
107
132
|
|
|
108
|
-
Each profile carries a single `redis.url`. The `${VAR}` form interpolates an environment variable as the **whole value** (partial substitution is intentionally not supported), which pairs nicely with managed providers (Upstash, Heroku Redis, Render, Railway, Fly) that hand you a single `REDIS_URL` env var. Prefer environment-backed profile values for authenticated Redis URLs.
|
|
133
|
+
Each profile carries a single `redis.url`. `cacheTtlMs` controls the SQLite observation-cache TTL and defaults to 24 hours. The `${VAR}` form interpolates an environment variable as the **whole value** (partial substitution is intentionally not supported), which pairs nicely with managed providers (Upstash, Heroku Redis, Render, Railway, Fly) that hand you a single `REDIS_URL` env var. Prefer environment-backed profile values for authenticated Redis URLs.
|
|
109
134
|
|
|
110
135
|
```bash
|
|
111
136
|
# Connect using the default profile (defaultProfile field above)
|
|
@@ -155,6 +180,7 @@ without auth — keep passwords out of the file itself.
|
|
|
155
180
|
| `Enter` | View job details |
|
|
156
181
|
| `d` | Delete selected job |
|
|
157
182
|
| `r` | Refresh data |
|
|
183
|
+
| `s` | Cycle queue sorting |
|
|
158
184
|
| `q` / `Ctrl+C` | Quit |
|
|
159
185
|
|
|
160
186
|
### Job Status Filter
|