README.adoc in sidekiq-throttled-1.4.0 vs README.adoc in sidekiq-throttled-1.5.0
- old
+ new
@@ -29,11 +29,10 @@
Or install it yourself as:
$ gem install sidekiq-throttled
-
== Usage
Add somewhere in your app's bootstrap (e.g. `config/initializers/sidekiq.rb` if
you are using Rails):
@@ -79,29 +78,51 @@
# ...
end
----
+=== Web UI
+
+To add a Throttled tab to your sidekiq web dashboard, require it durring your
+application initialization.
+
+[source,ruby]
+----
+require "sidekiq/throttled/web"
+----
+
+
=== Configuration
[source,ruby]
----
Sidekiq::Throttled.configure do |config|
# Period in seconds to exclude queue from polling in case it returned
# {config.cooldown_threshold} amount of throttled jobs in a row. Set
# this value to `nil` to disable cooldown manager completely.
- # Default: 2.0
- config.cooldown_period = 2.0
+ # Default: 1.0
+ config.cooldown_period = 1.0
# Exclude queue from polling after it returned given amount of throttled
# jobs in a row.
- # Default: 1 (cooldown after first throttled job)
- config.cooldown_threshold = 1
+ # Default: 100 (cooldown after hundredth throttled job in a row)
+ config.cooldown_threshold = 100
end
----
+[WARNING]
+.Cooldown Settings
+====
+If a queue contains a thousand jobs in a row that will be throttled,
+the cooldown will kick-in 10 times in a row, meaning it will take 10 seconds
+before all those jobs are put back at the end of the queue and you actually
+start processing other jobs.
+You may want to adjust the cooldown_threshold and cooldown_period,
+keeping in mind that this will also impact the load on your Redis server.
+====
+
==== Middleware(s)
`Sidekiq::Throttled` relies on following bundled middlewares:
* `Sidekiq::Throttled::Middlewares::Server`
@@ -288,10 +309,9 @@
== Supported Sidekiq Versions
This library aims to support and work with following Sidekiq versions:
-* Sidekiq 6.5.x
* Sidekiq 7.0.x
* Sidekiq 7.1.x
* Sidekiq 7.2.x
And the following Sidekiq Pro versions: