Installation
Add this line to your application’s Gemfile:
$ bundle add sidekiq-antidote
Or install it yourself as:
$ gem install sidekiq-antidote
Usage
When running in forked environment (e.g., Puma web server), you also need to
call Sidekiq::Antidote.startup
on fork:
Web UI
Adding Antidote tab in Sidekiq web UI is as simple as:
require "sidekiq/web"
require "sidekiq/antidote/web"
Inhibitors
Treatments
When adding antidote you must pick on of the treatments:
- skip
-
Skip the job (don’t enqueue and/or perform)
- kill
-
Kill the job (send to the dead set instead of enqueueing and/or performing)
Antidote Qualifiers
Qualifier is the job class pattern. It may match the job class or the job class and method name (when used with ActionMailer delayed deliveries):
-
ExampleJob
-
Namespaced::ExampleJob
-
UserMailer#welcome
You can also use pattern matching:
- *
-
Matches any number of alpha-numeric characters and underscores:
-
*Job
matches:ExampleJob
, but notNamespaced::ExampleJob
, orUserMailer#welcome
-
UserMailer#*
matches any method ofUserMailer
-
- **
-
Matches any number of components:
-
**
mathes any job or mailer method -
A::**::Job
matchesA::B::Job
,A::B::C::D::CJob
, etc. -
A**::Job
matchesA::Job
,Abc::Job
,A::B::Job
, etc.
-
- {}
-
Matches any of the given literal:
-
{A,B,C}Job
matchesAJob
,BJob
, andCJob
-
Supported Ruby Versions
This library aims to support and is tested against the following Ruby versions:
-
Ruby 3.0.x
-
Ruby 3.1.x
-
Ruby 3.2.x
If something doesn’t work on one of these versions, it’s a bug.
This library may inadvertently work (or seem to work) on other Ruby versions, however support will only be provided for the versions listed above.
If you would like this library to support another Ruby version or implementation, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.
Supported Sidekiq Versions
This library aims to support and work with following Sidekiq versions:
-
Sidekiq 7.2.x
Development
bundle install
bundle exec appraisal generate
bundle exec appraisal install
bundle exec rake
Contributing
-
Fork sidekiq-antidote
-
Make your changes
-
Ensure all tests pass (
bundle exec rake
) -
Send a merge request
-
If we like them we’ll merge them
-
If we’ve accepted a patch, feel free to ask for commit access!
Acknowledgement
-
Inspired by sidekiq-killswitch