Sidekiq strategy to support an advanced queue control – limiting, pausing, blocking, querying
Go to file
brainopia 2c7ca1d33d Add dependencies status 2013-01-24 17:54:26 +04:00
lib/sidekiq Add heartbeat monitor 2013-01-24 17:44:38 +04:00
spec Add heartbeat monitor 2013-01-24 17:44:38 +04:00
.gitignore Initial implementation 2013-01-11 14:56:41 +04:00
Gemfile Initial implementation 2013-01-11 14:56:41 +04:00
LICENSE.txt Initial implementation 2013-01-11 14:56:41 +04:00
README.md Add dependencies status 2013-01-24 17:54:26 +04:00
Rakefile Initial implementation 2013-01-11 14:56:41 +04:00
sidekiq-limit_fetch.gemspec Release version with heartbeat monitor 2013-01-24 17:45:06 +04:00

README.md

Description

Sidekiq strategy to restrict number of workers which are able to run specified queues simultaneously.

GemVersion

DependencyStatus

Installation

Add this line to your application's Gemfile:

gem 'sidekiq-limit_fetch'

Usage

Specify limits which you want to place on queues inside sidekiq.yml:

:limits:
  queue_name1: 5
  queue_name2: 10

Or set it dynamically in your code:

  Sidekiq::Queue['queue_name1'].limit = 5
  Sidekiq::Queue['queue_name2'].limit = 10

In these examples, tasks for the queue_name1 will be run by at most 5 workers at the same time and the queue_name2 will have no more than 10 workers simultaneously.

Ability to set limits dynamically allows you to resize worker distribution among queues any time you want.

You can also pause your queues temporarely. Upon continuing their limits will be preserved.

  Sidekiq::Queue['name'].pause # prevents workers from running tasks from this queue
  ...
  Sidekiq::Queue['name'].continue # allows workers to use the queue with the same limit

Limits are applied per process. In case you have several worker processes and want to have global locks between them, you'll need to enable global mode by setting global option, eg:

:global: true

Sponsored by [Evil Martians]. [Evil Martians]: http://evilmartians.com/