Skip to content

Commit c9bcb42

Browse files
authored
Merge pull request #892 from jperelli/master
[docs] Add screenshots to pg-boss dashboard
2 parents f199640 + 3caa7d3 commit c9bcb42

7 files changed

Lines changed: 38 additions & 0 deletions

docs/dashboard.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,44 @@ A web-based dashboard is available in the [`@pg-boss/dashboard`](https://www.npm
1414
- **Mobile Responsive**: Full functionality on mobile devices with collapsible sidebar
1515
- **Shareable URLs**: Database selection and filters are preserved in URLs for easy sharing
1616

17+
## Pages
18+
19+
### Overview
20+
21+
Landing page with aggregate counts across all queues (queued, deferred, ready, active, failed and total jobs), the top queues by backlog with a ready-count trend sparkline and status badge, and the most recent warnings. The **Send Job** button opens a form to enqueue a job into any queue.
22+
23+
![Overview page](./images/dashboard-overview.png)
24+
25+
### Jobs
26+
27+
Recently created jobs across all queues. Filter by job ID, queue, state (pending, created, retry, active, completed, cancelled or failed) and minimum retry count, or open the advanced filters to match on keys inside the job's `data` or `output` JSON. **Manage view** lets you add custom columns sourced from job fields (for example `data.tenantId`), and **Copy link** produces a shareable URL with the current filters and columns. Clicking a job opens its detail page with the full payload, output, retry and timing metadata, and cancel / retry / resume / delete actions.
28+
29+
![Jobs page](./images/dashboard-jobs.png)
30+
31+
### Queues
32+
33+
Every queue in the schema with its policy and cached counts (queued, deferred, ready, active, failed, total), a trend sparkline, storage mode (shared or partitioned) and a status badge (idle, processing or backlogged). Columns are sortable and the list can be searched by name. **Create Queue** creates a new queue with its policy and retry / expiration / retention options. Clicking a queue opens its detail page with configuration, a 24-hour ready-count history and the jobs in that queue.
34+
35+
![Queues page](./images/dashboard-queues.png)
36+
37+
### Schedules
38+
39+
Cron-based schedules registered with `boss.schedule()`, showing the target queue, optional key, cron expression, a human-readable frequency, the next occurrence and timezone. **Schedule Job** creates a new schedule, and each schedule's detail page shows its data and options and lets you unschedule it.
40+
41+
![Schedules page](./images/dashboard-schedules.png)
42+
43+
### Migrations
44+
45+
Status of background async migrations (BAM) — schema changes such as concurrent index builds that pg-boss runs outside the install transaction. Shows pending, in-progress, completed and failed counts, and for each command its version, target table, timestamps and the SQL that was (or will be) executed, including any error message.
46+
47+
![Migrations page](./images/dashboard-migrations.png)
48+
49+
### Warnings
50+
51+
Event log of warnings emitted by pg-boss when [`persistWarnings`](#enabling-warning-persistence) is enabled, such as slow queries, queue backlogs or clock skew. Each entry shows its type, message, key details (for example the queue and its size, or the query duration) and time, and the list can be filtered by warning type.
52+
53+
![Warnings page](./images/dashboard-warnings.png)
54+
1755
## Requirements
1856

1957
- Node.js 22.12+

docs/images/dashboard-jobs.png

246 KB
Loading
182 KB
Loading

docs/images/dashboard-overview.png

212 KB
Loading

docs/images/dashboard-queues.png

192 KB
Loading
168 KB
Loading

docs/images/dashboard-warnings.png

229 KB
Loading

0 commit comments

Comments
 (0)