Simplekiq

Simplekiq simplifies the boilerplate that sidekiq requires, it ensures that every job is run on a different queue and queues are no longer initialized in the sidekiq.yml

Installation

Add this line to your application's Gemfile:

gem 'simplekiq'

And then execute:

$ bundle

Or install it yourself as:

$ gem install simplekiq

Usage

Basics

Use include Simplekiq::Worker instead of Sidekiq::Worker

You can only pass one hash to the perform method. They should be named params, and symbolized_keys get's applied to the hash, so write tests and implementation accordingly.

Workers should be very simple. They should find or initaitialize another object and run one method on it.

class HardWorker
  include Simplekiq::Worker
  def perform(params)
    TacoMakingHandler.new(params).perform
    OR
    Taco.find(params[:taco_id]).make
  end
end

This will do two things:

Your worker will default to the hard queue or if you are running it in a rails project it will default to the my_app-hard queue where my_app is your app name.
Running bundle exec sidekiq will autoload the queue names by introspecting the workers (NOTE: only workers in app/workers will be loaded)

Do not declare queues in your sidekiq configuration file, this will throw an error.

Priority

Instead of declaring the priority for queues in the sidekiq.yml file you can set it directly in a worker, if this is not set the worker will default to priority (1):

class ReallyHardWorker
  include Simplekiq::Worker
  sidekiq_options priority: 2
end

A higher priority means that queue will be sampled more often and have a higher chance of running the job.

Priority Strict

Strict priority is not supported as there is no place to declare a list of workers.

Testing

Instead of requiring sidekiq/testing, require simplekiq/testing in your tests. This has all the functionality of the original sidekiq gem, but also adheres to the symbolized params paradigm established by Simplekiq in tests.

Datadog

Simplekiq comes with datadog configured out of the gate, including the stats that are already passed using the sidekiq-datadog gem simplekiq also passes a service:my_app tag through the sidekiq middleware.

If you have Sidekiq::Pro then you can set the dogstatsd with DATADOG_HOST and DATADOG_PORT env variables.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fzf/simplekiq. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Simplekiq project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

pablomarti/simplekiq