pg-boss icon indicating copy to clipboard operation
pg-boss copied to clipboard

Dashboard

Open gherciu opened this issue 11 months ago • 5 comments

I'm new to this library And I find it interesting But what I'm trying to find if is there a dashboard to view the jobs result or trigger manually any? or the only solution is to check the db?

gherciu avatar Jan 15 '25 22:01 gherciu

Currently only way you can see the result of jobs is through DB. It would be nice to build an UI. Some previous discussion https://github.com/timgit/pg-boss/discussions/314

yogsma avatar Jan 16 '25 06:01 yogsma

Here, I went and build this UI for pg-boss https://github.com/yogsma/pg-boss-dashboard. Thanks to Pg-Boss work, this was a quick thing I could built. This is just an initial version, so you might notice issues or missing features. Feel free to create a ticket and I will add them.

yogsma avatar Jan 19 '25 15:01 yogsma

@timgit - I built the open source dashboard for pg-boss, you can close this ticket?

yogsma avatar Jan 19 '25 15:01 yogsma

@yogsma Thanks for your contribution

I see it has only view capabilities at the moment, and things you can check in a DB GUI mostly

I was thinking maybe we fork the bull-board and use same UI bit and similar API but connected to pg-boss

gherciu avatar Jan 19 '25 23:01 gherciu

@yogsma Thanks for your contribution

I see it has only view capabilities at the moment, and things you can check in a DB GUI mostly

I was thinking maybe we fork the bull-board and use same UI bit and similar API but connected to pg-boss

Thanks @gherciu .

I intentionally added MVP capabilities for now. But I do plan to add more features. I have used bull-board previously. But I wanted to use better UI components to make it more intuitive to use. What features do you want? Feel free to create issue tickets for pg-boss-dashboard and I will add them.

yogsma avatar Jan 20 '25 07:01 yogsma

I'm working on a library with a dashboard. I will release it shortly

Image

Let me know if you have any feature requests

nahtnam avatar Sep 17 '25 08:09 nahtnam

Hey everyone, I have just published 0.0.1! The library is called pg-bossman and it is an typed layer on top of pg-boss. There are two parts to the library:

  1. A more type-strict version of pg-boss to define queues and send jobs. Inspired by tRPC, oRPC, and this blog post.
  2. The dashboard you see in the image above. It works with any pg-boss v10 setup. (You don't need to use part 1 features for the dashboard to work)

GitHub: https://github.com/ludicroushq/pg-bossman NPM: https://www.npmjs.com/package/pg-bossman Example code on how to set up: https://github.com/ludicroushq/pg-bossman/blob/main/examples/next-dashboard-only/src/app/admin/dashboard/%5B%5B...path%5D%5D/route.ts

const bossmanClient = createClient({
  connectionString: process.env.DATABASE_URL,
});

const dashboard = createDashboard({
  basePath: "/admin/dashboard",
  client: bossmanClient,
});

function handler(req: Request) {
  // IMPORTANT: ensure the request is coming from an admin user.
  return dashboard(req);
}

The dashboard will work in any framework where you can take a standard Request object and return a new Response object (Next.js, TanStack Start, Hono, etc).

Current you can only view jobs. I will look into adding and cancelling jobs as well. I did some pretty basic testing and it's working but please share feedback in the github repo if you have any issues.

nahtnam avatar Sep 19 '25 06:09 nahtnam

Hi, pg-bossman now supports pg-boss v11 (>=0.1.0). pg-boss v10 support is available in (0.0.x)

nahtnam avatar Oct 04 '25 00:10 nahtnam

I'd created one myself...i wanted it to be a standalone app that i can just run while in my project repo and have features like:

  • advanced filtering (jq-like or just plain text matching)
  • canceling/retrying jobs
  • realtime charts
  • minimal dependencies

https://github.com/lpetrov/pg-boss-admin-dashboard/

Hopefully its helpful for others too.

lpetrov avatar Nov 19 '25 13:11 lpetrov

@timgit Maybe it would make sense to mention pg-boss dashboard projects in documentation to improve discovereability?

kibertoad avatar Dec 03 '25 12:12 kibertoad

Agreed

timgit avatar Dec 03 '25 16:12 timgit

I'll prepare a PR

kibertoad avatar Dec 03 '25 16:12 kibertoad