Skip to content

Commit 2293d8c

Browse files
committed
Fix README conflicts
I tried GitHub's built-in editor to do this in the original PR but it wasn't saved for some reason ^_^U
1 parent 7a781de commit 2293d8c

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -223,15 +223,10 @@ There are several settings that control how Solid Queue works that you can set a
223223
```ruby
224224
-> (exception) { Rails.error.report(exception, handled: false) }
225225
```
226-
<<<<<<< add-documentation-for-handling-exceptions
227226

228-
Note: `on_thread_error` is intended for errors in the thread that is executing the job and not for errors encountered in the job. For errors in the job itself, [refer here](#exceptions)
229-
230-
- `connects_to`: a custom database configuration that will be used in the abstract `SolidQueue::Record` Active Record model. This is required to use a different database than the main app. For example:
231-
=======
232227
**This is not used for errors raised within a job execution**. Errors happening in jobs are handled by Active Job's `retry_on` or `discard_on`, and ultimately will result in [failed jobs](#failed-jobs-and-retries). This is for errors happening within Solid Queue itself.
233-
>>>>>>> main
234228

229+
- `connects_to`: a custom database configuration that will be used in the abstract `SolidQueue::Record` Active Record model. This is required to use a different database than the main app. For example:
235230
- `use_skip_locked`: whether to use `FOR UPDATE SKIP LOCKED` when performing locking reads. This will be automatically detected in the future, and for now, you'd only need to set this to `false` if your database doesn't support it. For MySQL, that'd be versions < 8, and for PostgreSQL, versions < 9.5. If you use SQLite, this has no effect, as writes are sequential.
236231
- `process_heartbeat_interval`: the heartbeat interval that all processes will follow—defaults to 60 seconds.
237232
- `process_alive_threshold`: how long to wait until a process is considered dead after its last heartbeat—defaults to 5 minutes.
@@ -315,14 +310,11 @@ failed_execution.retry # This will re-enqueue the job as if it was enqueued for
315310
failed_execution.discard # This will delete the job from the system
316311
```
317312

318-
<<<<<<< add-documentation-for-handling-exceptions
319-
We're planning to release a dashboard called _Mission Control_, where, among other things, you'll be able to examine and retry/discard failed jobs, one by one, or in bulk.
320-
321-
### Exceptions
313+
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.
322314

323-
For errors encountered in the job, you could try to hook into [Active Job](https://guides.rubyonrails.org/active_job_basics.html#exceptions) and report the errors to your exception monitoring service.
315+
### Error reporting on jobs
324316

325-
Let's see an example implementation to handle exceptions.
317+
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:
326318

327319
```ruby
328320
# application_job.rb
@@ -346,9 +338,6 @@ class ApplicationMailer < ActionMailer::Base
346338
end
347339
end
348340
```
349-
=======
350-
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.
351-
>>>>>>> main
352341

353342
## Puma plugin
354343

0 commit comments

Comments
 (0)