Skip to content

improve readme to be more explicit about the recommended UI dashboard #593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 10, 2025
Merged

improve readme to be more explicit about the recommended UI dashboard #593

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Solid Queue can be used with SQL databases such as MySQL, PostgreSQL or SQLite,
- [Installation](#installation)
- [Usage in development and other non-production environments](#usage-in-development-and-other-non-production-environments)
- [Single database configuration](#single-database-configuration)
- [Dashboard UI Setup](#dashboard-ui-setup)
- [Incremental adoption](#incremental-adoption)
- [High performance requirements](#high-performance-requirements)
- [Configuration](#configuration)
Expand Down Expand Up @@ -157,6 +158,10 @@ Running Solid Queue in a separate database is recommended, but it's also possibl

You won't have multiple databases, so `database.yml` doesn't need to have primary and queue database.

### Dashboard ui setup

For viewing information about your jobs via a UI, we recommend taking a look at [mission_control-jobs](https://github.com/rails/mission_control-jobs), a dashboard where, among other things, you can examine and retry/discard failed jobs.

### Incremental adoption

If you're planning to adopt Solid Queue incrementally by switching one job at the time, you can do so by leaving the `config.active_job.queue_adapter` set to your old backend, and then set the `queue_adapter` directly in the jobs you're moving:
Expand Down Expand Up @@ -516,8 +521,6 @@ failed_execution.retry # This will re-enqueue the job as if it was enqueued for
failed_execution.discard # This will delete the job from the system
```

However, we recommend taking a look at [mission_control-jobs](https://github.com/rails/mission_control-jobs), a dashboard where, among other things, you can examine and retry/discard failed jobs.

### Error reporting on jobs

Some error tracking services that integrate with Rails, such as Sentry or Rollbar, hook into [Active Job](https://guides.rubyonrails.org/active_job_basics.html#exceptions) and automatically report not handled errors that happen during job execution. However, if your error tracking system doesn't, or if you need some custom reporting, you can hook into Active Job yourself. A possible way of doing this would be:
Expand Down