README.md in sidekiq-limit_fetch-0.7 vs README.md in sidekiq-limit_fetch-0.8
- old
+ new
@@ -1,10 +1,19 @@
## Description
Sidekiq strategy to restrict number of workers
which are able to run specified queues simultaneously.
+[](http://travis-ci.org/brainopia/sidekiq-limit_fetch)
+[](http://badge.fury.io/rb/sidekiq-limit_fetch)
+[](https://gemnasium.com/brainopia/sidekiq-limit_fetch)
+[](https://codeclimate.com/github/brainopia/sidekiq-limit_fetch)
+
## Installation
Add this line to your application's Gemfile:
gem 'sidekiq-limit_fetch'
@@ -12,13 +21,13 @@
## Usage
Specify limits which you want to place on queues inside sidekiq.yml:
```yaml
-:limits:
- queue_name1: 5
- queue_name2: 10
+ :limits:
+ queue_name1: 5
+ queue_name2: 10
```
Or set it dynamically in your code:
```ruby
Sidekiq::Queue['queue_name1'].limit = 5
@@ -30,24 +39,60 @@
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.
```ruby
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
+ Sidekiq::Queue['name'].paused? # => true
+ Sidekiq::Queue['name'].unpause # allows workers to use the queue
```
+
+You can see how many workers currently handling a queue:
+
+```ruby
+ Sidekiq::Queue['name'].busy # number of busy workers
+```
+
+
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:
```yaml
-:global: true
+ :global: true
```
+
+
+If you use strict queue ordering (it will be used if you don't specify queue weights)
+then you can set blocking status for queues. It means if a blocking
+queue task is executing then no new task from lesser priority queues will
+be ran. Eg,
+
+```yaml
+ :queues:
+ - a
+ - b
+ - c
+ :limits:
+ - b
+```
+
+In this case when a task for `b` queue is ran no new task from `c` queue
+will be started.
+
+You can also enable and disable blocking mode for queues on the fly:
+
+```ruby
+ Sidekiq::Queue['name'].block
+ Sidekiq::Queue['name'].blocking? # => true
+ Sidekiq::Queue['name'].unblock
+```
+
Sponsored by [Evil Martians].
[Evil Martians]: http://evilmartians.com/