diff --git a/README.md b/README.md index 5c18516a..a7cfafe2 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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: @@ -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: