ThomasKoppensteiner / sidekiq-undertaker

Sidekiq::Undertaker allows exploring, reviving or burying dead jobs.
MIT License
18 stars 4 forks source link

Sidekiq::Undertaker

Gem Version Ruby-Build Code Climate Test Coverage Ruby Style Guide

About

Sidekiq::Undertaker is a plugin for Sidekiq. It allows exploring, reviving (retrying) or burying (deleting) dead jobs. For easy exploring the dead-jobs queue is broken down into time windows (buckets) of hours, days and weeks.

Installation

Install the Gem

Add this line to your application's Gemfile:

  gem "sidekiq-undertaker"

And then execute:

  $ bundle

Or install it yourself as:

  $ gem install sidekiq-undertaker

Development: Install the Rubocop Pre-Commit Hook

  $ rake rubocop:install

Impressions

Filter View

The filter page shows a table with time-buckets as columns and rows for each job class.

Sidekiq Undertaker

Job Filter View

For each job class, you can drill down to view error distribution based on error class.

Sidekiq Undertaker

Morgue View

Finally, click on the individual error counts to display details of the errors in a list form.

Sidekiq Undertaker

The morgue view can, for example, also show an error distribution over all job classes.

Sidekiq Undertaker

Contributing

  1. Fork it ( https://github.com/ThomasKoppensteiner/sidekiq-undertaker/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Naming

As another gem with the name sidekiq-cleaner is already released on rubygems.org, this fork was renamed to sidekiq-undertaker.

Thanks

The Sidekiq-Cleaner gem was originally created by Madan Thangavelu. Tout and TheWudu also contributed to it. Zlatko Rednjak added the initial version of the CHANGELOG.md. Lucas Dell'Isola added the export/import feature for dead jobs. thoesl added the error message based filter.

For the complete list of network members have a look at the fork overview.

Alternative Projects

Author

Thomas Koppensteiner | Github | RubyGems | @koppensteiner_t

License

See the License file.