sidekiq 6.3.1 → 7.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Changes.md +285 -11
- data/LICENSE.txt +9 -0
- data/README.md +47 -34
- data/bin/sidekiq +4 -9
- data/bin/sidekiqload +207 -117
- data/bin/sidekiqmon +4 -1
- data/lib/generators/sidekiq/job_generator.rb +57 -0
- data/lib/generators/sidekiq/templates/{worker.rb.erb → job.rb.erb} +2 -2
- data/lib/generators/sidekiq/templates/{worker_spec.rb.erb → job_spec.rb.erb} +1 -1
- data/lib/generators/sidekiq/templates/{worker_test.rb.erb → job_test.rb.erb} +1 -1
- data/lib/sidekiq/api.rb +333 -190
- data/lib/sidekiq/capsule.rb +127 -0
- data/lib/sidekiq/cli.rb +86 -80
- data/lib/sidekiq/client.rb +104 -95
- data/lib/sidekiq/{util.rb → component.rb} +14 -41
- data/lib/sidekiq/config.rb +282 -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 +371 -10
- data/lib/sidekiq/job_logger.rb +16 -28
- data/lib/sidekiq/job_retry.rb +99 -58
- data/lib/sidekiq/job_util.rb +107 -0
- data/lib/sidekiq/launcher.rb +103 -95
- data/lib/sidekiq/logger.rb +9 -44
- data/lib/sidekiq/manager.rb +40 -41
- 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 +59 -16
- 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 +81 -80
- data/lib/sidekiq/rails.rb +21 -14
- data/lib/sidekiq/redis_client_adapter.rb +95 -0
- data/lib/sidekiq/redis_connection.rb +14 -82
- data/lib/sidekiq/ring_buffer.rb +29 -0
- data/lib/sidekiq/scheduled.rb +76 -38
- data/lib/sidekiq/testing/inline.rb +4 -4
- data/lib/sidekiq/testing.rb +42 -69
- 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 +95 -11
- data/lib/sidekiq/web/csrf_protection.rb +4 -4
- data/lib/sidekiq/web/helpers.rb +58 -30
- data/lib/sidekiq/web.rb +22 -17
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +85 -202
- data/sidekiq.gemspec +12 -10
- data/web/assets/javascripts/application.js +77 -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 +168 -0
- data/web/assets/javascripts/dashboard.js +3 -240
- data/web/assets/javascripts/metrics.js +264 -0
- data/web/assets/stylesheets/application-dark.css +17 -17
- data/web/assets/stylesheets/application-rtl.css +2 -91
- data/web/assets/stylesheets/application.css +69 -302
- 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 +84 -69
- data/web/locales/es.yml +68 -68
- data/web/locales/fa.yml +65 -65
- data/web/locales/fr.yml +81 -67
- data/web/locales/gd.yml +99 -0
- 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 +83 -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 +44 -28
- data/web/views/dashboard.erb +36 -4
- data/web/views/filtering.erb +7 -0
- data/web/views/metrics.erb +82 -0
- data/web/views/metrics_for_job.erb +68 -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 +62 -31
- data/LICENSE +0 -9
- data/lib/generators/sidekiq/worker_generator.rb +0 -57
- data/lib/sidekiq/delay.rb +0 -41
- 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/worker.rb +0 -311
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b9e59dd929beab7b591592800b1b38d7683728b6f6b09e0c3a6b1e7c86ce524f
|
4
|
+
data.tar.gz: 27009dd8f71c92bbde9378a4ee1b39a5122ad2c241a9ebb6b55ea295795c87be
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 10f292d33bb676892789806030f5e9d54d55bcbd7b22431e10f08b8fe7add524a712e16d9e03c8d1913538809468fdc3cff05cfd60188520ba0c015421d100b3
|
7
|
+
data.tar.gz: ab4e2225a3aced675ad7bcd65dd377689c7bb2131a828eaab8044b9fbefa68516bac48fd0825f318a13559a797b3f0f547bb6681394aebf14c911bdcbf8817c9
|
data/Changes.md
CHANGED
@@ -1,6 +1,273 @@
|
|
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.1.5
|
6
|
+
----------
|
7
|
+
|
8
|
+
- **FEATURE**: Job filtering within the Web UI. This feature has been open
|
9
|
+
sourced from Sidekiq Pro. [#6052]
|
10
|
+
- **API CHANGE** Error handlers now take three arguments `->(ex, context, config)`.
|
11
|
+
The previous calling convention will work until Sidekiq 8.0 but will print
|
12
|
+
out a deprecation warning. [#6051]
|
13
|
+
- Fix issue with the `batch_size` and `at` options in `S::Client.push_bulk` [#6040]
|
14
|
+
- Fix inline testing firing batch callbacks early [#6057]
|
15
|
+
- Use new log broadcast API in Rails 7.1 [#6054]
|
16
|
+
- Crash if user tries to use RESP2 `protocol: 2` [#6061]
|
17
|
+
|
18
|
+
7.1.4
|
19
|
+
----------
|
20
|
+
|
21
|
+
- Fix empty `retry_for` logic [#6035]
|
22
|
+
|
23
|
+
7.1.3
|
24
|
+
----------
|
25
|
+
|
26
|
+
- Add `sidekiq_options retry_for: 48.hours` to allow time-based retry windows [#6029]
|
27
|
+
- Support sidekiq_retry_in and sidekiq_retries_exhausted_block in ActiveJobs (#5994)
|
28
|
+
- Lowercase all Rack headers for Rack 3.0 [#5951]
|
29
|
+
- Validate Sidekiq::Web page refresh delay to avoid potential DoS,
|
30
|
+
CVE-2023-26141, thanks for reporting Keegan!
|
31
|
+
|
32
|
+
7.1.2
|
33
|
+
----------
|
34
|
+
|
35
|
+
- Mark Web UI assets as private so CDNs won't cache them [#5936]
|
36
|
+
- Fix stackoverflow when using Oj and the JSON log formatter [#5920]
|
37
|
+
- Remove spurious `enqueued_at` from scheduled ActiveJobs [#5937]
|
38
|
+
|
39
|
+
7.1.1
|
40
|
+
----------
|
41
|
+
|
42
|
+
- Support multiple CurrentAttributes [#5904]
|
43
|
+
- Speed up latency fetch with large queues on Redis <7 [#5910]
|
44
|
+
- Allow a larger default client pool [#5886]
|
45
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
46
|
+
|
47
|
+
7.1.0
|
48
|
+
----------
|
49
|
+
|
50
|
+
- Improve display of ActiveJob arguments in Web UI [#5825, cover]
|
51
|
+
- Update `push_bulk` to push `batch_size` jobs at a time and allow laziness [#5827, fatkodima]
|
52
|
+
This allows Sidekiq::Client to push unlimited jobs as long as it has enough memory for the batch_size.
|
53
|
+
- Update `perform_bulk` to use `push_bulk` internally.
|
54
|
+
- Change return value of `push_bulk` to map 1-to-1 with arguments.
|
55
|
+
If you call `push_bulk(args: [[1], [2], [3]])`, you will now always get
|
56
|
+
an array of 3 values as the result: `["jid1", nil, "jid3"]` where nil means
|
57
|
+
that particular job did not push successfully (possibly due to middleware
|
58
|
+
stopping it). Previously nil values were removed so it was impossible to tell
|
59
|
+
which jobs pushed successfully and which did not.
|
60
|
+
- Migrate away from all deprecated Redis commands [#5788]
|
61
|
+
Sidekiq will now print a warning if you use one of those deprecated commands.
|
62
|
+
- Prefix all Sidekiq thread names [#5872]
|
63
|
+
|
64
|
+
7.0.9
|
65
|
+
----------
|
66
|
+
|
67
|
+
- Restore confirmation dialogs in Web UI [#5881, shevaun]
|
68
|
+
- Increase fetch timeout to minimize ReadTimeoutError [#5874]
|
69
|
+
- Reverse histogram tooltip ordering [#5868]
|
70
|
+
- Add Scottish Gaelic (gd) locale [#5867, GunChleoc]
|
71
|
+
|
72
|
+
7.0.8
|
73
|
+
----------
|
74
|
+
|
75
|
+
- **SECURITY** Sanitize `period` input parameter on Metrics pages.
|
76
|
+
Specially crafted values can lead to XSS. This functionality
|
77
|
+
was introduced in 7.0.4. Thank you to spercex @ huntr.dev [#5694]
|
78
|
+
- Add job hash as 3rd parameter to the `sidekiq_retry_in` block.
|
79
|
+
|
80
|
+
7.0.7
|
81
|
+
----------
|
82
|
+
|
83
|
+
- Fix redis-client API usage which could result in stuck Redis
|
84
|
+
connections [#5823]
|
85
|
+
- Fix AS::Duration with `sidekiq_retry_in` [#5806]
|
86
|
+
- Restore dumping config options on startup with `-v` [#5822]
|
87
|
+
|
88
|
+
7.0.5,7.0.6
|
89
|
+
----------
|
90
|
+
|
91
|
+
- More context for debugging json unsafe errors [#5787]
|
92
|
+
|
93
|
+
7.0.4
|
94
|
+
----------
|
95
|
+
|
96
|
+
- Performance and memory optimizations [#5768, fatkodima]
|
97
|
+
- Add 1-8 hour period selector to Metrics pages [#5694]
|
98
|
+
- Fix process display with `sidekiqmon` [#5733]
|
99
|
+
|
100
|
+
7.0.3
|
101
|
+
----------
|
102
|
+
|
103
|
+
- Don't warn about memory policy on Redis Enterprise [#5712]
|
104
|
+
- Don't allow Quiet/Stop on embedded Sidekiq instances [#5716]
|
105
|
+
- Fix `size: X` for configuring the default Redis pool size [#5702]
|
106
|
+
- Improve the display of queue weights on Busy page [#5642]
|
107
|
+
- Freeze CurrentAttributes on a job once initially set [#5692]
|
108
|
+
|
109
|
+
7.0.2
|
110
|
+
----------
|
111
|
+
|
112
|
+
- Improve compatibility with custom loggers [#5673]
|
113
|
+
- Add queue weights on Busy page [#5640]
|
114
|
+
- Add BID link on job_info page if job is part of a Batch [#5623]
|
115
|
+
- Allow custom extensions to add rows/links within Job detail pages [#5624]
|
116
|
+
```ruby
|
117
|
+
Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
|
118
|
+
|
119
|
+
class AddAccountLink
|
120
|
+
include CGI::Util
|
121
|
+
def add_pair(job)
|
122
|
+
# yield a (name, value) pair
|
123
|
+
# You can include HTML tags and CSS, Sidekiq does not do any
|
124
|
+
# escaping so beware user data injection! Note how we use CGI's
|
125
|
+
# `h` escape helper.
|
126
|
+
aid = job["account_id"]
|
127
|
+
yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
|
128
|
+
end
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
7.0.1
|
133
|
+
----------
|
134
|
+
|
135
|
+
- Allow an embedding process to reuse its own heartbeat thread
|
136
|
+
- Update zh-cn localization
|
137
|
+
|
138
|
+
7.0.0
|
139
|
+
----------
|
140
|
+
|
141
|
+
- Embedded mode!
|
142
|
+
- Capsules!!
|
143
|
+
- Job Execution metrics!!!
|
144
|
+
- See `docs/7.0-Upgrade.md` for release notes
|
145
|
+
|
146
|
+
6.5.9
|
147
|
+
----------
|
148
|
+
|
149
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
150
|
+
|
151
|
+
6.5.8
|
152
|
+
----------
|
153
|
+
|
154
|
+
- Fail if using a bad version of scout_apm [#5616]
|
155
|
+
- Add pagination to Busy page [#5556]
|
156
|
+
- Speed up WorkSet#each [#5559]
|
157
|
+
- Adjust CurrentAttributes to work with the String class name so we aren't referencing the Class within a Rails initializer [#5536]
|
158
|
+
|
159
|
+
6.5.7
|
160
|
+
----------
|
161
|
+
|
162
|
+
- Updates for JA and ZH locales
|
163
|
+
- Further optimizations for scheduled polling [#5513]
|
164
|
+
|
165
|
+
6.5.6
|
166
|
+
----------
|
167
|
+
|
168
|
+
- Fix deprecation warnings with redis-rb 4.8.0 [#5484]
|
169
|
+
- Lock redis-rb to < 5.0 as we are moving to redis-client in Sidekiq 7.0
|
170
|
+
|
171
|
+
6.5.5
|
172
|
+
----------
|
173
|
+
|
174
|
+
- Fix require issue with job_retry.rb [#5462]
|
175
|
+
- Improve Sidekiq::Web compatibility with Rack 3.x
|
176
|
+
|
177
|
+
6.5.4
|
178
|
+
----------
|
179
|
+
|
180
|
+
- Fix invalid code on Ruby 2.5 [#5460]
|
181
|
+
- Fix further metrics dependency issues [#5457]
|
182
|
+
|
183
|
+
6.5.3
|
184
|
+
----------
|
185
|
+
|
186
|
+
- Don't require metrics code without explicit opt-in [#5456]
|
187
|
+
|
188
|
+
6.5.2
|
189
|
+
----------
|
190
|
+
|
191
|
+
- [Job Metrics are under active development, help wanted!](https://github.com/sidekiq/sidekiq/wiki/Metrics#contributing) **BETA**
|
192
|
+
- Add `Context` column on queue page which shows any CurrentAttributes [#5450]
|
193
|
+
- `sidekiq_retry_in` may now return `:discard` or `:kill` to dynamically stop job retries [#5406]
|
194
|
+
- Smarter sorting of processes in /busy Web UI [#5398]
|
195
|
+
- Fix broken hamburger menu in mobile UI [#5428]
|
196
|
+
- Require redis-rb 4.5.0. Note that Sidekiq will break if you use the
|
197
|
+
[`Redis.exists_returns_integer = false`](https://github.com/redis/redis-rb/blob/master/CHANGELOG.md#450) flag. [#5394]
|
198
|
+
|
199
|
+
6.5.1
|
200
|
+
----------
|
201
|
+
|
202
|
+
- Fix `push_bulk` breakage [#5387]
|
203
|
+
|
204
|
+
6.5.0
|
205
|
+
---------
|
206
|
+
|
207
|
+
- Substantial refactoring of Sidekiq server internals, part of a larger effort
|
208
|
+
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).
|
209
|
+
- **Add beta support for the `redis-client` gem**. This will become the default Redis driver in Sidekiq 7.0. [#5298]
|
210
|
+
Read more: https://github.com/sidekiq/sidekiq/wiki/Using-redis-client
|
211
|
+
- **Add beta support for DB transaction-aware client** [#5291]
|
212
|
+
Add this line to your initializer and any jobs created during a transaction
|
213
|
+
will only be pushed to Redis **after the transaction commits**. You will need to add the
|
214
|
+
`after_commit_everywhere` gem to your Gemfile.
|
215
|
+
```ruby
|
216
|
+
Sidekiq.transactional_push!
|
217
|
+
```
|
218
|
+
This feature does not have a lot of production usage yet; please try it out and let us
|
219
|
+
know if you have any issues. It will be fully supported in Sidekiq 7.0 or removed if it
|
220
|
+
proves problematic.
|
221
|
+
- Fix regression with middleware arguments [#5312]
|
222
|
+
|
223
|
+
6.4.2
|
224
|
+
---------
|
225
|
+
|
226
|
+
- Strict argument checking now runs after client-side middleware [#5246]
|
227
|
+
- Fix page events with live polling [#5184]
|
228
|
+
- Many under-the-hood changes to remove all usage of the term "worker"
|
229
|
+
from the Sidekiq codebase and APIs. This mostly involved RDoc and local
|
230
|
+
variable names but a few constants and public APIs were changed. The old
|
231
|
+
APIs will be removed in Sidekiq 7.0.
|
232
|
+
```
|
233
|
+
Sidekiq::DEFAULT_WORKER_OPTIONS -> Sidekiq.default_job_options
|
234
|
+
Sidekiq.default_worker_options -> Sidekiq.default_job_options
|
235
|
+
Sidekiq::Queues["default"].jobs_by_worker(HardJob) -> Sidekiq::Queues["default"].jobs_by_class(HardJob)
|
236
|
+
```
|
237
|
+
|
238
|
+
6.4.1
|
239
|
+
---------
|
240
|
+
|
241
|
+
- Fix pipeline/multi deprecations in redis-rb 4.6
|
242
|
+
- Fix sidekiq.yml YAML load errors on Ruby 3.1 [#5141]
|
243
|
+
- Sharding support for `perform_bulk` [#5129]
|
244
|
+
- Refactor job logger for SPEEEEEEED
|
245
|
+
|
246
|
+
6.4.0
|
247
|
+
---------
|
248
|
+
|
249
|
+
- **SECURITY**: Validate input to avoid possible DoS in Web UI.
|
250
|
+
- Add **strict argument checking** [#5071]
|
251
|
+
Sidekiq will now log a warning if JSON-unsafe arguments are passed to `perform_async`.
|
252
|
+
Add `Sidekiq.strict_args!(false)` to your initializer to disable this warning.
|
253
|
+
This warning will switch to an exception in Sidekiq 7.0.
|
254
|
+
- Note that Delayed Extensions will be removed in Sidekiq 7.0 [#5076]
|
255
|
+
- Add `perform_{inline,sync}` in Sidekiq::Job to run a job synchronously [#5061, hasan-ally]
|
256
|
+
```ruby
|
257
|
+
SomeJob.perform_async(args...)
|
258
|
+
SomeJob.perform_sync(args...)
|
259
|
+
SomeJob.perform_inline(args...)
|
260
|
+
```
|
261
|
+
You can also dynamically redirect a job to run synchronously:
|
262
|
+
```ruby
|
263
|
+
SomeJob.set("sync": true).perform_async(args...) # will run via perform_inline
|
264
|
+
```
|
265
|
+
- Replace Sidekiq::Worker `app/workers` generator with Sidekiq::Job `app/sidekiq` generator [#5055]
|
266
|
+
```
|
267
|
+
bin/rails generate sidekiq:job ProcessOrderJob
|
268
|
+
```
|
269
|
+
- Fix job retries losing CurrentAttributes [#5090]
|
270
|
+
- Tweak shutdown to give long-running threads time to cleanup [#5095]
|
4
271
|
|
5
272
|
6.3.1
|
6
273
|
---------
|
@@ -140,7 +407,7 @@ If this is a Rails app in API mode, you need to enable sessions.
|
|
140
407
|
---------
|
141
408
|
|
142
409
|
- **Integrate with systemd's watchdog and notification features** [#4488]
|
143
|
-
Set `Type=notify` in [sidekiq.service](https://github.com/
|
410
|
+
Set `Type=notify` in [sidekiq.service](https://github.com/sidekiq/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
|
144
411
|
- Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
|
145
412
|
- Fix edge case where a job can be pushed without a queue.
|
146
413
|
- Flush job stats at exit [#4498]
|
@@ -153,7 +420,7 @@ If this is a Rails app in API mode, you need to enable sessions.
|
|
153
420
|
- Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
|
154
421
|
- Update APIs to use `UNLINK`, not `DEL`. [#4449]
|
155
422
|
- Fix Ruby 2.7 warnings [#4412]
|
156
|
-
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/
|
423
|
+
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/sidekiq/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
|
157
424
|
|
158
425
|
6.0.4
|
159
426
|
---------
|
@@ -265,7 +532,7 @@ Sidekiq.configure_server do |config|
|
|
265
532
|
config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
|
266
533
|
end
|
267
534
|
```
|
268
|
-
See the [Logging wiki page](https://github.com/
|
535
|
+
See the [Logging wiki page](https://github.com/sidekiq/sidekiq/wiki/Logging) for more details.
|
269
536
|
- **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
|
270
537
|
variable. This variable is meant to hold the name of the environment
|
271
538
|
variable which contains your Redis URL, so that you can switch Redis
|
@@ -285,6 +552,13 @@ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for
|
|
285
552
|
- Integrate the StandardRB code formatter to ensure consistent code
|
286
553
|
styling. [#4114, gearnode]
|
287
554
|
|
555
|
+
5.2.10
|
556
|
+
---------
|
557
|
+
|
558
|
+
- Backport fix for CVE-2022-23837.
|
559
|
+
- Migrate to `exists?` for redis-rb.
|
560
|
+
- Lock redis-rb to <4.6 to avoid deprecations.
|
561
|
+
|
288
562
|
5.2.9
|
289
563
|
---------
|
290
564
|
|
@@ -450,7 +724,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
|
|
450
724
|
- The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
|
451
725
|
- Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
|
452
726
|
of random hex bytes.
|
453
|
-
- Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
|
727
|
+
- Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail.
|
454
728
|
|
455
729
|
4.2.10
|
456
730
|
-----------
|
@@ -668,7 +942,7 @@ Sidekiq::Queues.clear_all
|
|
668
942
|
- Sidekiq's internals have been completely overhauled for performance
|
669
943
|
and to remove dependencies. This has resulted in major speedups, as
|
670
944
|
[detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
|
671
|
-
- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
|
945
|
+
- See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail.
|
672
946
|
|
673
947
|
3.5.4
|
674
948
|
-----------
|
@@ -705,7 +979,7 @@ Sidekiq::Queues.clear_all
|
|
705
979
|
- **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
|
706
980
|
- Add Ukrainian locale [#2561, elrakita]
|
707
981
|
- Disconnect and retry Redis operations if we see a READONLY error [#2550]
|
708
|
-
- Add server middleware testing harness; see [wiki](https://github.com/
|
982
|
+
- Add server middleware testing harness; see [wiki](https://github.com/sidekiq/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
|
709
983
|
|
710
984
|
3.5.0
|
711
985
|
-----------
|
@@ -723,7 +997,7 @@ Sidekiq::Queues.clear_all
|
|
723
997
|
- Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
|
724
998
|
reporting. [#2422] If you are running the Web UI as a standalone Rack app,
|
725
999
|
ensure you have a [session middleware
|
726
|
-
configured](https://github.com/
|
1000
|
+
configured](https://github.com/sidekiq/sidekiq/wiki/Monitoring#standalone):
|
727
1001
|
```ruby
|
728
1002
|
use Rack::Session::Cookie, :secret => "some unique secret string here"
|
729
1003
|
```
|
@@ -935,7 +1209,7 @@ sidekiq_options :dead => false, :retry => 5
|
|
935
1209
|
3.0.0
|
936
1210
|
-----------
|
937
1211
|
|
938
|
-
Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
|
1212
|
+
Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes.
|
939
1213
|
|
940
1214
|
- **Dead Job Queue** - jobs which run out of retries are now moved to a dead
|
941
1215
|
job queue. These jobs must be retried manually or they will expire
|
@@ -979,7 +1253,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
|
|
979
1253
|
end
|
980
1254
|
```
|
981
1255
|
**Sharding support does require a breaking change to client-side
|
982
|
-
middleware, see 3.0-Upgrade.md.**
|
1256
|
+
middleware, see docs/3.0-Upgrade.md.**
|
983
1257
|
- New Chinese, Greek, Swedish and Czech translations for the Web UI.
|
984
1258
|
- Updated most languages translations for the new UI features.
|
985
1259
|
- **Remove official Capistrano integration** - this integration has been
|
@@ -1107,7 +1381,7 @@ middleware, see 3.0-Upgrade.md.**
|
|
1107
1381
|
appear to be doing any work. [#1194]
|
1108
1382
|
- Sidekiq's testing behavior is now dynamic. You can choose between
|
1109
1383
|
`inline` and `fake` behavior in your tests. See
|
1110
|
-
[Testing](https://github.com/
|
1384
|
+
[Testing](https://github.com/sidekiq/sidekiq/wiki/Testing) for detail. [#1193]
|
1111
1385
|
- The Retries table has a new column for the error message.
|
1112
1386
|
- The Web UI topbar now contains the status and live poll button.
|
1113
1387
|
- Orphaned worker records are now auto-vacuumed when you visit the
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
Copyright (c) Contributed Systems LLC
|
2
|
+
|
3
|
+
Sidekiq is an Open Source project licensed under the terms of
|
4
|
+
the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
|
5
|
+
for license text.
|
6
|
+
|
7
|
+
Sidekiq Pro and Sidekiq Enterprise have a commercial-friendly license.
|
8
|
+
You can find the commercial license in COMM-LICENSE.txt.
|
9
|
+
Please see https://sidekiq.org for purchasing options.
|
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,84 +10,97 @@ 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/
|
46
|
-
You can watch [this
|
32
|
+
See the [Getting Started wiki page](https://github.com/sidekiq/sidekiq/wiki/Getting-Started) and follow the simple setup process.
|
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/
|
77
|
-
* Occasional announcements are made to the [@sidekiq](https://
|
85
|
+
* Product documentation is in the [wiki](https://github.com/sidekiq/sidekiq/wiki).
|
86
|
+
* Occasional announcements are made to the [@sidekiq](https://ruby.social/@sidekiq) Mastodon 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
|
-----------------
|
92
105
|
|
93
|
-
Mike Perham, [@getajobmike](https://
|
106
|
+
Mike Perham, [@getajobmike](https://ruby.social/@getajobmike) / [@sidekiq](https://ruby.social/@sidekiq), [https://www.mikeperham.com](https://www.mikeperham.com) / [https://www.contribsys.com](https://www.contribsys.com)
|
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
|