sidekiq 5.2.1 → 6.4.0

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.

Files changed (106) hide show
  1. checksums.yaml +5 -5
  2. data/Changes.md +368 -1
  3. data/LICENSE +3 -3
  4. data/README.md +21 -37
  5. data/bin/sidekiq +26 -2
  6. data/bin/sidekiqload +33 -25
  7. data/bin/sidekiqmon +8 -0
  8. data/lib/generators/sidekiq/job_generator.rb +57 -0
  9. data/lib/generators/sidekiq/templates/{worker.rb.erb → job.rb.erb} +2 -2
  10. data/lib/generators/sidekiq/templates/{worker_spec.rb.erb → job_spec.rb.erb} +1 -1
  11. data/lib/generators/sidekiq/templates/{worker_test.rb.erb → job_test.rb.erb} +1 -1
  12. data/lib/sidekiq/api.rb +316 -246
  13. data/lib/sidekiq/cli.rb +195 -221
  14. data/lib/sidekiq/client.rb +42 -60
  15. data/lib/sidekiq/delay.rb +7 -6
  16. data/lib/sidekiq/exception_handler.rb +10 -12
  17. data/lib/sidekiq/extensions/action_mailer.rb +15 -24
  18. data/lib/sidekiq/extensions/active_record.rb +15 -12
  19. data/lib/sidekiq/extensions/class_methods.rb +16 -13
  20. data/lib/sidekiq/extensions/generic_proxy.rb +8 -6
  21. data/lib/sidekiq/fetch.rb +39 -31
  22. data/lib/sidekiq/job.rb +13 -0
  23. data/lib/sidekiq/job_logger.rb +47 -9
  24. data/lib/sidekiq/job_retry.rb +88 -68
  25. data/lib/sidekiq/job_util.rb +65 -0
  26. data/lib/sidekiq/launcher.rb +151 -61
  27. data/lib/sidekiq/logger.rb +166 -0
  28. data/lib/sidekiq/manager.rb +18 -22
  29. data/lib/sidekiq/middleware/chain.rb +20 -8
  30. data/lib/sidekiq/middleware/current_attributes.rb +57 -0
  31. data/lib/sidekiq/middleware/i18n.rb +5 -7
  32. data/lib/sidekiq/monitor.rb +133 -0
  33. data/lib/sidekiq/paginator.rb +18 -14
  34. data/lib/sidekiq/processor.rb +116 -82
  35. data/lib/sidekiq/rails.rb +42 -38
  36. data/lib/sidekiq/redis_connection.rb +49 -30
  37. data/lib/sidekiq/scheduled.rb +62 -28
  38. data/lib/sidekiq/sd_notify.rb +149 -0
  39. data/lib/sidekiq/systemd.rb +24 -0
  40. data/lib/sidekiq/testing/inline.rb +2 -1
  41. data/lib/sidekiq/testing.rb +36 -27
  42. data/lib/sidekiq/util.rb +57 -15
  43. data/lib/sidekiq/version.rb +2 -1
  44. data/lib/sidekiq/web/action.rb +15 -11
  45. data/lib/sidekiq/web/application.rb +95 -76
  46. data/lib/sidekiq/web/csrf_protection.rb +180 -0
  47. data/lib/sidekiq/web/helpers.rb +115 -91
  48. data/lib/sidekiq/web/router.rb +23 -19
  49. data/lib/sidekiq/web.rb +61 -105
  50. data/lib/sidekiq/worker.rb +259 -99
  51. data/lib/sidekiq.rb +79 -45
  52. data/sidekiq.gemspec +23 -18
  53. data/web/assets/images/apple-touch-icon.png +0 -0
  54. data/web/assets/javascripts/application.js +83 -64
  55. data/web/assets/javascripts/dashboard.js +66 -75
  56. data/web/assets/stylesheets/application-dark.css +143 -0
  57. data/web/assets/stylesheets/application-rtl.css +0 -4
  58. data/web/assets/stylesheets/application.css +75 -231
  59. data/web/assets/stylesheets/bootstrap.css +1 -1
  60. data/web/locales/ar.yml +9 -2
  61. data/web/locales/de.yml +14 -2
  62. data/web/locales/en.yml +7 -1
  63. data/web/locales/es.yml +18 -2
  64. data/web/locales/fr.yml +10 -3
  65. data/web/locales/ja.yml +7 -1
  66. data/web/locales/lt.yml +83 -0
  67. data/web/locales/pl.yml +4 -4
  68. data/web/locales/ru.yml +4 -0
  69. data/web/locales/vi.yml +83 -0
  70. data/web/views/_footer.erb +1 -1
  71. data/web/views/_job_info.erb +3 -2
  72. data/web/views/_nav.erb +3 -17
  73. data/web/views/_poll_link.erb +2 -5
  74. data/web/views/_summary.erb +7 -7
  75. data/web/views/busy.erb +54 -20
  76. data/web/views/dashboard.erb +22 -14
  77. data/web/views/dead.erb +3 -3
  78. data/web/views/layout.erb +3 -1
  79. data/web/views/morgue.erb +9 -6
  80. data/web/views/queue.erb +20 -10
  81. data/web/views/queues.erb +11 -3
  82. data/web/views/retries.erb +14 -7
  83. data/web/views/retry.erb +3 -3
  84. data/web/views/scheduled.erb +5 -2
  85. metadata +39 -54
  86. data/.github/contributing.md +0 -32
  87. data/.github/issue_template.md +0 -11
  88. data/.gitignore +0 -13
  89. data/.travis.yml +0 -14
  90. data/3.0-Upgrade.md +0 -70
  91. data/4.0-Upgrade.md +0 -53
  92. data/5.0-Upgrade.md +0 -56
  93. data/COMM-LICENSE +0 -95
  94. data/Ent-Changes.md +0 -221
  95. data/Gemfile +0 -14
  96. data/Pro-2.0-Upgrade.md +0 -138
  97. data/Pro-3.0-Upgrade.md +0 -44
  98. data/Pro-4.0-Upgrade.md +0 -35
  99. data/Pro-Changes.md +0 -739
  100. data/Rakefile +0 -8
  101. data/bin/sidekiqctl +0 -99
  102. data/code_of_conduct.md +0 -50
  103. data/lib/generators/sidekiq/worker_generator.rb +0 -49
  104. data/lib/sidekiq/core_ext.rb +0 -1
  105. data/lib/sidekiq/logging.rb +0 -122
  106. data/lib/sidekiq/middleware/server/active_record.rb +0 -23
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 2b5307056552014ab284241c16aa83a8d334d31b
4
- data.tar.gz: acc9588810366d8c6dbb03d3c5cbe140a169f501
2
+ SHA256:
3
+ metadata.gz: 9622b2851203b0c5a80695ab7801ca77e15dc63a641ae79132cda9a2fcbe0cc6
4
+ data.tar.gz: dd943a02d2cf910f51866d02254f3a7845cb159735bd54d223dd7127a1fbd2fa
5
5
  SHA512:
6
- metadata.gz: 8b051912f610e763585e847a991cee6e684d4b27111f91cfe395a1e02539424e931f5ba16141e30a06c3dcf9de3c54db578be47a9fcd629222b81d8295f7c12a
7
- data.tar.gz: 836cc95385406201ad9e26363698d838381ef993e75034bfc030c4ef0d2821c80e3a4612c5a7ec8bfca1d7acdadd02bcf29f5b979d56ece6752686f6293216ef
6
+ metadata.gz: 65bcd542866d8699ecf5958d81a15fd322cd1c51dfc1dbc6a8b15402b70862510c134e2b0ed9f9dbcdbb4dea3a59c1d12878ff926145e503079a59896f279ff3
7
+ data.tar.gz: 36143e85dc7fd4611f8a43fe39788dc590725ac63a827fbc174916da2d59fdadb3fb64fa0d819c4ef90694f6f292ea15f7fb58fb29f368c0a06c5b90f1b4bca7
data/Changes.md CHANGED
@@ -1,6 +1,373 @@
1
1
  # Sidekiq Changes
2
2
 
3
- [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/master/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/master/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/master/Ent-Changes.md)
3
+ [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/main/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/main/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/main/Ent-Changes.md)
4
+
5
+ 6.4.0
6
+ ---------
7
+
8
+ - **SECURITY**: Validate input to avoid possible DoS in Web UI.
9
+ - Add **strict argument checking** [#5071]
10
+ Sidekiq will now log a warning if JSON-unsafe arguments are passed to `perform_async`.
11
+ Add `Sidekiq.strict_args!(false)` to your initializer to disable this warning.
12
+ This warning will switch to an exception in Sidekiq 7.0.
13
+ - Note that Delayed Extensions will be removed in Sidekiq 7.0 [#5076]
14
+ - Add `perform_{inline,sync}` in Sidekiq::Job to run a job synchronously [#5061, hasan-ally]
15
+ ```ruby
16
+ SomeJob.perform_async(args...)
17
+ SomeJob.perform_sync(args...)
18
+ SomeJob.perform_inline(args...)
19
+ ```
20
+ You can also dynamically redirect a job to run synchronously:
21
+ ```ruby
22
+ SomeJob.set("sync": true).perform_async(args...) # will run via perform_inline
23
+ ```
24
+ - Replace Sidekiq::Worker `app/workers` generator with Sidekiq::Job `app/sidekiq` generator [#5055]
25
+ ```
26
+ bin/rails generate sidekiq:job ProcessOrderJob
27
+ ```
28
+ - Fix job retries losing CurrentAttributes [#5090]
29
+ - Tweak shutdown to give long-running threads time to cleanup [#5095]
30
+ - Add keyword arguments support in extensions
31
+
32
+ 6.3.1
33
+ ---------
34
+
35
+ - Fix keyword arguments error with CurrentAttributes on Ruby 3.0 [#5048]
36
+
37
+ 6.3.0
38
+ ---------
39
+
40
+ - **BREAK**: The Web UI has been refactored to remove jQuery. Any UI extensions
41
+ which use jQuery will break.
42
+ - **FEATURE**: Sidekiq.logger has been enhanced so any `Rails.logger`
43
+ output in jobs now shows up in the Sidekiq console. Remove any logger
44
+ hacks in your initializer and see if it Just Works™ now. [#5021]
45
+ - **FEATURE**: Add `Sidekiq::Job` alias for `Sidekiq::Worker`, to better
46
+ reflect industry standard terminology. You can now do this:
47
+ ```ruby
48
+ class MyJob
49
+ include Sidekiq::Job
50
+ sidekiq_options ...
51
+ def perform(args)
52
+ end
53
+ end
54
+ ```
55
+ - **FEATURE**: Support for serializing ActiveSupport::CurrentAttributes into each job. [#4982]
56
+ ```ruby
57
+ # config/initializers/sidekiq.rb
58
+ require "sidekiq/middleware/current_attributes"
59
+ Sidekiq::CurrentAttributes.persist(Myapp::Current) # Your AS::CurrentAttributes singleton
60
+ ```
61
+ - **FEATURE**: Add `Sidekiq::Worker.perform_bulk` for enqueuing jobs in bulk,
62
+ similar to `Sidekiq::Client.push_bulk` [#5042]
63
+ ```ruby
64
+ MyJob.perform_bulk([[1], [2], [3]])
65
+ ```
66
+ - Implement `queue_as`, `wait` and `wait_until` for ActiveJob compatibility [#5003]
67
+ - Scheduler now uses Lua to reduce Redis load and network roundtrips [#5044]
68
+ - Retry Redis operation if we get an `UNBLOCKED` Redis error [#4985]
69
+ - Run existing signal traps, if any, before running Sidekiq's trap [#4991]
70
+ - Fix fetch bug when using weighted queues which caused Sidekiq to stop
71
+ processing queues randomly [#5031]
72
+
73
+ 6.2.2
74
+ ---------
75
+
76
+ - Reduce retry jitter, add jitter to `sidekiq_retry_in` values [#4957]
77
+ - Minimize scheduler load on Redis at scale [#4882]
78
+ - Improve logging of delay jobs [#4904, BuonOno]
79
+ - Minor CSS improvements for buttons and tables, design PRs always welcome!
80
+ - Tweak Web UI `Cache-Control` header [#4966]
81
+ - Rename internal API class `Sidekiq::Job` to `Sidekiq::JobRecord` [#4955]
82
+
83
+ 6.2.1
84
+ ---------
85
+
86
+ - Update RTT warning logic to handle transient RTT spikes [#4851]
87
+ - Fix very low priority CVE on unescaped queue name [#4852]
88
+ - Add note about sessions and Rails apps in API mode
89
+
90
+ 6.2.0
91
+ ---------
92
+
93
+ - Store Redis RTT and log if poor [#4824]
94
+ - Add process/thread stats to Busy page [#4806]
95
+ - Improve Web UI on mobile devices [#4840]
96
+ - **Refactor Web UI session usage** [#4804]
97
+ Numerous people have hit "Forbidden" errors and struggled with Sidekiq's
98
+ Web UI session requirement. If you have code in your initializer for
99
+ Web sessions, it's quite possible it will need to be removed. Here's
100
+ an overview:
101
+ ```
102
+ Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
103
+ make sure you mount Sidekiq::Web *inside* your routes in `config/routes.rb` so
104
+ Sidekiq can reuse the Rails session:
105
+
106
+ Rails.application.routes.draw do
107
+ mount Sidekiq::Web => "/sidekiq"
108
+ ....
109
+ end
110
+
111
+ If this is a bare Rack app, use a session middleware before Sidekiq::Web:
112
+
113
+ # first, use IRB to create a shared secret key for sessions and commit it
114
+ require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
115
+
116
+ # now, update your Rack app to include the secret with a session cookie middleware
117
+ use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
118
+ run Sidekiq::Web
119
+
120
+ If this is a Rails app in API mode, you need to enable sessions.
121
+
122
+ https://guides.rubyonrails.org/api_app.html#using-session-middlewares
123
+ ```
124
+
125
+ 6.1.3
126
+ ---------
127
+
128
+ - Warn if Redis is configured to evict data under memory pressure [#4752]
129
+ - Add process RSS on the Busy page [#4717]
130
+
131
+ 6.1.2
132
+ ---------
133
+
134
+ - Improve readability in dark mode Web UI [#4674]
135
+ - Fix Web UI crash with corrupt session [#4672]
136
+ - Allow middleware to yield arguments [#4673, @eugeneius]
137
+ - Migrate CI from CircleCI to GitHub Actions [#4677]
138
+
139
+ 6.1.1
140
+ ---------
141
+
142
+ - Jobs are now sorted by age in the Busy Workers table. [#4641]
143
+ - Fix "check all" JS logic in Web UI [#4619]
144
+
145
+ 6.1.0
146
+ ---------
147
+
148
+ - Web UI - Dark Mode fixes [#4543, natematykiewicz]
149
+ - Ensure `Rack::ContentLength` is loaded as middleware for correct Web UI responses [#4541]
150
+ - Avoid exception dumping SSL store in Redis connection logging [#4532]
151
+ - Better error messages in Sidekiq::Client [#4549]
152
+ - Remove rack-protection, reimplement CSRF protection [#4588]
153
+ - Require redis-rb 4.2 [#4591]
154
+ - Update to jquery 1.12.4 [#4593]
155
+ - Refactor internal fetch logic and API [#4602]
156
+
157
+ 6.0.7
158
+ ---------
159
+
160
+ - Refactor systemd integration to work better with custom binaries [#4511]
161
+ - Don't connect to Redis at process exit if not needed [#4502]
162
+ - Remove Redis connection naming [#4479]
163
+ - Fix Redis Sentinel password redaction [#4499]
164
+ - Add Vietnamese locale (vi) [#4528]
165
+
166
+ 6.0.6
167
+ ---------
168
+
169
+ - **Integrate with systemd's watchdog and notification features** [#4488]
170
+ Set `Type=notify` in [sidekiq.service](https://github.com/mperham/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
171
+ - Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
172
+ - Fix edge case where a job can be pushed without a queue.
173
+ - Flush job stats at exit [#4498]
174
+ - Check RAILS_ENV before RACK_ENV [#4493]
175
+ - Add Lithuanian locale [#4476]
176
+
177
+ 6.0.5
178
+ ---------
179
+
180
+ - Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
181
+ - Update APIs to use `UNLINK`, not `DEL`. [#4449]
182
+ - Fix Ruby 2.7 warnings [#4412]
183
+ - Add support for `APP_ENV` [[95fa5d9]](https://github.com/mperham/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
184
+
185
+ 6.0.4
186
+ ---------
187
+
188
+ - Fix ActiveJob's `sidekiq_options` integration [#4404]
189
+ - Sidekiq Pro users will now see a Pause button next to each queue in
190
+ the Web UI, allowing them to pause queues manually [#4374, shayonj]
191
+ - Fix Sidekiq::Workers API unintentional change in 6.0.2 [#4387]
192
+
193
+
194
+ 6.0.3
195
+ ---------
196
+
197
+ - Fix `Sidekiq::Client.push_bulk` API which was erroneously putting
198
+ invalid `at` values in the job payloads [#4321]
199
+
200
+ 6.0.2
201
+ ---------
202
+
203
+ - Fix Sidekiq Enterprise's rolling restart functionality, broken by refactoring in 6.0.0. [#4334]
204
+ - More internal refactoring and performance tuning [fatkodima]
205
+
206
+ 6.0.1
207
+ ---------
208
+
209
+ - **Performance tuning**, Sidekiq should be 10-15% faster now [#4303, 4299,
210
+ 4269, fatkodima]
211
+ - **Dark Mode support in Web UI** (further design polish welcome!) [#4227, mperham,
212
+ fatkodima, silent-e]
213
+ - **Job-specific log levels**, allowing you to turn on debugging for
214
+ problematic workers. [fatkodima, #4287]
215
+ ```ruby
216
+ MyWorker.set(log_level: :debug).perform_async(...)
217
+ ```
218
+ - **Ad-hoc job tags**. You can tag your jobs with, e.g, subdomain, tenant, country,
219
+ locale, application, version, user/client, "alpha/beta/pro/ent", types of jobs,
220
+ teams/people responsible for jobs, additional metadata, etc.
221
+ Tags are shown on different pages with job listings. Sidekiq Pro users
222
+ can filter based on them [fatkodima, #4280]
223
+ ```ruby
224
+ class MyWorker
225
+ include Sidekiq::Worker
226
+ sidekiq_options tags: ['bank-ops', 'alpha']
227
+ ...
228
+ end
229
+ ```
230
+ - Fetch scheduled jobs in batches before pushing into specific queues.
231
+ This will decrease enqueueing time of scheduled jobs by a third. [fatkodima, #4273]
232
+ ```
233
+ ScheduledSet with 10,000 jobs
234
+ Before: 56.6 seconds
235
+ After: 39.2 seconds
236
+ ```
237
+ - Compress error backtraces before pushing into Redis, if you are
238
+ storing error backtraces, this will halve the size of your RetrySet
239
+ in Redis [fatkodima, #4272]
240
+ ```
241
+ RetrySet with 100,000 jobs
242
+ Before: 261 MB
243
+ After: 129 MB
244
+ ```
245
+ - Support display of ActiveJob 6.0 payloads in the Web UI [#4263]
246
+ - Add `SortedSet#scan` for pattern based scanning. For large sets this API will be **MUCH** faster
247
+ than standard iteration using each. [fatkodima, #4262]
248
+ ```ruby
249
+ Sidekiq::DeadSet.new.scan("UnreliableApi") do |job|
250
+ job.retry
251
+ end
252
+ ```
253
+ - Dramatically speed up SortedSet#find\_job(jid) by using Redis's ZSCAN
254
+ support, approx 10x faster. [fatkodima, #4259]
255
+ ```
256
+ zscan 0.179366 0.047727 0.227093 ( 1.161376)
257
+ enum 8.522311 0.419826 8.942137 ( 9.785079)
258
+ ```
259
+ - Respect rails' generators `test_framework` option and gracefully handle extra `worker` suffix on generator [fatkodima, #4256]
260
+ - Add ability to sort 'Enqueued' page on Web UI by position in the queue [fatkodima, #4248]
261
+ - Support `Client.push_bulk` with different delays [fatkodima, #4243]
262
+ ```ruby
263
+ Sidekiq::Client.push_bulk("class" => FooJob, "args" => [[1], [2]], "at" => [1.minute.from_now.to_f, 5.minutes.from_now.to_f])
264
+ ```
265
+ - Easier way to test enqueuing specific ActionMailer and ActiveRecord delayed jobs. Instead of manually
266
+ parsing embedded class, you can now test by fetching jobs for specific classes. [fatkodima, #4292]
267
+ ```ruby
268
+ assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs_for(FooMailer).size
269
+ ```
270
+ - Add `sidekiqmon` to gemspec executables [#4242]
271
+ - Gracefully handle `Sidekiq.logger = nil` [#4240]
272
+ - Inject Sidekiq::LogContext module if user-supplied logger does not include it [#4239]
273
+
274
+ 6.0
275
+ ---------
276
+
277
+ This release has major breaking changes. Read and test carefully in production.
278
+
279
+ - With Rails 6.0.2+, ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
280
+ features/internals like the retry subsystem. [#4213, pirj]
281
+ ```ruby
282
+ class MyJob < ActiveJob::Base
283
+ queue_as :myqueue
284
+ sidekiq_options retry: 10, backtrace: 20
285
+ def perform(...)
286
+ end
287
+ end
288
+ ```
289
+ - Logging has been redesigned to allow for pluggable log formatters:
290
+ ```ruby
291
+ Sidekiq.configure_server do |config|
292
+ config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
293
+ end
294
+ ```
295
+ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for more details.
296
+ - **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
297
+ variable. This variable is meant to hold the name of the environment
298
+ variable which contains your Redis URL, so that you can switch Redis
299
+ providers quickly and easily with a single variable change. It is not
300
+ meant to hold the actual Redis URL itself. If you want to manually set
301
+ the Redis URL (not recommended as it implies you have no failover),
302
+ then you may set `REDIS_URL` directly. [#3969]
303
+ - **BREAKING CHANGE** Increase default shutdown timeout from 8 seconds
304
+ to 25 seconds. Both Heroku and ECS now use 30 second shutdown timeout
305
+ by default and we want Sidekiq to take advantage of this time. If you
306
+ have deployment scripts which depend on the old default timeout, use `-t 8` to
307
+ get the old behavior. [#3968]
308
+ - **BREAKING CHANGE** Remove the daemonization, logfile and pidfile
309
+ arguments to Sidekiq. Use a proper process supervisor (e.g. systemd or
310
+ foreman) to manage Sidekiq. See the Deployment wiki page for links to
311
+ more resources.
312
+ - Integrate the StandardRB code formatter to ensure consistent code
313
+ styling. [#4114, gearnode]
314
+
315
+ 5.2.9
316
+ ---------
317
+
318
+ - Release Rack lock due to a cascade of CVEs. [#4566]
319
+ Pro-tip: don't lock Rack.
320
+
321
+ 5.2.8
322
+ ---------
323
+
324
+ - Lock to Rack 2.0.x to prevent future incompatibilities
325
+ - Fix invalid reference in `sidekiqctl`
326
+
327
+ 5.2.7
328
+ ---------
329
+
330
+ - Fix stale `enqueued_at` when retrying [#4149]
331
+ - Move build to [Circle CI](https://circleci.com/gh/mperham/sidekiq) [#4120]
332
+
333
+ 5.2.6
334
+ ---------
335
+
336
+ - Fix edge case where a job failure during Redis outage could result in a lost job [#4141]
337
+ - Better handling of malformed job arguments in payload [#4095]
338
+ - Restore bootstap's dropdown css component [#4099, urkle]
339
+ - Display human-friendly time diff for longer queue latencies [#4111, interlinked]
340
+ - Allow `Sidekiq::Worker#set` to be chained
341
+
342
+ 5.2.5
343
+ ---------
344
+
345
+ - Fix default usage of `config/sidekiq.yml` [#4077, Tensho]
346
+
347
+ 5.2.4
348
+ ---------
349
+
350
+ - Add warnings for various deprecations and changes coming in Sidekiq 6.0.
351
+ See the 6-0 branch. [#4056]
352
+ - Various improvements to the Sidekiq test suite and coverage [#4026, #4039, Tensho]
353
+
354
+ 5.2.3
355
+ ---------
356
+
357
+ - Warning message on invalid REDIS\_PROVIDER [#3970]
358
+ - Add `sidekiqctl status` command [#4003, dzunk]
359
+ - Update elapsed time calculatons to use monotonic clock [#3999]
360
+ - Fix a few issues with mobile Web UI styling [#3973, navied]
361
+ - Jobs with `retry: false` now go through the global `death_handlers`,
362
+ meaning you can take action on failed ephemeral jobs. [#3980, Benjamin-Dobell]
363
+ - Fix race condition in defining Workers. [#3997, mattbooks]
364
+
365
+ 5.2.2
366
+ ---------
367
+
368
+ - Raise error for duplicate queue names in config to avoid unexpected fetch algorithm change [#3911]
369
+ - Fix concurrency bug on JRuby [#3958, mattbooks]
370
+ - Add "Kill All" button to the retries page [#3938]
4
371
 
5
372
  5.2.1
6
373
  -----------
data/LICENSE CHANGED
@@ -4,6 +4,6 @@ Sidekiq is an Open Source project licensed under the terms of
4
4
  the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
5
5
  for license text.
6
6
 
7
- Sidekiq Pro has a commercial-friendly license allowing private forks
8
- and modifications of Sidekiq. Please see https://sidekiq.org/products/pro.html for
9
- more detail. You can find the commercial license terms in COMM-LICENSE.
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,10 +2,7 @@ Sidekiq
2
2
  ==============
3
3
 
4
4
  [![Gem Version](https://badge.fury.io/rb/sidekiq.svg)](https://rubygems.org/gems/sidekiq)
5
- [![Code Climate](https://codeclimate.com/github/mperham/sidekiq.svg)](https://codeclimate.com/github/mperham/sidekiq)
6
- [![Build Status](https://travis-ci.org/mperham/sidekiq.svg)](https://travis-ci.org/mperham/sidekiq)
7
- [![Gitter Chat](https://badges.gitter.im/mperham/sidekiq.svg)](https://gitter.im/mperham/sidekiq)
8
-
5
+ ![Build](https://github.com/mperham/sidekiq/workflows/CI/badge.svg)
9
6
 
10
7
  Simple, efficient background processing for Ruby.
11
8
 
@@ -13,32 +10,27 @@ Sidekiq uses threads to handle many jobs at the same time in the
13
10
  same process. It does not require Rails but will integrate tightly with
14
11
  Rails to make background processing dead simple.
15
12
 
16
- Sidekiq is compatible with Resque. It uses the exact same
17
- message format as Resque so it can integrate into an existing Resque processing farm.
18
- You can have Sidekiq and Resque run side-by-side at the same time and
19
- use the Resque client to enqueue jobs in Redis to be processed by Sidekiq.
20
-
21
13
  Performance
22
14
  ---------------
23
15
 
24
- Version | Latency | Garbage created for 10,000 jobs | Time to process 100,000 jobs | Throughput
25
- -----------------|------|---------|---------|------------------------
26
- Sidekiq 4.0.0 | 10ms | 151 MB | 22 sec | **4500 jobs/sec**
27
- Sidekiq 3.5.1 | 22ms | 1257 MB | 125 sec | 800 jobs/sec
28
- Resque 1.25.2 | - | - | 420 sec | 240 jobs/sec
29
- DelayedJob 4.1.1 | - | - | 465 sec | 215 jobs/sec
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 |
30
24
 
31
- <small>This benchmark can be found in `bin/sidekiqload`.</small>
25
+ This benchmark can be found in `bin/sidekiqload` and assumes a Redis network latency of 1ms.
32
26
 
33
27
  Requirements
34
28
  -----------------
35
29
 
36
- Sidekiq supports CRuby 2.2.2+ and JRuby 9k.
30
+ - Redis: 4.0+
31
+ - Ruby: MRI 2.5+ or JRuby 9.2+.
37
32
 
38
- All Rails releases >= 4.0 are officially supported.
39
-
40
- Redis 2.8 or greater is required. 3.0.3+ is recommended for large
41
- installations with thousands of worker threads.
33
+ Sidekiq 6.0 supports Rails 5.0+ but does not require it.
42
34
 
43
35
 
44
36
  Installation
@@ -51,10 +43,10 @@ Getting Started
51
43
  -----------------
52
44
 
53
45
  See the [Getting Started wiki page](https://github.com/mperham/sidekiq/wiki/Getting-Started) and follow the simple setup process.
54
- You can watch [this Youtube playlist](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1) to learn all about
46
+ You can watch [this YouTube playlist](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1) to learn all about
55
47
  Sidekiq and see its features in action. Here's the Web UI:
56
48
 
57
- ![Web UI](https://github.com/mperham/sidekiq/raw/master/examples/web-ui.png)
49
+ ![Web UI](https://github.com/mperham/sidekiq/raw/main/examples/web-ui.png)
58
50
 
59
51
 
60
52
  Want to Upgrade?
@@ -63,7 +55,7 @@ Want to Upgrade?
63
55
  I also sell Sidekiq Pro and Sidekiq Enterprise, extensions to Sidekiq which provide more
64
56
  features, a commercial-friendly license and allow you to support high
65
57
  quality open source development all at the same time. Please see the
66
- [Sidekiq](http://sidekiq.org/) homepage for more detail.
58
+ [Sidekiq](https://sidekiq.org/) homepage for more detail.
67
59
 
68
60
  Subscribe to the **[quarterly newsletter](https://tinyletter.com/sidekiq)** to stay informed about the latest
69
61
  features and changes to Sidekiq and its bigger siblings.
@@ -77,33 +69,25 @@ Problems?
77
69
  If you have a problem, please review the [FAQ](https://github.com/mperham/sidekiq/wiki/FAQ) and [Troubleshooting](https://github.com/mperham/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages.
78
70
  Searching the [issues](https://github.com/mperham/sidekiq/issues) for your problem is also a good idea.
79
71
 
80
- Sidekiq Pro and Sidekiq Enterprise customers get private email support. You can purchase at http://sidekiq.org; email support@contribsys.com for help.
72
+ Sidekiq Pro and Sidekiq Enterprise customers get private email support. You can purchase at https://sidekiq.org; email support@contribsys.com for help.
81
73
 
82
74
  Useful resources:
83
75
 
84
76
  * Product documentation is in the [wiki](https://github.com/mperham/sidekiq/wiki).
85
- * Release announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
77
+ * Occasional announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
86
78
  * The [Sidekiq tag](https://stackoverflow.com/questions/tagged/sidekiq) on Stack Overflow has lots of useful Q &amp; A.
87
79
 
88
- **No support via Twitter**
89
-
90
80
  Every Friday morning is Sidekiq happy hour: I video chat and answer questions.
91
- See the [Sidekiq support page](http://sidekiq.org/support.html) for details.
92
-
93
- Thanks
94
- -----------------
95
-
96
- Sidekiq stays fast by using the [JProfiler java profiler](http://www.ej-technologies.com/products/jprofiler/overview.html) to find and fix
97
- performance problems on JRuby. Unfortunately MRI does not have good multithreaded profiling tools.
81
+ See the [Sidekiq support page](https://sidekiq.org/support.html) for details.
98
82
 
99
83
 
100
84
  License
101
85
  -----------------
102
86
 
103
- Please see [LICENSE](https://github.com/mperham/sidekiq/blob/master/LICENSE) for licensing details.
87
+ Please see [LICENSE](https://github.com/mperham/sidekiq/blob/main/LICENSE) for licensing details.
104
88
 
105
89
 
106
90
  Author
107
91
  -----------------
108
92
 
109
- Mike Perham, [@mperham](https://twitter.com/mperham) / [@sidekiq](https://twitter.com/sidekiq), [http://www.mikeperham.com](http://www.mikeperham.com) / [http://www.contribsys.com](http://www.contribsys.com)
93
+ Mike Perham, [@getajobmike](https://twitter.com/getajobmike) / [@sidekiq](https://twitter.com/sidekiq), [https://www.mikeperham.com](https://www.mikeperham.com) / [https://www.contribsys.com](https://www.contribsys.com)
data/bin/sidekiq CHANGED
@@ -6,13 +6,37 @@ $TESTING = false
6
6
 
7
7
  require_relative '../lib/sidekiq/cli'
8
8
 
9
+ def integrate_with_systemd
10
+ return unless ENV["NOTIFY_SOCKET"]
11
+
12
+ Sidekiq.configure_server do |config|
13
+ Sidekiq.logger.info "Enabling systemd notification integration"
14
+ require "sidekiq/sd_notify"
15
+ config.on(:startup) do
16
+ Sidekiq::SdNotify.ready
17
+ end
18
+ config.on(:shutdown) do
19
+ Sidekiq::SdNotify.stopping
20
+ end
21
+ Sidekiq.start_watchdog if Sidekiq::SdNotify.watchdog?
22
+ end
23
+ end
24
+
9
25
  begin
10
26
  cli = Sidekiq::CLI.instance
11
27
  cli.parse
28
+
29
+ integrate_with_systemd
30
+
12
31
  cli.run
13
32
  rescue => e
14
33
  raise e if $DEBUG
15
- STDERR.puts e.message
16
- STDERR.puts e.backtrace.join("\n")
34
+ if Sidekiq.error_handlers.length == 0
35
+ STDERR.puts e.message
36
+ STDERR.puts e.backtrace.join("\n")
37
+ else
38
+ cli.handle_exception e
39
+ end
40
+
17
41
  exit 1
18
42
  end
data/bin/sidekiqload CHANGED
@@ -5,7 +5,8 @@
5
5
  $TESTING = false
6
6
 
7
7
  #require 'ruby-prof'
8
- Bundler.require(:default)
8
+ require 'bundler/setup'
9
+ Bundler.require(:default, :load_test)
9
10
 
10
11
  require_relative '../lib/sidekiq/cli'
11
12
  require_relative '../lib/sidekiq/launcher'
@@ -13,8 +14,8 @@ require_relative '../lib/sidekiq/launcher'
13
14
  include Sidekiq::Util
14
15
 
15
16
  Sidekiq.configure_server do |config|
16
- #config.options[:concurrency] = 1
17
- config.redis = { db: 13 }
17
+ config.options[:concurrency] = 10
18
+ config.redis = { db: 13, port: 6380, driver: :hiredis }
18
19
  config.options[:queues] << 'default'
19
20
  config.logger.level = Logger::ERROR
20
21
  config.average_scheduled_poll_interval = 2
@@ -28,7 +29,8 @@ class LoadWorker
28
29
  1
29
30
  end
30
31
 
31
- def perform(idx)
32
+ def perform(idx, ts=nil)
33
+ puts(Time.now.to_f - ts) if ts != nil
32
34
  #raise idx.to_s if idx % 100 == 1
33
35
  end
34
36
  end
@@ -36,14 +38,15 @@ end
36
38
  # brew tap shopify/shopify
37
39
  # brew install toxiproxy
38
40
  # gem install toxiproxy
39
- #require 'toxiproxy'
41
+ # run `toxiproxy-server` in a separate terminal window.
42
+ require 'toxiproxy'
40
43
  # simulate a non-localhost network for realer-world conditions.
41
44
  # adding 1ms of network latency has an ENORMOUS impact on benchmarks
42
- #Toxiproxy.populate([{
43
- #"name": "redis",
44
- #"listen": "127.0.0.1:6380",
45
- #"upstream": "127.0.0.1:6379"
46
- #}])
45
+ Toxiproxy.populate([{
46
+ "name": "redis",
47
+ "listen": "127.0.0.1:6380",
48
+ "upstream": "127.0.0.1:6379"
49
+ }])
47
50
 
48
51
  self_read, self_write = IO.pipe
49
52
  %w(INT TERM TSTP TTIN).each do |sig|
@@ -65,7 +68,7 @@ def handle_signal(launcher, sig)
65
68
  # http://jira.codehaus.org/browse/JRUBY-4637
66
69
  raise Interrupt
67
70
  when 'TERM'
68
- # Heroku sends TERM and then waits 10 seconds for process to exit.
71
+ # Heroku sends TERM and then waits 30 seconds for process to exit.
69
72
  raise Interrupt
70
73
  when 'TSTP'
71
74
  Sidekiq.logger.info "Received TSTP, no longer accepting new work"
@@ -100,21 +103,26 @@ iter.times do
100
103
  end
101
104
  Sidekiq.logger.error "Created #{count*iter} jobs"
102
105
 
106
+ start = Time.now
107
+
103
108
  Monitoring = Thread.new do
104
109
  watchdog("monitor thread") do
105
110
  while true
106
- sleep 1
107
- qsize, retries = Sidekiq.redis do |conn|
108
- conn.pipelined do
109
- conn.llen "queue:default"
110
- conn.zcard "retry"
111
- end
112
- end.map(&:to_i)
113
- total = qsize + retries
114
- #GC.start
115
- Sidekiq.logger.error("RSS: #{Process.rss} Pending: #{total}")
111
+ sleep 0.2
112
+ qsize = Sidekiq.redis do |conn|
113
+ conn.llen "queue:default"
114
+ end
115
+ total = qsize
116
+ #Sidekiq.logger.error("RSS: #{Process.rss} Pending: #{total}")
116
117
  if total == 0
117
- Sidekiq.logger.error("Done")
118
+ Sidekiq.logger.error("Done, #{iter * count} jobs in #{Time.now - start} sec")
119
+ Sidekiq.logger.error("Now here's the latency for three jobs")
120
+
121
+ LoadWorker.perform_async(1, Time.now.to_f)
122
+ LoadWorker.perform_async(2, Time.now.to_f)
123
+ LoadWorker.perform_async(3, Time.now.to_f)
124
+
125
+ sleep 0.2
118
126
  exit(0)
119
127
  end
120
128
  end
@@ -125,8 +133,8 @@ begin
125
133
  #RubyProf::exclude_threads = [ Monitoring ]
126
134
  #RubyProf.start
127
135
  fire_event(:startup)
128
- #Sidekiq.logger.error "Simulating 1ms of latency between Sidekiq and redis"
129
- #Toxiproxy[:redis].downstream(:latency, latency: 1).apply do
136
+ Sidekiq.logger.error "Simulating 1ms of latency between Sidekiq and redis"
137
+ Toxiproxy[:redis].downstream(:latency, latency: 1).apply do
130
138
  launcher = Sidekiq::Launcher.new(Sidekiq.options)
131
139
  launcher.run
132
140
 
@@ -134,7 +142,7 @@ begin
134
142
  signal = readable_io.first[0].gets.strip
135
143
  handle_signal(launcher, signal)
136
144
  end
137
- #end
145
+ end
138
146
  rescue SystemExit => e
139
147
  #Sidekiq.logger.error("Profiling...")
140
148
  #result = RubyProf.stop
data/bin/sidekiqmon ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'sidekiq/monitor'
4
+
5
+ section = "all"
6
+ section = ARGV[0] if ARGV.size == 1
7
+
8
+ Sidekiq::Monitor::Status.new.display(section)