Skip to content
This repository

Keep track of Sidekiq failed jobs

branch: master
README.md

Sidekiq::Failures Build Status

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.

WARNING: by default sidekiq-failures will keep up to 1000 failures. See Maximum Tracked Failures below.

Installation

Add this line to your application's Gemfile:

gem 'sidekiq-failures'

Usage

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.

Configuring

Maximum Tracked Failures

Since each failed job/retry creates a new failure entry that will only be removed by you manually, your failures list might consume more resources than you have available.

To avoid this sidekiq-failures adopts a default of 1000 maximum tracked failures.

To change the maximum amount:

Sidekiq.configure_server do |config|
  config.failures_max_count = 5000
end

To disable the limit entirely:

Sidekiq.configure_server do |config|
  config.failures_max_count = false
end

Failures Tracking Mode

Sidekiq-failures offers three failures tracking options (per worker):

:all (default)

Tracks failures every time 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

:exhausted

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

:off

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 :all, :exhausted or :off.

Helper Methods

Failures Count

Gives back the number of failed jobs currently stored in Sidekiq Failures. Notice that it's different from Sidekiq built in failed stat. Also, notice that this might be influenced by failures_max_count.

Sidekiq::Failures.count

Reset Failures

Gives a convenient way of reseting Sidekiq Failure stored failed jobs programmatically. Takes an options hash and if the counter key is present also resets Sidekiq own failed stats.

Sidekiq::Failures.reset_failures

Dependencies

Depends on Sidekiq >= 2.14.0

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Released under the MIT License. See the LICENSE file for further details.

Something went wrong with that request. Please try again.