Skip to content

Commit 3a4b24c

Browse files
Ian Norrisrosa
authored andcommitted
improve readme to be more explicit about the recommended UI dashboard and that it will be needed to look at it via the UI
1 parent 16fb285 commit 3a4b24c

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Solid Queue can be used with SQL databases such as MySQL, PostgreSQL or SQLite,
1111
- [Installation](#installation)
1212
- [Usage in development and other non-production environments](#usage-in-development-and-other-non-production-environments)
1313
- [Single database configuration](#single-database-configuration)
14+
- [Dashboard UI Setup](#dashboard-ui-setup)
1415
- [Incremental adoption](#incremental-adoption)
1516
- [High performance requirements](#high-performance-requirements)
1617
- [Configuration](#configuration)
@@ -157,6 +158,10 @@ Running Solid Queue in a separate database is recommended, but it's also possibl
157158

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

161+
### Dashboard ui setup
162+
163+
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.
164+
160165
### Incremental adoption
161166

162167
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:
@@ -516,8 +521,6 @@ failed_execution.retry # This will re-enqueue the job as if it was enqueued for
516521
failed_execution.discard # This will delete the job from the system
517522
```
518523

519-
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.
520-
521524
### Error reporting on jobs
522525

523526
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:

0 commit comments

Comments
 (0)