sidekiq 6.4.0 → 7.0.8
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of sidekiq might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/Changes.md +187 -12
- data/README.md +44 -31
- data/bin/sidekiq +4 -9
- data/bin/sidekiqload +189 -117
- data/bin/sidekiqmon +4 -1
- data/lib/sidekiq/api.rb +304 -186
- data/lib/sidekiq/capsule.rb +127 -0
- data/lib/sidekiq/cli.rb +83 -80
- data/lib/sidekiq/client.rb +71 -44
- data/lib/sidekiq/component.rb +68 -0
- data/lib/sidekiq/config.rb +270 -0
- data/lib/sidekiq/deploy.rb +62 -0
- data/lib/sidekiq/embedded.rb +61 -0
- data/lib/sidekiq/fetch.rb +23 -24
- data/lib/sidekiq/job.rb +375 -10
- data/lib/sidekiq/job_logger.rb +16 -28
- data/lib/sidekiq/job_retry.rb +76 -54
- data/lib/sidekiq/job_util.rb +59 -19
- data/lib/sidekiq/launcher.rb +103 -95
- data/lib/sidekiq/logger.rb +9 -44
- data/lib/sidekiq/manager.rb +33 -32
- data/lib/sidekiq/metrics/query.rb +153 -0
- data/lib/sidekiq/metrics/shared.rb +95 -0
- data/lib/sidekiq/metrics/tracking.rb +136 -0
- data/lib/sidekiq/middleware/chain.rb +96 -51
- data/lib/sidekiq/middleware/current_attributes.rb +16 -17
- data/lib/sidekiq/middleware/i18n.rb +6 -4
- data/lib/sidekiq/middleware/modules.rb +21 -0
- data/lib/sidekiq/monitor.rb +17 -4
- data/lib/sidekiq/paginator.rb +17 -9
- data/lib/sidekiq/processor.rb +60 -60
- data/lib/sidekiq/rails.rb +12 -10
- data/lib/sidekiq/redis_client_adapter.rb +115 -0
- data/lib/sidekiq/redis_connection.rb +13 -82
- data/lib/sidekiq/ring_buffer.rb +29 -0
- data/lib/sidekiq/scheduled.rb +65 -37
- data/lib/sidekiq/testing/inline.rb +4 -4
- data/lib/sidekiq/testing.rb +41 -68
- data/lib/sidekiq/transaction_aware_client.rb +44 -0
- data/lib/sidekiq/version.rb +2 -1
- data/lib/sidekiq/web/action.rb +3 -3
- data/lib/sidekiq/web/application.rb +40 -9
- data/lib/sidekiq/web/csrf_protection.rb +3 -3
- data/lib/sidekiq/web/helpers.rb +35 -21
- data/lib/sidekiq/web.rb +10 -17
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +84 -206
- data/sidekiq.gemspec +21 -10
- data/web/assets/javascripts/application.js +76 -26
- data/web/assets/javascripts/base-charts.js +106 -0
- data/web/assets/javascripts/chart.min.js +13 -0
- data/web/assets/javascripts/chartjs-plugin-annotation.min.js +7 -0
- data/web/assets/javascripts/dashboard-charts.js +166 -0
- data/web/assets/javascripts/dashboard.js +3 -240
- data/web/assets/javascripts/metrics.js +264 -0
- data/web/assets/stylesheets/application-dark.css +4 -0
- data/web/assets/stylesheets/application-rtl.css +2 -91
- data/web/assets/stylesheets/application.css +66 -297
- data/web/locales/ar.yml +70 -70
- data/web/locales/cs.yml +62 -62
- data/web/locales/da.yml +60 -53
- data/web/locales/de.yml +65 -65
- data/web/locales/el.yml +43 -24
- data/web/locales/en.yml +82 -69
- data/web/locales/es.yml +68 -68
- data/web/locales/fa.yml +65 -65
- data/web/locales/fr.yml +67 -67
- data/web/locales/he.yml +65 -64
- data/web/locales/hi.yml +59 -59
- data/web/locales/it.yml +53 -53
- data/web/locales/ja.yml +73 -68
- data/web/locales/ko.yml +52 -52
- data/web/locales/lt.yml +66 -66
- data/web/locales/nb.yml +61 -61
- data/web/locales/nl.yml +52 -52
- data/web/locales/pl.yml +45 -45
- data/web/locales/pt-br.yml +63 -55
- data/web/locales/pt.yml +51 -51
- data/web/locales/ru.yml +67 -66
- data/web/locales/sv.yml +53 -53
- data/web/locales/ta.yml +60 -60
- data/web/locales/uk.yml +62 -61
- data/web/locales/ur.yml +64 -64
- data/web/locales/vi.yml +67 -67
- data/web/locales/zh-cn.yml +43 -16
- data/web/locales/zh-tw.yml +42 -8
- data/web/views/_footer.erb +5 -2
- data/web/views/_job_info.erb +18 -2
- data/web/views/_metrics_period_select.erb +12 -0
- data/web/views/_nav.erb +1 -1
- data/web/views/_paging.erb +2 -0
- data/web/views/_poll_link.erb +1 -1
- data/web/views/_summary.erb +1 -1
- data/web/views/busy.erb +42 -26
- data/web/views/dashboard.erb +36 -4
- data/web/views/metrics.erb +82 -0
- data/web/views/metrics_for_job.erb +71 -0
- data/web/views/morgue.erb +5 -9
- data/web/views/queue.erb +15 -15
- data/web/views/queues.erb +3 -1
- data/web/views/retries.erb +5 -9
- data/web/views/scheduled.erb +12 -13
- metadata +64 -28
- data/lib/sidekiq/delay.rb +0 -43
- data/lib/sidekiq/exception_handler.rb +0 -27
- data/lib/sidekiq/extensions/action_mailer.rb +0 -48
- data/lib/sidekiq/extensions/active_record.rb +0 -43
- data/lib/sidekiq/extensions/class_methods.rb +0 -43
- data/lib/sidekiq/extensions/generic_proxy.rb +0 -33
- data/lib/sidekiq/util.rb +0 -108
- data/lib/sidekiq/worker.rb +0 -364
- /data/{LICENSE → LICENSE.txt} +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 69b692f7976998a1655a5c6f108c0a1f686fdcdcde164f6cde071f9ea3f89ced
|
4
|
+
data.tar.gz: d78d581fa48b744789b3af117a55d71bab1037b592f58ee9c74cf2c132716e0c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 42d16710f20a67a94df6498cf1fb5097a8795a5611f058e58d60e43e82503d26871c6d3061b3404590a0e0eba319997cb7e1daec3a88b66c2356e9cc0164a781
|
7
|
+
data.tar.gz: 5b6d9aa7512a67cb552c3a1bed37aa111a877927e7690f53efd3e85aa1ea7049fb75eb05b31232810c8a805f95cb0959a54cc80bafb5c80f9aae0c0701d158b7
|
data/Changes.md
CHANGED
@@ -1,6 +1,175 @@
|
|
1
1
|
# Sidekiq Changes
|
2
2
|
|
3
|
-
[Sidekiq Changes](https://github.com/
|
3
|
+
[Sidekiq Changes](https://github.com/sidekiq/sidekiq/blob/main/Changes.md) | [Sidekiq Pro Changes](https://github.com/sidekiq/sidekiq/blob/main/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/sidekiq/sidekiq/blob/main/Ent-Changes.md)
|
4
|
+
|
5
|
+
7.0.8
|
6
|
+
----------
|
7
|
+
|
8
|
+
- **SECURITY** Sanitize `period` input parameter on Metrics pages.
|
9
|
+
Specially crafted values can lead to XSS. This functionality
|
10
|
+
was introduced in 7.0.4. Thank you to spercex @ huntr.dev [#5694]
|
11
|
+
- Add job hash as 3rd parameter to the `sidekiq_retry_in` block.
|
12
|
+
|
13
|
+
7.0.7
|
14
|
+
----------
|
15
|
+
|
16
|
+
- Fix redis-client API usage which could result in stuck Redis
|
17
|
+
connections [#5823]
|
18
|
+
- Fix AS::Duration with `sidekiq_retry_in` [#5806]
|
19
|
+
- Restore dumping config options on startup with `-v` [#5822]
|
20
|
+
|
21
|
+
7.0.5,7.0.6
|
22
|
+
----------
|
23
|
+
|
24
|
+
- More context for debugging json unsafe errors [#5787]
|
25
|
+
|
26
|
+
7.0.4
|
27
|
+
----------
|
28
|
+
|
29
|
+
- Performance and memory optimizations [#5768, fatkodima]
|
30
|
+
- Add 1-8 hour period selector to Metrics pages [#5694]
|
31
|
+
- Fix process display with `sidekiqmon` [#5733]
|
32
|
+
|
33
|
+
7.0.3
|
34
|
+
----------
|
35
|
+
|
36
|
+
- Don't warn about memory policy on Redis Enterprise [#5712]
|
37
|
+
- Don't allow Quiet/Stop on embedded Sidekiq instances [#5716]
|
38
|
+
- Fix `size: X` for configuring the default Redis pool size [#5702]
|
39
|
+
- Improve the display of queue weights on Busy page [#5642]
|
40
|
+
- Freeze CurrentAttributes on a job once initially set [#5692]
|
41
|
+
|
42
|
+
7.0.2
|
43
|
+
----------
|
44
|
+
|
45
|
+
- Improve compatibility with custom loggers [#5673]
|
46
|
+
- Add queue weights on Busy page [#5640]
|
47
|
+
- Add BID link on job_info page if job is part of a Batch [#5623]
|
48
|
+
- Allow custom extensions to add rows/links within Job detail pages [#5624]
|
49
|
+
```ruby
|
50
|
+
Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
|
51
|
+
|
52
|
+
class AddAccountLink
|
53
|
+
include CGI::Util
|
54
|
+
def add_pair(job)
|
55
|
+
# yield a (name, value) pair
|
56
|
+
# You can include HTML tags and CSS, Sidekiq does not do any
|
57
|
+
# escaping so beware user data injection! Note how we use CGI's
|
58
|
+
# `h` escape helper.
|
59
|
+
aid = job["account_id"]
|
60
|
+
yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
|
61
|
+
end
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
7.0.1
|
66
|
+
----------
|
67
|
+
|
68
|
+
- Allow an embedding process to reuse its own heartbeat thread
|
69
|
+
- Update zh-cn localization
|
70
|
+
|
71
|
+
7.0.0
|
72
|
+
----------
|
73
|
+
|
74
|
+
- Embedded mode!
|
75
|
+
- Capsules!!
|
76
|
+
- Job Execution metrics!!!
|
77
|
+
- See `docs/7.0-Upgrade.md` for release notes
|
78
|
+
|
79
|
+
6.5.8
|
80
|
+
----------
|
81
|
+
|
82
|
+
- Fail if using a bad version of scout_apm [#5616]
|
83
|
+
- Add pagination to Busy page [#5556]
|
84
|
+
- Speed up WorkSet#each [#5559]
|
85
|
+
- Adjust CurrentAttributes to work with the String class name so we aren't referencing the Class within a Rails initializer [#5536]
|
86
|
+
|
87
|
+
6.5.7
|
88
|
+
----------
|
89
|
+
|
90
|
+
- Updates for JA and ZH locales
|
91
|
+
- Further optimizations for scheduled polling [#5513]
|
92
|
+
|
93
|
+
6.5.6
|
94
|
+
----------
|
95
|
+
|
96
|
+
- Fix deprecation warnings with redis-rb 4.8.0 [#5484]
|
97
|
+
- Lock redis-rb to < 5.0 as we are moving to redis-client in Sidekiq 7.0
|
98
|
+
|
99
|
+
6.5.5
|
100
|
+
----------
|
101
|
+
|
102
|
+
- Fix require issue with job_retry.rb [#5462]
|
103
|
+
- Improve Sidekiq::Web compatibility with Rack 3.x
|
104
|
+
|
105
|
+
6.5.4
|
106
|
+
----------
|
107
|
+
|
108
|
+
- Fix invalid code on Ruby 2.5 [#5460]
|
109
|
+
- Fix further metrics dependency issues [#5457]
|
110
|
+
|
111
|
+
6.5.3
|
112
|
+
----------
|
113
|
+
|
114
|
+
- Don't require metrics code without explicit opt-in [#5456]
|
115
|
+
|
116
|
+
6.5.2
|
117
|
+
----------
|
118
|
+
|
119
|
+
- [Job Metrics are under active development, help wanted!](https://github.com/sidekiq/sidekiq/wiki/Metrics#contributing) **BETA**
|
120
|
+
- Add `Context` column on queue page which shows any CurrentAttributes [#5450]
|
121
|
+
- `sidekiq_retry_in` may now return `:discard` or `:kill` to dynamically stop job retries [#5406]
|
122
|
+
- Smarter sorting of processes in /busy Web UI [#5398]
|
123
|
+
- Fix broken hamburger menu in mobile UI [#5428]
|
124
|
+
- Require redis-rb 4.5.0. Note that Sidekiq will break if you use the
|
125
|
+
[`Redis.exists_returns_integer = false`](https://github.com/redis/redis-rb/blob/master/CHANGELOG.md#450) flag. [#5394]
|
126
|
+
|
127
|
+
6.5.1
|
128
|
+
----------
|
129
|
+
|
130
|
+
- Fix `push_bulk` breakage [#5387]
|
131
|
+
|
132
|
+
6.5.0
|
133
|
+
---------
|
134
|
+
|
135
|
+
- Substantial refactoring of Sidekiq server internals, part of a larger effort
|
136
|
+
to reduce Sidekiq's internal usage of global methods and data, see [docs/global_to_local.md](docs/global_to_local.md) and [docs/middleware.md](docs/middleware.md).
|
137
|
+
- **Add beta support for the `redis-client` gem**. This will become the default Redis driver in Sidekiq 7.0. [#5298]
|
138
|
+
Read more: https://github.com/sidekiq/sidekiq/wiki/Using-redis-client
|
139
|
+
- **Add beta support for DB transaction-aware client** [#5291]
|
140
|
+
Add this line to your initializer and any jobs created during a transaction
|
141
|
+
will only be pushed to Redis **after the transaction commits**. You will need to add the
|
142
|
+
`after_commit_everywhere` gem to your Gemfile.
|
143
|
+
```ruby
|
144
|
+
Sidekiq.transactional_push!
|
145
|
+
```
|
146
|
+
This feature does not have a lot of production usage yet; please try it out and let us
|
147
|
+
know if you have any issues. It will be fully supported in Sidekiq 7.0 or removed if it
|
148
|
+
proves problematic.
|
149
|
+
- Fix regression with middleware arguments [#5312]
|
150
|
+
|
151
|
+
6.4.2
|
152
|
+
---------
|
153
|
+
|
154
|
+
- Strict argument checking now runs after client-side middleware [#5246]
|
155
|
+
- Fix page events with live polling [#5184]
|
156
|
+
- Many under-the-hood changes to remove all usage of the term "worker"
|
157
|
+
from the Sidekiq codebase and APIs. This mostly involved RDoc and local
|
158
|
+
variable names but a few constants and public APIs were changed. The old
|
159
|
+
APIs will be removed in Sidekiq 7.0.
|
160
|
+
```
|
161
|
+
Sidekiq::DEFAULT_WORKER_OPTIONS -> Sidekiq.default_job_options
|
162
|
+
Sidekiq.default_worker_options -> Sidekiq.default_job_options
|
163
|
+
Sidekiq::Queues["default"].jobs_by_worker(HardJob) -> Sidekiq::Queues["default"].jobs_by_class(HardJob)
|
164
|
+
```
|
165
|
+
|
166
|
+
6.4.1
|
167
|
+
---------
|
168
|
+
|
169
|
+
- Fix pipeline/multi deprecations in redis-rb 4.6
|
170
|
+
- Fix sidekiq.yml YAML load errors on Ruby 3.1 [#5141]
|
171
|
+
- Sharding support for `perform_bulk` [#5129]
|
172
|
+
- Refactor job logger for SPEEEEEEED
|
4
173
|
|
5
174
|
6.4.0
|
6
175
|
---------
|
@@ -27,7 +196,6 @@ bin/rails generate sidekiq:job ProcessOrderJob
|
|
27
196
|
```
|
28
197
|
- Fix job retries losing CurrentAttributes [#5090]
|
29
198
|
- Tweak shutdown to give long-running threads time to cleanup [#5095]
|
30
|
-
- Add keyword arguments support in extensions
|
31
199
|
|
32
200
|
6.3.1
|
33
201
|
---------
|
@@ -167,7 +335,7 @@ If this is a Rails app in API mode, you need to enable sessions.
|
|
167
335
|
---------
|
168
336
|
|
169
337
|
- **Integrate with systemd's watchdog and notification features** [#4488]
|
170
|
-
Set `Type=notify` in [sidekiq.service](https://github.com/
|
338
|
+
Set `Type=notify` in [sidekiq.service](https://github.com/sidekiq/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
|
171
339
|
- Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
|
172
340
|
- Fix edge case where a job can be pushed without a queue.
|
173
341
|
- Flush job stats at exit [#4498]
|
@@ -180,7 +348,7 @@ If this is a Rails app in API mode, you need to enable sessions.
|
|
180
348
|
- Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
|
181
349
|
- Update APIs to use `UNLINK`, not `DEL`. [#4449]
|
182
350
|
- Fix Ruby 2.7 warnings [#4412]
|
183
|
-
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/
|
351
|
+
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/sidekiq/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
|
184
352
|
|
185
353
|
6.0.4
|
186
354
|
---------
|
@@ -292,7 +460,7 @@ Sidekiq.configure_server do |config|
|
|
292
460
|
config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
|
293
461
|
end
|
294
462
|
```
|
295
|
-
See the [Logging wiki page](https://github.com/
|
463
|
+
See the [Logging wiki page](https://github.com/sidekiq/sidekiq/wiki/Logging) for more details.
|
296
464
|
- **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
|
297
465
|
variable. This variable is meant to hold the name of the environment
|
298
466
|
variable which contains your Redis URL, so that you can switch Redis
|
@@ -312,6 +480,13 @@ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for
|
|
312
480
|
- Integrate the StandardRB code formatter to ensure consistent code
|
313
481
|
styling. [#4114, gearnode]
|
314
482
|
|
483
|
+
5.2.10
|
484
|
+
---------
|
485
|
+
|
486
|
+
- Backport fix for CVE-2022-23837.
|
487
|
+
- Migrate to `exists?` for redis-rb.
|
488
|
+
- Lock redis-rb to <4.6 to avoid deprecations.
|
489
|
+
|
315
490
|
5.2.9
|
316
491
|
---------
|
317
492
|
|
@@ -477,7 +652,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
|
|
477
652
|
- The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
|
478
653
|
- Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
|
479
654
|
of random hex bytes.
|
480
|
-
- Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
|
655
|
+
- Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail.
|
481
656
|
|
482
657
|
4.2.10
|
483
658
|
-----------
|
@@ -695,7 +870,7 @@ Sidekiq::Queues.clear_all
|
|
695
870
|
- Sidekiq's internals have been completely overhauled for performance
|
696
871
|
and to remove dependencies. This has resulted in major speedups, as
|
697
872
|
[detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
|
698
|
-
- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
|
873
|
+
- See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail.
|
699
874
|
|
700
875
|
3.5.4
|
701
876
|
-----------
|
@@ -732,7 +907,7 @@ Sidekiq::Queues.clear_all
|
|
732
907
|
- **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
|
733
908
|
- Add Ukrainian locale [#2561, elrakita]
|
734
909
|
- Disconnect and retry Redis operations if we see a READONLY error [#2550]
|
735
|
-
- Add server middleware testing harness; see [wiki](https://github.com/
|
910
|
+
- Add server middleware testing harness; see [wiki](https://github.com/sidekiq/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
|
736
911
|
|
737
912
|
3.5.0
|
738
913
|
-----------
|
@@ -750,7 +925,7 @@ Sidekiq::Queues.clear_all
|
|
750
925
|
- Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
|
751
926
|
reporting. [#2422] If you are running the Web UI as a standalone Rack app,
|
752
927
|
ensure you have a [session middleware
|
753
|
-
configured](https://github.com/
|
928
|
+
configured](https://github.com/sidekiq/sidekiq/wiki/Monitoring#standalone):
|
754
929
|
```ruby
|
755
930
|
use Rack::Session::Cookie, :secret => "some unique secret string here"
|
756
931
|
```
|
@@ -962,7 +1137,7 @@ sidekiq_options :dead => false, :retry => 5
|
|
962
1137
|
3.0.0
|
963
1138
|
-----------
|
964
1139
|
|
965
|
-
Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
|
1140
|
+
Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes.
|
966
1141
|
|
967
1142
|
- **Dead Job Queue** - jobs which run out of retries are now moved to a dead
|
968
1143
|
job queue. These jobs must be retried manually or they will expire
|
@@ -1006,7 +1181,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
|
|
1006
1181
|
end
|
1007
1182
|
```
|
1008
1183
|
**Sharding support does require a breaking change to client-side
|
1009
|
-
middleware, see 3.0-Upgrade.md.**
|
1184
|
+
middleware, see docs/3.0-Upgrade.md.**
|
1010
1185
|
- New Chinese, Greek, Swedish and Czech translations for the Web UI.
|
1011
1186
|
- Updated most languages translations for the new UI features.
|
1012
1187
|
- **Remove official Capistrano integration** - this integration has been
|
@@ -1134,7 +1309,7 @@ middleware, see 3.0-Upgrade.md.**
|
|
1134
1309
|
appear to be doing any work. [#1194]
|
1135
1310
|
- Sidekiq's testing behavior is now dynamic. You can choose between
|
1136
1311
|
`inline` and `fake` behavior in your tests. See
|
1137
|
-
[Testing](https://github.com/
|
1312
|
+
[Testing](https://github.com/sidekiq/sidekiq/wiki/Testing) for detail. [#1193]
|
1138
1313
|
- The Retries table has a new column for the error message.
|
1139
1314
|
- The Web UI topbar now contains the status and live poll button.
|
1140
1315
|
- Orphaned worker records are now auto-vacuumed when you visit the
|
data/README.md
CHANGED
@@ -2,7 +2,7 @@ Sidekiq
|
|
2
2
|
==============
|
3
3
|
|
4
4
|
[![Gem Version](https://badge.fury.io/rb/sidekiq.svg)](https://rubygems.org/gems/sidekiq)
|
5
|
-
![Build](https://github.com/
|
5
|
+
![Build](https://github.com/sidekiq/sidekiq/workflows/CI/badge.svg)
|
6
6
|
|
7
7
|
Simple, efficient background processing for Ruby.
|
8
8
|
|
@@ -10,82 +10,95 @@ Sidekiq uses threads to handle many jobs at the same time in the
|
|
10
10
|
same process. It does not require Rails but will integrate tightly with
|
11
11
|
Rails to make background processing dead simple.
|
12
12
|
|
13
|
-
Performance
|
14
|
-
---------------
|
15
|
-
|
16
|
-
Version | Latency | Garbage created for 10k jobs | Time to process 100k jobs | Throughput | Ruby
|
17
|
-
-----------------|------|---------|---------|------------------------|-----
|
18
|
-
Sidekiq 6.0.2 | 3 ms | 156 MB | 14.0 sec| **7100 jobs/sec** | MRI 2.6.3
|
19
|
-
Sidekiq 6.0.0 | 3 ms | 156 MB | 19 sec | 5200 jobs/sec | MRI 2.6.3
|
20
|
-
Sidekiq 4.0.0 | 10 ms | 151 MB | 22 sec | 4500 jobs/sec |
|
21
|
-
Sidekiq 3.5.1 | 22 ms | 1257 MB | 125 sec | 800 jobs/sec |
|
22
|
-
Resque 1.25.2 | - | - | 420 sec | 240 jobs/sec |
|
23
|
-
DelayedJob 4.1.1 | - | - | 465 sec | 215 jobs/sec |
|
24
|
-
|
25
|
-
This benchmark can be found in `bin/sidekiqload` and assumes a Redis network latency of 1ms.
|
26
13
|
|
27
14
|
Requirements
|
28
15
|
-----------------
|
29
16
|
|
30
|
-
- Redis:
|
31
|
-
- Ruby: MRI 2.
|
17
|
+
- Redis: 6.2+
|
18
|
+
- Ruby: MRI 2.7+ or JRuby 9.3+.
|
32
19
|
|
33
|
-
Sidekiq
|
20
|
+
Sidekiq 7.0 supports Rails 6.0+ but does not require it.
|
34
21
|
|
35
22
|
|
36
23
|
Installation
|
37
24
|
-----------------
|
38
25
|
|
39
|
-
|
26
|
+
bundle add sidekiq
|
40
27
|
|
41
28
|
|
42
29
|
Getting Started
|
43
30
|
-----------------
|
44
31
|
|
45
|
-
See the [Getting Started wiki page](https://github.com/
|
32
|
+
See the [Getting Started wiki page](https://github.com/sidekiq/sidekiq/wiki/Getting-Started) and follow the simple setup process.
|
46
33
|
You can watch [this YouTube playlist](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1) to learn all about
|
47
34
|
Sidekiq and see its features in action. Here's the Web UI:
|
48
35
|
|
49
|
-
![Web UI](https://github.com/
|
36
|
+
![Web UI](https://github.com/sidekiq/sidekiq/raw/main/examples/web-ui.png)
|
37
|
+
|
38
|
+
Performance
|
39
|
+
---------------
|
40
|
+
|
41
|
+
The benchmark in `bin/sidekiqload` creates 500,000 no-op jobs and drains them as fast as possible, assuming a fixed Redis network latency of 1ms.
|
42
|
+
This requires a lot of Redis network I/O and JSON parsing.
|
43
|
+
This benchmark is IO-bound so we increase the concurrency to 25.
|
44
|
+
If your application is sending lots of emails or performing other network-intensive work, you could see a similar benefit but be careful not to saturate the CPU.
|
45
|
+
|
46
|
+
Version | Time to process 500k jobs | Throughput (jobs/sec) | Ruby | Concurrency | Job Type
|
47
|
+
-----------------|------|---------|---------|------------------------|---
|
48
|
+
Sidekiq 7.0.3 | 21.3 sec| 23,500 | 3.2.0+yjit | 30 | Sidekiq::Job
|
49
|
+
Sidekiq 7.0.3 | 33.8 sec| 14,700 | 3.2.0+yjit | 30 | ActiveJob 7.0.4
|
50
|
+
Sidekiq 7.0.3 | 23.5 sec| 21,300 | 3.2.0 | 30 | Sidekiq::Job
|
51
|
+
Sidekiq 7.0.3 | 46.5 sec| 10,700 | 3.2.0 | 30 | ActiveJob 7.0.4
|
52
|
+
Sidekiq 7.0.3 | 23.0 sec| 21,700 | 2.7.5 | 30 | Sidekiq::Job
|
53
|
+
Sidekiq 7.0.3 | 46.5 sec| 10,850 | 2.7.5 | 30 | ActiveJob 7.0.4
|
50
54
|
|
55
|
+
Most of Sidekiq's overhead is Redis network I/O.
|
56
|
+
ActiveJob adds a notable amount of CPU overhead due to argument deserialization and callbacks.
|
57
|
+
Concurrency of 30 was determined experimentally to maximize one CPU without saturating it.
|
51
58
|
|
52
59
|
Want to Upgrade?
|
53
60
|
-------------------
|
54
61
|
|
62
|
+
Use `bundle up sidekiq` to upgrade Sidekiq and all its dependencies.
|
63
|
+
Upgrade notes between each major version can be found in the `docs/` directory.
|
64
|
+
|
55
65
|
I also sell Sidekiq Pro and Sidekiq Enterprise, extensions to Sidekiq which provide more
|
56
66
|
features, a commercial-friendly license and allow you to support high
|
57
67
|
quality open source development all at the same time. Please see the
|
58
68
|
[Sidekiq](https://sidekiq.org/) homepage for more detail.
|
59
69
|
|
60
|
-
Subscribe to the **[quarterly newsletter](https://tinyletter.com/sidekiq)** to stay informed about the latest
|
61
|
-
features and changes to Sidekiq and its bigger siblings.
|
62
|
-
|
63
70
|
|
64
71
|
Problems?
|
65
72
|
-----------------
|
66
73
|
|
67
|
-
**Please do not directly email any Sidekiq committers with questions or problems.**
|
74
|
+
**Please do not directly email any Sidekiq committers with questions or problems.**
|
75
|
+
A community is best served when discussions are held in public.
|
68
76
|
|
69
|
-
If you have a problem, please review the [FAQ](https://github.com/
|
70
|
-
Searching the [issues](https://github.com/
|
77
|
+
If you have a problem, please review the [FAQ](https://github.com/sidekiq/sidekiq/wiki/FAQ) and [Troubleshooting](https://github.com/sidekiq/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages.
|
78
|
+
Searching the [issues](https://github.com/sidekiq/sidekiq/issues) for your problem is also a good idea.
|
71
79
|
|
72
|
-
Sidekiq Pro and Sidekiq Enterprise customers get private email support.
|
80
|
+
Sidekiq Pro and Sidekiq Enterprise customers get private email support.
|
81
|
+
You can purchase at https://sidekiq.org; email support@contribsys.com for help.
|
73
82
|
|
74
83
|
Useful resources:
|
75
84
|
|
76
|
-
* Product documentation is in the [wiki](https://github.com/
|
85
|
+
* Product documentation is in the [wiki](https://github.com/sidekiq/sidekiq/wiki).
|
77
86
|
* Occasional announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
|
78
87
|
* The [Sidekiq tag](https://stackoverflow.com/questions/tagged/sidekiq) on Stack Overflow has lots of useful Q & A.
|
79
88
|
|
80
|
-
Every Friday morning is Sidekiq
|
89
|
+
Every Friday morning is Sidekiq office hour: I video chat and answer questions.
|
81
90
|
See the [Sidekiq support page](https://sidekiq.org/support.html) for details.
|
82
91
|
|
92
|
+
Contributing
|
93
|
+
-----------------
|
94
|
+
|
95
|
+
Please see [the contributing guidelines](https://github.com/sidekiq/sidekiq/blob/main/.github/contributing.md).
|
83
96
|
|
84
97
|
License
|
85
98
|
-----------------
|
86
99
|
|
87
|
-
Please see [LICENSE](https://github.com/
|
88
|
-
|
100
|
+
Please see [LICENSE.txt](https://github.com/sidekiq/sidekiq/blob/main/LICENSE.txt) for licensing details.
|
101
|
+
The license for Sidekiq Pro and Sidekiq Enterprise can be found in [COMM-LICENSE.txt](https://github.com/sidekiq/sidekiq/blob/main/COMM-LICENSE.txt).
|
89
102
|
|
90
103
|
Author
|
91
104
|
-----------------
|
data/bin/sidekiq
CHANGED
@@ -4,13 +4,13 @@
|
|
4
4
|
# RUBYOPT=-w bundle exec sidekiq
|
5
5
|
$TESTING = false
|
6
6
|
|
7
|
-
require_relative
|
7
|
+
require_relative "../lib/sidekiq/cli"
|
8
8
|
|
9
9
|
def integrate_with_systemd
|
10
10
|
return unless ENV["NOTIFY_SOCKET"]
|
11
11
|
|
12
12
|
Sidekiq.configure_server do |config|
|
13
|
-
|
13
|
+
config.logger.info "Enabling systemd notification integration"
|
14
14
|
require "sidekiq/sd_notify"
|
15
15
|
config.on(:startup) do
|
16
16
|
Sidekiq::SdNotify.ready
|
@@ -31,12 +31,7 @@ begin
|
|
31
31
|
cli.run
|
32
32
|
rescue => e
|
33
33
|
raise e if $DEBUG
|
34
|
-
|
35
|
-
|
36
|
-
STDERR.puts e.backtrace.join("\n")
|
37
|
-
else
|
38
|
-
cli.handle_exception e
|
39
|
-
end
|
40
|
-
|
34
|
+
warn e.message
|
35
|
+
warn e.backtrace.join("\n")
|
41
36
|
exit 1
|
42
37
|
end
|