Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you browse them. Makes use of Sidekiq's custom tabs and middleware chain.
It mimics the way Resque keeps track of failures.
TIP: Note that each failed job/retry might create a new failed job that will only be removed by you manually. This might result in a pretty big failures list depending on how you configure failures tracking in your workers.
Add this line to your application's Gemfile:
Depends on Sidekiq >= 2.2.1
Usage and Modes
Simply having the gem in your Gemfile is enough to get you started. Your failed jobs will be visible via a Failures tab in the Web UI.
Sidekiq-failures offers three failures tracking options (per worker):
Tracks failures everytime a background job fails. This mean a job with 25 retries enabled might generate up to 25 failure entries. If the worker has retry disabled only one failure will be tracked.
This is the default behavior but can be made explicit with:
class MyWorker include Sidekiq::Worker sidekiq_options :failures => true # or :all def perform; end end
Only track failures if the job exhausts all its retries (or doesn't have retries enabled).
You can set this mode as follows:
class MyWorker include Sidekiq::Worker sidekiq_options :failures => :exhausted def perform; end end
You can also completely turn off failures tracking for a given worker as follows:
class MyWorker include Sidekiq::Worker sidekiq_options :failures => false # or :off def perform; end end
Change the default mode
You can also change the default of all your workers at once by setting the following server config:
Sidekiq.configure_server do |config| config.failures_default_mode = :off end
The valid modes are
- Allow triggering retry of specific failed jobs via Web UI.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
Released under the MIT License. See the LICENSE file for further details.