sidekiq 6.1.1

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 (127) hide show
  1. checksums.yaml +7 -0
  2. data/.circleci/config.yml +71 -0
  3. data/.github/contributing.md +32 -0
  4. data/.github/issue_template.md +11 -0
  5. data/.gitignore +13 -0
  6. data/.standard.yml +20 -0
  7. data/3.0-Upgrade.md +70 -0
  8. data/4.0-Upgrade.md +53 -0
  9. data/5.0-Upgrade.md +56 -0
  10. data/6.0-Upgrade.md +72 -0
  11. data/COMM-LICENSE +97 -0
  12. data/Changes.md +1724 -0
  13. data/Ent-2.0-Upgrade.md +37 -0
  14. data/Ent-Changes.md +275 -0
  15. data/Gemfile +24 -0
  16. data/Gemfile.lock +208 -0
  17. data/LICENSE +9 -0
  18. data/Pro-2.0-Upgrade.md +138 -0
  19. data/Pro-3.0-Upgrade.md +44 -0
  20. data/Pro-4.0-Upgrade.md +35 -0
  21. data/Pro-5.0-Upgrade.md +25 -0
  22. data/Pro-Changes.md +795 -0
  23. data/README.md +94 -0
  24. data/Rakefile +10 -0
  25. data/bin/sidekiq +42 -0
  26. data/bin/sidekiqload +157 -0
  27. data/bin/sidekiqmon +8 -0
  28. data/code_of_conduct.md +50 -0
  29. data/lib/generators/sidekiq/templates/worker.rb.erb +9 -0
  30. data/lib/generators/sidekiq/templates/worker_spec.rb.erb +6 -0
  31. data/lib/generators/sidekiq/templates/worker_test.rb.erb +8 -0
  32. data/lib/generators/sidekiq/worker_generator.rb +57 -0
  33. data/lib/sidekiq.rb +262 -0
  34. data/lib/sidekiq/api.rb +963 -0
  35. data/lib/sidekiq/cli.rb +396 -0
  36. data/lib/sidekiq/client.rb +263 -0
  37. data/lib/sidekiq/delay.rb +41 -0
  38. data/lib/sidekiq/exception_handler.rb +27 -0
  39. data/lib/sidekiq/extensions/action_mailer.rb +47 -0
  40. data/lib/sidekiq/extensions/active_record.rb +43 -0
  41. data/lib/sidekiq/extensions/class_methods.rb +43 -0
  42. data/lib/sidekiq/extensions/generic_proxy.rb +31 -0
  43. data/lib/sidekiq/fetch.rb +80 -0
  44. data/lib/sidekiq/job_logger.rb +63 -0
  45. data/lib/sidekiq/job_retry.rb +262 -0
  46. data/lib/sidekiq/launcher.rb +206 -0
  47. data/lib/sidekiq/logger.rb +165 -0
  48. data/lib/sidekiq/manager.rb +135 -0
  49. data/lib/sidekiq/middleware/chain.rb +160 -0
  50. data/lib/sidekiq/middleware/i18n.rb +40 -0
  51. data/lib/sidekiq/monitor.rb +133 -0
  52. data/lib/sidekiq/paginator.rb +47 -0
  53. data/lib/sidekiq/processor.rb +280 -0
  54. data/lib/sidekiq/rails.rb +50 -0
  55. data/lib/sidekiq/redis_connection.rb +146 -0
  56. data/lib/sidekiq/scheduled.rb +173 -0
  57. data/lib/sidekiq/sd_notify.rb +149 -0
  58. data/lib/sidekiq/systemd.rb +24 -0
  59. data/lib/sidekiq/testing.rb +344 -0
  60. data/lib/sidekiq/testing/inline.rb +30 -0
  61. data/lib/sidekiq/util.rb +67 -0
  62. data/lib/sidekiq/version.rb +5 -0
  63. data/lib/sidekiq/web.rb +213 -0
  64. data/lib/sidekiq/web/action.rb +93 -0
  65. data/lib/sidekiq/web/application.rb +357 -0
  66. data/lib/sidekiq/web/csrf_protection.rb +153 -0
  67. data/lib/sidekiq/web/helpers.rb +333 -0
  68. data/lib/sidekiq/web/router.rb +101 -0
  69. data/lib/sidekiq/worker.rb +244 -0
  70. data/sidekiq.gemspec +20 -0
  71. data/web/assets/images/favicon.ico +0 -0
  72. data/web/assets/images/logo.png +0 -0
  73. data/web/assets/images/status.png +0 -0
  74. data/web/assets/javascripts/application.js +90 -0
  75. data/web/assets/javascripts/dashboard.js +296 -0
  76. data/web/assets/stylesheets/application-dark.css +133 -0
  77. data/web/assets/stylesheets/application-rtl.css +246 -0
  78. data/web/assets/stylesheets/application.css +1158 -0
  79. data/web/assets/stylesheets/bootstrap-rtl.min.css +9 -0
  80. data/web/assets/stylesheets/bootstrap.css +5 -0
  81. data/web/locales/ar.yml +81 -0
  82. data/web/locales/cs.yml +78 -0
  83. data/web/locales/da.yml +68 -0
  84. data/web/locales/de.yml +81 -0
  85. data/web/locales/el.yml +68 -0
  86. data/web/locales/en.yml +83 -0
  87. data/web/locales/es.yml +70 -0
  88. data/web/locales/fa.yml +80 -0
  89. data/web/locales/fr.yml +78 -0
  90. data/web/locales/he.yml +79 -0
  91. data/web/locales/hi.yml +75 -0
  92. data/web/locales/it.yml +69 -0
  93. data/web/locales/ja.yml +83 -0
  94. data/web/locales/ko.yml +68 -0
  95. data/web/locales/lt.yml +83 -0
  96. data/web/locales/nb.yml +77 -0
  97. data/web/locales/nl.yml +68 -0
  98. data/web/locales/pl.yml +59 -0
  99. data/web/locales/pt-br.yml +68 -0
  100. data/web/locales/pt.yml +67 -0
  101. data/web/locales/ru.yml +78 -0
  102. data/web/locales/sv.yml +68 -0
  103. data/web/locales/ta.yml +75 -0
  104. data/web/locales/uk.yml +76 -0
  105. data/web/locales/ur.yml +80 -0
  106. data/web/locales/vi.yml +83 -0
  107. data/web/locales/zh-cn.yml +68 -0
  108. data/web/locales/zh-tw.yml +68 -0
  109. data/web/views/_footer.erb +20 -0
  110. data/web/views/_job_info.erb +89 -0
  111. data/web/views/_nav.erb +52 -0
  112. data/web/views/_paging.erb +23 -0
  113. data/web/views/_poll_link.erb +7 -0
  114. data/web/views/_status.erb +4 -0
  115. data/web/views/_summary.erb +40 -0
  116. data/web/views/busy.erb +101 -0
  117. data/web/views/dashboard.erb +75 -0
  118. data/web/views/dead.erb +34 -0
  119. data/web/views/layout.erb +41 -0
  120. data/web/views/morgue.erb +78 -0
  121. data/web/views/queue.erb +55 -0
  122. data/web/views/queues.erb +38 -0
  123. data/web/views/retries.erb +83 -0
  124. data/web/views/retry.erb +34 -0
  125. data/web/views/scheduled.erb +57 -0
  126. data/web/views/scheduled_job_info.erb +8 -0
  127. metadata +212 -0
@@ -0,0 +1,1724 @@
1
+ # Sidekiq Changes
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)
4
+
5
+ HEAD
6
+ ---------
7
+
8
+ - Jobs are now sorted by age in the Busy Workers table. [#4641]
9
+ - Fix "check all" JS logic in Web UI [#4619]
10
+
11
+ 6.1.0
12
+ ---------
13
+
14
+ - Web UI - Dark Mode fixes [#4543, natematykiewicz]
15
+ - Ensure `Rack::ContentLength` is loaded as middleware for correct Web UI responses [#4541]
16
+ - Avoid exception dumping SSL store in Redis connection logging [#4532]
17
+ - Better error messages in Sidekiq::Client [#4549]
18
+ - Remove rack-protection, reimplement CSRF protection [#4588]
19
+ - Require redis-rb 4.2 [#4591]
20
+ - Update to jquery 1.12.4 [#4593]
21
+ - Refactor internal fetch logic and API [#4602]
22
+
23
+ 6.0.7
24
+ ---------
25
+
26
+ - Refactor systemd integration to work better with custom binaries [#4511]
27
+ - Don't connect to Redis at process exit if not needed [#4502]
28
+ - Remove Redis connection naming [#4479]
29
+ - Fix Redis Sentinel password redaction [#4499]
30
+ - Add Vietnamese locale (vi) [#4528]
31
+
32
+ 6.0.6
33
+ ---------
34
+
35
+ - **Integrate with systemd's watchdog and notification features** [#4488]
36
+ Set `Type=notify` in [sidekiq.service](https://github.com/mperham/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
37
+ - Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
38
+ - Fix edge case where a job can be pushed without a queue.
39
+ - Flush job stats at exit [#4498]
40
+ - Check RAILS_ENV before RACK_ENV [#4493]
41
+ - Add Lithuanian locale [#4476]
42
+
43
+ 6.0.5
44
+ ---------
45
+
46
+ - Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
47
+ - Update APIs to use `UNLINK`, not `DEL`. [#4449]
48
+ - Fix Ruby 2.7 warnings [#4412]
49
+ - Add support for `APP_ENV` [[95fa5d9]](https://github.com/mperham/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
50
+
51
+ 6.0.4
52
+ ---------
53
+
54
+ - Fix ActiveJob's `sidekiq_options` integration [#4404]
55
+ - Sidekiq Pro users will now see a Pause button next to each queue in
56
+ the Web UI, allowing them to pause queues manually [#4374, shayonj]
57
+ - Fix Sidekiq::Workers API unintentional change in 6.0.2 [#4387]
58
+
59
+
60
+ 6.0.3
61
+ ---------
62
+
63
+ - Fix `Sidekiq::Client.push_bulk` API which was erroneously putting
64
+ invalid `at` values in the job payloads [#4321]
65
+
66
+ 6.0.2
67
+ ---------
68
+
69
+ - Fix Sidekiq Enterprise's rolling restart functionality, broken by refactoring in 6.0.0. [#4334]
70
+ - More internal refactoring and performance tuning [fatkodima]
71
+
72
+ 6.0.1
73
+ ---------
74
+
75
+ - **Performance tuning**, Sidekiq should be 10-15% faster now [#4303, 4299,
76
+ 4269, fatkodima]
77
+ - **Dark Mode support in Web UI** (further design polish welcome!) [#4227, mperham,
78
+ fatkodima, silent-e]
79
+ - **Job-specific log levels**, allowing you to turn on debugging for
80
+ problematic workers. [fatkodima, #4287]
81
+ ```ruby
82
+ MyWorker.set(log_level: :debug).perform_async(...)
83
+ ```
84
+ - **Ad-hoc job tags**. You can tag your jobs with, e.g, subdomain, tenant, country,
85
+ locale, application, version, user/client, "alpha/beta/pro/ent", types of jobs,
86
+ teams/people responsible for jobs, additional metadata, etc.
87
+ Tags are shown on different pages with job listings. Sidekiq Pro users
88
+ can filter based on them [fatkodima, #4280]
89
+ ```ruby
90
+ class MyWorker
91
+ include Sidekiq::Worker
92
+ sidekiq_options tags: ['bank-ops', 'alpha']
93
+ ...
94
+ end
95
+ ```
96
+ - Fetch scheduled jobs in batches before pushing into specific queues.
97
+ This will decrease enqueueing time of scheduled jobs by a third. [fatkodima, #4273]
98
+ ```
99
+ ScheduledSet with 10,000 jobs
100
+ Before: 56.6 seconds
101
+ After: 39.2 seconds
102
+ ```
103
+ - Compress error backtraces before pushing into Redis, if you are
104
+ storing error backtraces, this will halve the size of your RetrySet
105
+ in Redis [fatkodima, #4272]
106
+ ```
107
+ RetrySet with 100,000 jobs
108
+ Before: 261 MB
109
+ After: 129 MB
110
+ ```
111
+ - Support display of ActiveJob 6.0 payloads in the Web UI [#4263]
112
+ - Add `SortedSet#scan` for pattern based scanning. For large sets this API will be **MUCH** faster
113
+ than standard iteration using each. [fatkodima, #4262]
114
+ ```ruby
115
+ Sidekiq::DeadSet.new.scan("UnreliableApi") do |job|
116
+ job.retry
117
+ end
118
+ ```
119
+ - Dramatically speed up SortedSet#find\_job(jid) by using Redis's ZSCAN
120
+ support, approx 10x faster. [fatkodima, #4259]
121
+ ```
122
+ zscan 0.179366 0.047727 0.227093 ( 1.161376)
123
+ enum 8.522311 0.419826 8.942137 ( 9.785079)
124
+ ```
125
+ - Respect rails' generators `test_framework` option and gracefully handle extra `worker` suffix on generator [fatkodima, #4256]
126
+ - Add ability to sort 'Enqueued' page on Web UI by position in the queue [fatkodima, #4248]
127
+ - Support `Client.push_bulk` with different delays [fatkodima, #4243]
128
+ ```ruby
129
+ Sidekiq::Client.push_bulk("class" => FooJob, "args" => [[1], [2]], "at" => [1.minute.from_now.to_f, 5.minutes.from_now.to_f])
130
+ ```
131
+ - Easier way to test enqueuing specific ActionMailer and ActiveRecord delayed jobs. Instead of manually
132
+ parsing embedded class, you can now test by fetching jobs for specific classes. [fatkodima, #4292]
133
+ ```ruby
134
+ assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs_for(FooMailer).size
135
+ ```
136
+ - Add `sidekiqmon` to gemspec executables [#4242]
137
+ - Gracefully handle `Sidekiq.logger = nil` [#4240]
138
+ - Inject Sidekiq::LogContext module if user-supplied logger does not include it [#4239]
139
+
140
+ 6.0
141
+ ---------
142
+
143
+ This release has major breaking changes. Read and test carefully in production.
144
+
145
+ - With Rails 6.0.1+, ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
146
+ features/internals like the retry subsystem. [#4213, pirj]
147
+ ```ruby
148
+ class MyJob < ActiveJob::Base
149
+ queue_as :myqueue
150
+ sidekiq_options retry: 10, backtrace: 20
151
+ def perform(...)
152
+ end
153
+ end
154
+ ```
155
+ - Logging has been redesigned to allow for pluggable log formatters:
156
+ ```ruby
157
+ Sidekiq.configure_server do |config|
158
+ config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
159
+ end
160
+ ```
161
+ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for more details.
162
+ - **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
163
+ variable. This variable is meant to hold the name of the environment
164
+ variable which contains your Redis URL, so that you can switch Redis
165
+ providers quickly and easily with a single variable change. It is not
166
+ meant to hold the actual Redis URL itself. If you want to manually set
167
+ the Redis URL (not recommended as it implies you have no failover),
168
+ then you may set `REDIS_URL` directly. [#3969]
169
+ - **BREAKING CHANGE** Increase default shutdown timeout from 8 seconds
170
+ to 25 seconds. Both Heroku and ECS now use 30 second shutdown timeout
171
+ by default and we want Sidekiq to take advantage of this time. If you
172
+ have deployment scripts which depend on the old default timeout, use `-t 8` to
173
+ get the old behavior. [#3968]
174
+ - **BREAKING CHANGE** Remove the daemonization, logfile and pidfile
175
+ arguments to Sidekiq. Use a proper process supervisor (e.g. systemd or
176
+ foreman) to manage Sidekiq. See the Deployment wiki page for links to
177
+ more resources.
178
+ - Integrate the StandardRB code formatter to ensure consistent code
179
+ styling. [#4114, gearnode]
180
+
181
+ 5.2.9
182
+ ---------
183
+
184
+ - Release Rack lock due to a cascade of CVEs. [#4566]
185
+ Pro-tip: don't lock Rack.
186
+
187
+ 5.2.8
188
+ ---------
189
+
190
+ - Lock to Rack 2.0.x to prevent future incompatibilities
191
+ - Fix invalid reference in `sidekiqctl`
192
+
193
+ 5.2.7
194
+ ---------
195
+
196
+ - Fix stale `enqueued_at` when retrying [#4149]
197
+ - Move build to [Circle CI](https://circleci.com/gh/mperham/sidekiq) [#4120]
198
+
199
+ 5.2.6
200
+ ---------
201
+
202
+ - Fix edge case where a job failure during Redis outage could result in a lost job [#4141]
203
+ - Better handling of malformed job arguments in payload [#4095]
204
+ - Restore bootstap's dropdown css component [#4099, urkle]
205
+ - Display human-friendly time diff for longer queue latencies [#4111, interlinked]
206
+ - Allow `Sidekiq::Worker#set` to be chained
207
+
208
+ 5.2.5
209
+ ---------
210
+
211
+ - Fix default usage of `config/sidekiq.yml` [#4077, Tensho]
212
+
213
+ 5.2.4
214
+ ---------
215
+
216
+ - Add warnings for various deprecations and changes coming in Sidekiq 6.0.
217
+ See the 6-0 branch. [#4056]
218
+ - Various improvements to the Sidekiq test suite and coverage [#4026, #4039, Tensho]
219
+
220
+ 5.2.3
221
+ ---------
222
+
223
+ - Warning message on invalid REDIS\_PROVIDER [#3970]
224
+ - Add `sidekiqctl status` command [#4003, dzunk]
225
+ - Update elapsed time calculatons to use monotonic clock [#3999]
226
+ - Fix a few issues with mobile Web UI styling [#3973, navied]
227
+ - Jobs with `retry: false` now go through the global `death_handlers`,
228
+ meaning you can take action on failed ephemeral jobs. [#3980, Benjamin-Dobell]
229
+ - Fix race condition in defining Workers. [#3997, mattbooks]
230
+
231
+ 5.2.2
232
+ ---------
233
+
234
+ - Raise error for duplicate queue names in config to avoid unexpected fetch algorithm change [#3911]
235
+ - Fix concurrency bug on JRuby [#3958, mattbooks]
236
+ - Add "Kill All" button to the retries page [#3938]
237
+
238
+ 5.2.1
239
+ -----------
240
+
241
+ - Fix concurrent modification error during heartbeat [#3921]
242
+
243
+ 5.2.0
244
+ -----------
245
+
246
+ - **Decrease default concurrency from 25 to 10** [#3892]
247
+ - Verify connection pool sizing upon startup [#3917]
248
+ - Smoother scheduling for large Sidekiq clusters [#3889]
249
+ - Switch Sidekiq::Testing impl from alias\_method to Module#prepend, for resiliency [#3852]
250
+ - Update Sidekiq APIs to use SCAN for scalability [#3848, ffiller]
251
+ - Remove concurrent-ruby gem dependency [#3830]
252
+ - Optimize Web UI's bootstrap.css [#3914]
253
+
254
+ 5.1.3
255
+ -----------
256
+
257
+ - Fix version comparison so Ruby 2.2.10 works. [#3808, nateberkopec]
258
+
259
+ 5.1.2
260
+ -----------
261
+
262
+ - Add link to docs in Web UI footer
263
+ - Fix crash on Ctrl-C in Windows [#3775, Bernica]
264
+ - Remove `freeze` calls on String constants. This is superfluous with Ruby
265
+ 2.3+ and `frozen_string_literal: true`. [#3759]
266
+ - Fix use of AR middleware outside of Rails [#3787]
267
+ - Sidekiq::Worker `sidekiq_retry_in` block can now return nil or 0 to use
268
+ the default backoff delay [#3796, dsalahutdinov]
269
+
270
+ 5.1.1
271
+ -----------
272
+
273
+ - Fix Web UI incompatibility with Redis 3.x gem [#3749]
274
+
275
+ 5.1.0
276
+ -----------
277
+
278
+ - **NEW** Global death handlers - called when your job exhausts all
279
+ retries and dies. Now you can take action when a job fails permanently. [#3721]
280
+ - **NEW** Enable ActiveRecord query cache within jobs by default [#3718, sobrinho]
281
+ This will prevent duplicate SELECTS; cache is cleared upon any UPDATE/INSERT/DELETE.
282
+ See the issue for how to bypass the cache or disable it completely.
283
+ - Scheduler timing is now more accurate, 15 -> 5 seconds [#3734]
284
+ - Exceptions during the :startup event will now kill the process [#3717]
285
+ - Make `Sidekiq::Client.via` reentrant [#3715]
286
+ - Fix use of Sidekiq logger outside of the server process [#3714]
287
+ - Tweak `constantize` to better match Rails class lookup. [#3701, caffeinated-tech]
288
+
289
+ 5.0.5
290
+ -----------
291
+
292
+ - Update gemspec to allow newer versions of the Redis gem [#3617]
293
+ - Refactor Worker.set so it can be memoized [#3602]
294
+ - Fix display of Redis URL in web footer, broken in 5.0.3 [#3560]
295
+ - Update `Sidekiq::Job#display_args` to avoid mutation [#3621]
296
+
297
+ 5.0.4
298
+ -----------
299
+
300
+ - Fix "slow startup" performance regression from 5.0.2. [#3525]
301
+ - Allow users to disable ID generation since some redis providers disable the CLIENT command. [#3521]
302
+
303
+ 5.0.3
304
+ -----------
305
+
306
+ - Fix overriding `class_attribute` core extension from ActiveSupport with Sidekiq one [PikachuEXE, #3499]
307
+ - Allow job logger to be overridden [AlfonsoUceda, #3502]
308
+ - Set a default Redis client identifier for debugging [#3516]
309
+ - Fix "Uninitialized constant" errors on startup with the delayed extensions [#3509]
310
+
311
+ 5.0.2
312
+ -----------
313
+
314
+ - fix broken release, thanks @nateberkopec
315
+
316
+ 5.0.1
317
+ -----------
318
+
319
+ - Fix incorrect server identity when daemonizing [jwilm, #3496]
320
+ - Work around error running Web UI against Redis Cluster [#3492]
321
+ - Remove core extensions, Sidekiq is now monkeypatch-free! [#3474]
322
+ - Reimplement Web UI's HTTP\_ACCEPT\_LANGUAGE parsing because the spec is utterly
323
+ incomprehensible for various edge cases. [johanlunds, natematykiewicz, #3449]
324
+ - Update `class_attribute` core extension to avoid warnings
325
+ - Expose `job_hash_context` from `Sidekiq::Logging` to support log customization
326
+
327
+ 5.0.0
328
+ -----------
329
+
330
+ - **BREAKING CHANGE** Job dispatch was refactored for safer integration with
331
+ Rails 5. The **Logging** and **RetryJobs** server middleware were removed and
332
+ functionality integrated directly into Sidekiq::Processor. These aren't
333
+ commonly used public APIs so this shouldn't impact most users.
334
+ ```
335
+ Sidekiq::Middleware::Server::RetryJobs -> Sidekiq::JobRetry
336
+ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
337
+ ```
338
+ - Quieting Sidekiq is now done via the TSTP signal, the USR1 signal is deprecated.
339
+ - The `delay` extension APIs are no longer available by default, you
340
+ must opt into them.
341
+ - The Web UI is now BiDi and can render RTL languages like Arabic, Farsi and Hebrew.
342
+ - Rails 3.2 and Ruby 2.0 and 2.1 are no longer supported.
343
+ - The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
344
+ - Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
345
+ of random hex bytes.
346
+ - Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
347
+
348
+ 4.2.10
349
+ -----------
350
+
351
+ - Scheduled jobs can now be moved directly to the Dead queue via API [#3390]
352
+ - Fix edge case leading to job duplication when using Sidekiq Pro's
353
+ reliability feature [#3388]
354
+ - Fix error class name display on retry page [#3348]
355
+ - More robust latency calculation [#3340]
356
+
357
+ 4.2.9
358
+ -----------
359
+
360
+ - Rollback [#3303] which broke Heroku Redis users [#3311]
361
+ - Add support for TSTP signal, for Sidekiq 5.0 forward compatibility. [#3302]
362
+
363
+ 4.2.8
364
+ -----------
365
+
366
+ - Fix rare edge case with Redis driver that can create duplicate jobs [#3303]
367
+ - Fix Rails 5 loading issue [#3275]
368
+ - Restore missing tooltips to timestamps in Web UI [#3310]
369
+ - Work on **Sidekiq 5.0** is now active! [#3301]
370
+
371
+ 4.2.7
372
+ -----------
373
+
374
+ - Add new integration testing to verify code loading and job execution
375
+ in development and production modes with Rails 4 and 5 [#3241]
376
+ - Fix delayed extensions in development mode [#3227, DarthSim]
377
+ - Use Worker's `retry` default if job payload does not have a retry
378
+ attribute [#3234, mlarraz]
379
+
380
+ 4.2.6
381
+ -----------
382
+
383
+ - Run Rails Executor when in production [#3221, eugeneius]
384
+
385
+ 4.2.5
386
+ -----------
387
+
388
+ - Re-enable eager loading of all code when running non-development Rails 5. [#3203]
389
+ - Better root URL handling for zany web servers [#3207]
390
+
391
+ 4.2.4
392
+ -----------
393
+
394
+ - Log errors coming from the Rails 5 reloader. [#3212, eugeneius]
395
+ - Clone job data so middleware changes don't appear in Busy tab
396
+
397
+ 4.2.3
398
+ -----------
399
+
400
+ - Disable use of Rails 5's Reloader API in non-development modes, it has proven
401
+ to be unstable under load [#3154]
402
+ - Allow disabling of Sidekiq::Web's cookie session to handle the
403
+ case where the app provides a session already [#3180, inkstak]
404
+ ```ruby
405
+ Sidekiq::Web.set :sessions, false
406
+ ```
407
+ - Fix Web UI sharding support broken in 4.2.2. [#3169]
408
+ - Fix timestamps not updating during UI polling [#3193, shaneog]
409
+ - Relax rack-protection version to >= 1.5.0
410
+ - Provide consistent interface to exception handlers, changing the structure of the context hash. [#3161]
411
+
412
+ 4.2.2
413
+ -----------
414
+
415
+ - Fix ever-increasing cookie size with nginx [#3146, cconstantine]
416
+ - Fix so Web UI works without trailing slash [#3158, timdorr]
417
+
418
+ 4.2.1
419
+ -----------
420
+
421
+ - Ensure browser does not cache JSON/AJAX responses. [#3136]
422
+ - Support old Sinatra syntax for setting config [#3139]
423
+
424
+ 4.2.0
425
+ -----------
426
+
427
+ - Enable development-mode code reloading. **With Rails 5.0+, you don't need
428
+ to restart Sidekiq to pick up your Sidekiq::Worker changes anymore!** [#2457]
429
+ - **Remove Sinatra dependency**. Sidekiq's Web UI now uses Rack directly.
430
+ Thank you to Sidekiq's newest committer, **badosu**, for writing the code
431
+ and doing a lot of testing to ensure compatibility with many different
432
+ 3rd party plugins. If your Web UI works with 4.1.4 but fails with
433
+ 4.2.0, please open an issue. [#3075]
434
+ - Allow tuning of concurrency with the `RAILS_MAX_THREADS` env var. [#2985]
435
+ This is the same var used by Puma so you can tune all of your systems
436
+ the same way:
437
+ ```sh
438
+ web: RAILS_MAX_THREADS=5 bundle exec puma ...
439
+ worker: RAILS_MAX_THREADS=10 bundle exec sidekiq ...
440
+ ```
441
+ Using `-c` or `config/sidekiq.yml` overrides this setting. I recommend
442
+ adjusting your `config/database.yml` to use it too so connections are
443
+ auto-scaled:
444
+ ```yaml
445
+ pool: <%= ENV['RAILS_MAX_THREADS'] || 5 %>
446
+ ```
447
+
448
+ 4.1.4
449
+ -----------
450
+
451
+ - Unlock Sinatra so a Rails 5.0 compatible version may be used [#3048]
452
+ - Fix race condition on startup with JRuby [#3043]
453
+
454
+
455
+ 4.1.3
456
+ -----------
457
+
458
+ - Please note the Redis 3.3.0 gem has a [memory leak](https://github.com/redis/redis-rb/issues/612),
459
+ Redis 3.2.2 is recommended until that issue is fixed.
460
+ - Sinatra 1.4.x is now a required dependency, avoiding cryptic errors
461
+ and old bugs due to people not upgrading Sinatra for years. [#3042]
462
+ - Fixed race condition in heartbeat which could rarely lead to lingering
463
+ processes on the Busy tab. [#2982]
464
+ ```ruby
465
+ # To clean up lingering processes, modify this as necessary to connect to your Redis.
466
+ # After 60 seconds, lingering processes should disappear from the Busy page.
467
+
468
+ require 'redis'
469
+ r = Redis.new(url: "redis://localhost:6379/0")
470
+ # uncomment if you need a namespace
471
+ #require 'redis-namespace'
472
+ #r = Redis::Namespace.new("foo", r)
473
+ r.smembers("processes").each do |pro|
474
+ r.expire(pro, 60)
475
+ r.expire("#{pro}:workers", 60)
476
+ end
477
+ ```
478
+
479
+
480
+ 4.1.2
481
+ -----------
482
+
483
+ - Fix Redis data leak with worker data when a busy Sidekiq process
484
+ crashes. You can find and expire leaked data in Redis with this
485
+ script:
486
+ ```bash
487
+ $ redis-cli keys "*:workers" | while read LINE ; do TTL=`redis-cli expire "$LINE" 60`; echo "$LINE"; done;
488
+ ```
489
+ Please note that `keys` can be dangerous to run on a large, busy Redis. Caveat runner.
490
+ - Freeze all string literals with Ruby 2.3. [#2741]
491
+ - Client middleware can now stop bulk job push. [#2887]
492
+
493
+ 4.1.1
494
+ -----------
495
+
496
+ - Much better behavior when Redis disappears and comes back. [#2866]
497
+ - Update FR locale [dbachet]
498
+ - Don't fill logfile in case of Redis downtime [#2860]
499
+ - Allow definition of a global retries_exhausted handler. [#2807]
500
+ ```ruby
501
+ Sidekiq.configure_server do |config|
502
+ config.default_retries_exhausted = -> (job, ex) do
503
+ Sidekiq.logger.info "#{job['class']} job is now dead"
504
+ end
505
+ end
506
+ ```
507
+
508
+ 4.1.0
509
+ -----------
510
+
511
+ - Tag quiet processes in the Web UI [#2757, jcarlson]
512
+ - Pass last exception to sidekiq\_retries\_exhausted block [#2787, Nowaker]
513
+ ```ruby
514
+ class MyWorker
515
+ include Sidekiq::Worker
516
+ sidekiq_retries_exhausted do |job, exception|
517
+ end
518
+ end
519
+ ```
520
+ - Add native support for ActiveJob's `set(options)` method allowing
521
+ you to override worker options dynamically. This should make it
522
+ even easier to switch between ActiveJob and Sidekiq's native APIs [#2780]
523
+ ```ruby
524
+ class MyWorker
525
+ include Sidekiq::Worker
526
+ sidekiq_options queue: 'default', retry: true
527
+
528
+ def perform(*args)
529
+ # do something
530
+ end
531
+ end
532
+
533
+ MyWorker.set(queue: 'high', retry: false).perform_async(1)
534
+ ```
535
+
536
+ 4.0.2
537
+ -----------
538
+
539
+ - Better Japanese translations
540
+ - Remove `json` gem dependency from gemspec. [#2743]
541
+ - There's a new testing API based off the `Sidekiq::Queues` namespace. All
542
+ assertions made against the Worker class still work as expected.
543
+ [#2676, brandonhilkert]
544
+ ```ruby
545
+ assert_equal 0, Sidekiq::Queues["default"].size
546
+ HardWorker.perform_async("log")
547
+ assert_equal 1, Sidekiq::Queues["default"].size
548
+ assert_equal "log", Sidekiq::Queues["default"].first['args'][0]
549
+ Sidekiq::Queues.clear_all
550
+ ```
551
+
552
+ 4.0.1
553
+ -----------
554
+
555
+ - Yank new queue-based testing API [#2663]
556
+ - Fix invalid constant reference in heartbeat
557
+
558
+ 4.0.0
559
+ -----------
560
+
561
+ - Sidekiq's internals have been completely overhauled for performance
562
+ and to remove dependencies. This has resulted in major speedups, as
563
+ [detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
564
+ - See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
565
+
566
+ 3.5.4
567
+ -----------
568
+
569
+ - Ensure exception message is a string [#2707]
570
+ - Revert racy Process.kill usage in sidekiqctl
571
+
572
+ 3.5.3
573
+ -----------
574
+
575
+ - Adjust shutdown event to run in parallel with the rest of system shutdown. [#2635]
576
+
577
+ 3.5.2
578
+ -----------
579
+
580
+ - **Sidekiq 3 is now in maintenance mode**, only major bugs will be fixed.
581
+ - The exception triggering a retry is now passed into `sidekiq_retry_in`,
582
+ allowing you to retry more frequently for certain types of errors.
583
+ [#2619, kreynolds]
584
+ ```ruby
585
+ sidekiq_retry_in do |count, ex|
586
+ case ex
587
+ when RuntimeError
588
+ 5 * count
589
+ else
590
+ 10 * count
591
+ end
592
+ end
593
+ ```
594
+
595
+ 3.5.1
596
+ -----------
597
+
598
+ - **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
599
+ - Add Ukrainian locale [#2561, elrakita]
600
+ - Disconnect and retry Redis operations if we see a READONLY error [#2550]
601
+ - Add server middleware testing harness; see [wiki](https://github.com/mperham/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
602
+
603
+ 3.5.0
604
+ -----------
605
+
606
+ - Polished new banner! [#2522, firedev]
607
+ - Upgrade to Celluloid 0.17. [#2420, digitalextremist]
608
+ - Activate sessions in Sinatra for CSRF protection, requires Rails
609
+ monkeypatch due to rails/rails#15843. [#2460, jc00ke]
610
+
611
+ 3.4.2
612
+ -----------
613
+
614
+ - Don't allow `Sidekiq::Worker` in ActiveJob::Base classes. [#2424]
615
+ - Safer display of job data in Web UI [#2405]
616
+ - Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
617
+ reporting. [#2422] If you are running the Web UI as a standalone Rack app,
618
+ ensure you have a [session middleware
619
+ configured](https://github.com/mperham/sidekiq/wiki/Monitoring#standalone):
620
+ ```ruby
621
+ use Rack::Session::Cookie, :secret => "some unique secret string here"
622
+ ```
623
+
624
+ 3.4.1
625
+ -----------
626
+
627
+ - Lock to Celluloid 0.16
628
+
629
+
630
+ 3.4.0
631
+ -----------
632
+
633
+ - Set a `created_at` attribute when jobs are created, set `enqueued_at` only
634
+ when they go into a queue. Fixes invalid latency calculations with scheduled jobs.
635
+ [#2373, mrsimo]
636
+ - Don't log timestamp on Heroku [#2343]
637
+ - Run `shutdown` event handlers in reverse order of definition [#2374]
638
+ - Rename and rework `poll_interval` to be simpler, more predictable [#2317, cainlevy]
639
+ The new setting is `average_scheduled_poll_interval`. To configure
640
+ Sidekiq to look for scheduled jobs every 5 seconds, just set it to 5.
641
+ ```ruby
642
+ Sidekiq.configure_server do |config|
643
+ config.average_scheduled_poll_interval = 5
644
+ end
645
+ ```
646
+
647
+ 3.3.4
648
+ -----------
649
+
650
+ - **Improved ActiveJob integration** - Web UI now shows ActiveJobs in a
651
+ nicer format and job logging shows the actual class name, requires
652
+ Rails 4.2.2+ [#2248, #2259]
653
+ - Add Sidekiq::Process#dump\_threads API to trigger TTIN output [#2247]
654
+ - Web UI polling now uses Ajax to avoid page reload [#2266, davydovanton]
655
+ - Several Web UI styling improvements [davydovanton]
656
+ - Add Tamil, Hindi translations for Web UI [ferdinandrosario, tejasbubane]
657
+ - Fix Web UI to work with country-specific locales [#2243]
658
+ - Handle circular error causes [#2285, eugenk]
659
+
660
+ 3.3.3
661
+ -----------
662
+
663
+ - Fix crash on exit when Redis is down [#2235]
664
+ - Fix duplicate logging on startup
665
+ - Undeprecate delay extension for ActionMailer 4.2+ . [#2186]
666
+
667
+ 3.3.2
668
+ -----------
669
+
670
+ - Add Sidekiq::Stats#queues back
671
+ - Allows configuration of dead job set size and timeout [#2173, jonhyman]
672
+ - Refactor scheduler enqueuing so Sidekiq Pro can override it. [#2159]
673
+
674
+ 3.3.1
675
+ -----------
676
+
677
+ - Dumb down ActionMailer integration so it tries to deliver if possible [#2149]
678
+ - Stringify Sidekiq.default\_worker\_options's keys [#2126]
679
+ - Add random integer to process identity [#2113, michaeldiscala]
680
+ - Log Sidekiq Pro's Batch ID if available [#2076]
681
+ - Refactor Processor Redis usage to avoid redis/redis-rb#490 [#2094]
682
+ - Move /dashboard/stats to /stats. Add /stats/queues. [moserke, #2099]
683
+ - Add processes count to /stats [ismaelga, #2141]
684
+ - Greatly improve speed of Sidekiq::Stats [ismaelga, #2142]
685
+ - Add better usage text for `sidekiqctl`.
686
+ - `Sidekiq::Logging.with_context` is now a stack so you can set your
687
+ own job context for logging purposes [grosser, #2110]
688
+ - Remove usage of Google Fonts in Web UI so it loads in China [#2144]
689
+
690
+ 3.3.0
691
+ -----------
692
+
693
+ - Upgrade to Celluloid 0.16 [#2056]
694
+ - Fix typo for generator test file name [dlackty, #2016]
695
+ - Add Sidekiq::Middleware::Chain#prepend [seuros, #2029]
696
+
697
+ 3.2.6
698
+ -----------
699
+
700
+ - Deprecate delay extension for ActionMailer 4.2+ . [seuros, #1933]
701
+ - Poll interval tuning now accounts for dead processes [epchris, #1984]
702
+ - Add non-production environment to Web UI page titles [JacobEvelyn, #2004]
703
+
704
+ 3.2.5
705
+ -----------
706
+
707
+ - Lock Celluloid to 0.15.2 due to bugs in 0.16.0. This prevents the
708
+ "hang on shutdown" problem with Celluloid 0.16.0.
709
+
710
+ 3.2.4
711
+ -----------
712
+
713
+ - Fix issue preventing ActionMailer sends working in some cases with
714
+ Rails 4. [pbhogan, #1923]
715
+
716
+ 3.2.3
717
+ -----------
718
+
719
+ - Clean invalid bytes from error message before converting to JSON (requires Ruby 2.1+) [#1705]
720
+ - Add queues list for each process to the Busy page. [davetoxa, #1897]
721
+ - Fix for crash caused by empty config file. [jordan0day, #1901]
722
+ - Add Rails Worker generator, `rails g sidekiq:worker User` will create `app/workers/user_worker.rb`. [seuros, #1909]
723
+ - Fix Web UI rendering with huge job arguments [jhass, #1918]
724
+ - Minor refactoring of Sidekiq::Client internals, for Sidekiq Pro. [#1919]
725
+
726
+ 3.2.2
727
+ -----------
728
+
729
+ - **This version of Sidekiq will no longer start on Ruby 1.9.** Sidekiq
730
+ 3 does not support MRI 1.9 but we've allowed it to run before now.
731
+ - Fix issue which could cause Sidekiq workers to disappear from the Busy
732
+ tab while still being active [#1884]
733
+ - Add "Back to App" button in Web UI. You can set the button link via
734
+ `Sidekiq::Web.app_url = 'http://www.mysite.com'` [#1875, seuros]
735
+ - Add process tag (`-g tag`) to the Busy page so you can differentiate processes at a glance. [seuros, #1878]
736
+ - Add "Kill" button to move retries directly to the DJQ so they don't retry. [seuros, #1867]
737
+
738
+ 3.2.1
739
+ -----------
740
+
741
+ - Revert eager loading change for Rails 3.x apps, as it broke a few edge
742
+ cases.
743
+
744
+ 3.2.0
745
+ -----------
746
+
747
+ - **Fix issue which caused duplicate job execution in Rails 3.x**
748
+ This issue is caused by [improper exception handling in ActiveRecord](https://github.com/rails/rails/blob/3-2-stable/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L281) which changes Sidekiq's Shutdown exception into a database
749
+ error, making Sidekiq think the job needs to be retried. **The fix requires Ruby 2.1**. [#1805]
750
+ - Update how Sidekiq eager loads Rails application code [#1791, jonleighton]
751
+ - Change logging timestamp to show milliseconds.
752
+ - Reverse sorting of Dead tab so newer jobs are listed first [#1802]
753
+
754
+ 3.1.4
755
+ -----------
756
+
757
+ - Happy π release!
758
+ - Self-tuning Scheduler polling, we use heartbeat info to better tune poll\_interval [#1630]
759
+ - Remove all table column width rules, hopefully get better column formatting [#1747]
760
+ - Handle edge case where YAML can't be decoded in dev mode [#1761]
761
+ - Fix lingering jobs in Busy page on Heroku [#1764]
762
+
763
+ 3.1.3
764
+ -----------
765
+
766
+ - Use ENV['DYNO'] on Heroku for hostname display, rather than an ugly UUID. [#1742]
767
+ - Show per-process labels on the Busy page, for feature tagging [#1673]
768
+
769
+
770
+ 3.1.2
771
+ -----------
772
+
773
+ - Suitably chastised, @mperham reverts the Bundler change.
774
+
775
+
776
+ 3.1.1
777
+ -----------
778
+
779
+ - Sidekiq::CLI now runs `Bundler.require(:default, environment)` to boot all gems
780
+ before loading any app code.
781
+ - Sort queues by name in Web UI [#1734]
782
+
783
+
784
+ 3.1.0
785
+ -----------
786
+
787
+ - New **remote control** feature: you can remotely trigger Sidekiq to quiet
788
+ or terminate via API, without signals. This is most useful on JRuby
789
+ or Heroku which does not support the USR1 'quiet' signal. Now you can
790
+ run a rake task like this at the start of your deploy to quiet your
791
+ set of Sidekiq processes. [#1703]
792
+ ```ruby
793
+ namespace :sidekiq do
794
+ task :quiet => :environment do
795
+ Sidekiq::ProcessSet.new.each(&:quiet!)
796
+ end
797
+ end
798
+ ```
799
+ - The Web UI can use the API to quiet or stop all processes via the Busy page.
800
+ - The Web UI understands and hides the `Sidekiq::Extensions::Delay*`
801
+ classes, instead showing `Class.method` as the Job. [#1718]
802
+ - Polish the Dashboard graphs a bit, update Rickshaw [brandonhilkert, #1725]
803
+ - The poll interval is now configurable in the Web UI [madebydna, #1713]
804
+ - Delay extensions can be removed so they don't conflict with
805
+ DelayedJob: put `Sidekiq.remove_delay!` in your initializer. [devaroop, #1674]
806
+
807
+
808
+ 3.0.2
809
+ -----------
810
+
811
+ - Revert gemfile requirement of Ruby 2.0. JRuby 1.7 calls itself Ruby
812
+ 1.9.3 and broke with this requirement.
813
+
814
+ 3.0.1
815
+ -----------
816
+
817
+ - Revert pidfile behavior from 2.17.5: Sidekiq will no longer remove its own pidfile
818
+ as this is a race condition when restarting. [#1470, #1677]
819
+ - Show warning on the Queues page if a queue is paused [#1672]
820
+ - Only activate the ActiveRecord middleware if ActiveRecord::Base is defined on boot. [#1666]
821
+ - Add ability to disable jobs going to the DJQ with the `dead` option.
822
+ ```ruby
823
+ sidekiq_options :dead => false, :retry => 5
824
+ ```
825
+ - Minor fixes
826
+
827
+
828
+ 3.0.0
829
+ -----------
830
+
831
+ Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
832
+
833
+ - **Dead Job Queue** - jobs which run out of retries are now moved to a dead
834
+ job queue. These jobs must be retried manually or they will expire
835
+ after 6 months or 10,000 jobs. The Web UI contains a "Dead" tab
836
+ exposing these jobs. Use `sidekiq_options :retry => false` if you
837
+ don't wish jobs to be retried or put in the DJQ. Use
838
+ `sidekiq_options :retry => 0` if you don't want jobs to retry but go
839
+ straight to the DJQ.
840
+ - **Process Lifecycle Events** - you can now register blocks to run at
841
+ certain points during the Sidekiq process lifecycle: startup, quiet and
842
+ shutdown.
843
+ ```ruby
844
+ Sidekiq.configure_server do |config|
845
+ config.on(:startup) do
846
+ # do something
847
+ end
848
+ end
849
+ ```
850
+ - **Global Error Handlers** - blocks of code which handle errors that
851
+ occur anywhere within Sidekiq, not just within middleware.
852
+ ```ruby
853
+ Sidekiq.configure_server do |config|
854
+ config.error_handlers << proc {|ex,ctx| ... }
855
+ end
856
+ ```
857
+ - **Process Heartbeat** - each Sidekiq process will ping Redis every 5
858
+ seconds to give a summary of the Sidekiq population at work.
859
+ - The Workers tab is now renamed to Busy and contains a list of live
860
+ Sidekiq processes and jobs in progress based on the heartbeat.
861
+ - **Shardable Client** - Sidekiq::Client instances can use a custom
862
+ Redis connection pool, allowing very large Sidekiq installations to scale by
863
+ sharding: sending different jobs to different Redis instances.
864
+ ```ruby
865
+ client = Sidekiq::Client.new(ConnectionPool.new { Redis.new })
866
+ client.push(...)
867
+ ```
868
+ ```ruby
869
+ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
870
+ FooWorker.perform_async
871
+ BarWorker.perform_async
872
+ end
873
+ ```
874
+ **Sharding support does require a breaking change to client-side
875
+ middleware, see 3.0-Upgrade.md.**
876
+ - New Chinese, Greek, Swedish and Czech translations for the Web UI.
877
+ - Updated most languages translations for the new UI features.
878
+ - **Remove official Capistrano integration** - this integration has been
879
+ moved into the [capistrano-sidekiq](https://github.com/seuros/capistrano-sidekiq) gem.
880
+ - **Remove official support for MRI 1.9** - Things still might work but
881
+ I no longer actively test on it.
882
+ - **Remove built-in support for Redis-to-Go**.
883
+ Heroku users: `heroku config:set REDIS_PROVIDER=REDISTOGO_URL`
884
+ - **Remove built-in error integration for Airbrake, Honeybadger, ExceptionNotifier and Exceptional**.
885
+ Each error gem should provide its own Sidekiq integration. Update your error gem to the latest
886
+ version to pick up Sidekiq support.
887
+ - Upgrade to connection\_pool 2.0 which now creates connections lazily.
888
+ - Remove deprecated Sidekiq::Client.registered\_\* APIs
889
+ - Remove deprecated support for the old Sidekiq::Worker#retries\_exhausted method.
890
+ - Removed 'sidekiq/yaml\_patch', this was never documented or recommended.
891
+ - Removed --profile option, #1592
892
+ - Remove usage of the term 'Worker' in the UI for clarity. Users would call both threads and
893
+ processes 'workers'. Instead, use "Thread", "Process" or "Job".
894
+
895
+ 2.17.7
896
+ -----------
897
+
898
+ - Auto-prune jobs older than one hour from the Workers page [#1508]
899
+ - Add Sidekiq::Workers#prune which can perform the auto-pruning.
900
+ - Fix issue where a job could be lost when an exception occurs updating
901
+ Redis stats before the job executes [#1511]
902
+
903
+ 2.17.6
904
+ -----------
905
+
906
+ - Fix capistrano integration due to missing pidfile. [#1490]
907
+
908
+ 2.17.5
909
+ -----------
910
+
911
+ - Automatically use the config file found at `config/sidekiq.yml`, if not passed `-C`. [#1481]
912
+ - Store 'retried\_at' and 'failed\_at' timestamps as Floats, not Strings. [#1473]
913
+ - A `USR2` signal will now reopen _all_ logs, using IO#reopen. Thus, instead of creating a new Logger object,
914
+ Sidekiq will now just update the existing Logger's file descriptor [#1163].
915
+ - Remove pidfile when shutting down if started with `-P` [#1470]
916
+
917
+ 2.17.4
918
+ -----------
919
+
920
+ - Fix JID support in inline testing, #1454
921
+ - Polish worker arguments display in UI, #1453
922
+ - Marshal arguments fully to avoid worker mutation, #1452
923
+ - Support reverse paging sorted sets, #1098
924
+
925
+
926
+ 2.17.3
927
+ -----------
928
+
929
+ - Synchronously terminates the poller and fetcher to fix a race condition in bulk requeue during shutdown [#1406]
930
+
931
+ 2.17.2
932
+ -----------
933
+
934
+ - Fix bug where strictly prioritized queues might be processed out of
935
+ order [#1408]. A side effect of this change is that it breaks a queue
936
+ declaration syntax that worked, although only because of a bug—it was
937
+ never intended to work and never supported. If you were declaring your
938
+ queues as a comma-separated list, e.g. `sidekiq -q critical,default,low`,
939
+ you must now use the `-q` flag before each queue, e.g.
940
+ `sidekiq -q critical -q default -q low`.
941
+
942
+ 2.17.1
943
+ -----------
944
+
945
+ - Expose `delay` extension as `sidekiq_delay` also. This allows you to
946
+ run Delayed::Job and Sidekiq in the same process, selectively porting
947
+ `delay` calls to `sidekiq_delay`. You just need to ensure that
948
+ Sidekiq is required **before** Delayed::Job in your Gemfile. [#1393]
949
+ - Bump redis client required version to 3.0.6
950
+ - Minor CSS fixes for Web UI
951
+
952
+ 2.17.0
953
+ -----------
954
+
955
+ - Change `Sidekiq::Client#push_bulk` to return an array of pushed `jid`s. [#1315, barelyknown]
956
+ - Web UI refactoring to use more API internally (yummy dogfood!)
957
+ - Much faster Sidekiq::Job#delete performance for larger queue sizes
958
+ - Further capistrano 3 fixes
959
+ - Many misc minor fixes
960
+
961
+ 2.16.1
962
+ -----------
963
+
964
+ - Revert usage of `resolv-replace`. MRI's native DNS lookup releases the GIL.
965
+ - Fix several Capistrano 3 issues
966
+ - Escaping dynamic data like job args and error messages in Sidekiq Web UI. [#1299, lian]
967
+
968
+ 2.16.0
969
+ -----------
970
+
971
+ - Deprecate `Sidekiq::Client.registered_workers` and `Sidekiq::Client.registered_queues`
972
+ - Refactor Sidekiq::Client to be instance-based [#1279]
973
+ - Pass all Redis options to the Redis driver so Unix sockets
974
+ can be fully configured. [#1270, salimane]
975
+ - Allow sidekiq-web extensions to add locale paths so extensions
976
+ can be localized. [#1261, ondrejbartas]
977
+ - Capistrano 3 support [#1254, phallstrom]
978
+ - Use Ruby's `resolv-replace` to enable pure Ruby DNS lookups.
979
+ This ensures that any DNS resolution that takes place in worker
980
+ threads won't lock up the entire VM on MRI. [#1258]
981
+
982
+ 2.15.2
983
+ -----------
984
+
985
+ - Iterating over Sidekiq::Queue and Sidekiq::SortedSet will now work as
986
+ intended when jobs are deleted [#866, aackerman]
987
+ - A few more minor Web UI fixes [#1247]
988
+
989
+ 2.15.1
990
+ -----------
991
+
992
+ - Fix several Web UI issues with the Bootstrap 3 upgrade.
993
+
994
+ 2.15.0
995
+ -----------
996
+
997
+ - The Core Sidekiq actors are now monitored. If any crash, the
998
+ Sidekiq process logs the error and exits immediately. This is to
999
+ help prevent "stuck" Sidekiq processes which are running but don't
1000
+ appear to be doing any work. [#1194]
1001
+ - Sidekiq's testing behavior is now dynamic. You can choose between
1002
+ `inline` and `fake` behavior in your tests. See
1003
+ [Testing](https://github.com/mperham/sidekiq/wiki/Testing) for detail. [#1193]
1004
+ - The Retries table has a new column for the error message.
1005
+ - The Web UI topbar now contains the status and live poll button.
1006
+ - Orphaned worker records are now auto-vacuumed when you visit the
1007
+ Workers page in the Web UI.
1008
+ - Sidekiq.default\_worker\_options allows you to configure default
1009
+ options for all Sidekiq worker types.
1010
+
1011
+ ```ruby
1012
+ Sidekiq.default_worker_options = { 'queue' => 'default', 'backtrace' => true }
1013
+ ```
1014
+ - Added two Sidekiq::Client class methods for compatibility with resque-scheduler:
1015
+ `enqueue_to_in` and `enqueue_in` [#1212]
1016
+ - Upgrade Web UI to Bootstrap 3.0. [#1211, jeffboek]
1017
+
1018
+ 2.14.1
1019
+ -----------
1020
+
1021
+ - Fix misc Web UI issues due to ERB conversion.
1022
+ - Bump redis-namespace version due to security issue.
1023
+
1024
+ 2.14.0
1025
+ -----------
1026
+
1027
+ - Removed slim gem dependency, Web UI now uses ERB [Locke23rus, #1120]
1028
+ - Fix more race conditions in Web UI actions
1029
+ - Don't reset Job enqueued\_at when retrying
1030
+ - Timestamp tooltips in the Web UI should use UTC
1031
+ - Fix invalid usage of handle\_exception causing issues in Airbrake
1032
+ [#1134]
1033
+
1034
+
1035
+ 2.13.1
1036
+ -----------
1037
+
1038
+ - Make Sidekiq::Middleware::Chain Enumerable
1039
+ - Make summary bar and graphs responsive [manishval, #1025]
1040
+ - Adds a job status page for scheduled jobs [jonhyman]
1041
+ - Handle race condition in retrying and deleting jobs in the Web UI
1042
+ - The Web UI relative times are now i18n. [MadRabbit, #1088]
1043
+ - Allow for default number of retry attempts to be set for
1044
+ `Sidekiq::Middleware::Server::RetryJobs` middleware. [czarneckid] [#1091]
1045
+
1046
+ ```ruby
1047
+ Sidekiq.configure_server do |config|
1048
+ config.server_middleware do |chain|
1049
+ chain.add Sidekiq::Middleware::Server::RetryJobs, :max_retries => 10
1050
+ end
1051
+ end
1052
+ ```
1053
+
1054
+
1055
+ 2.13.0
1056
+ -----------
1057
+
1058
+ - Adding button to move scheduled job to main queue [guiceolin, #1020]
1059
+ - fix i18n support resetting saved locale when job is retried [#1011]
1060
+ - log rotation via USR2 now closes the old logger [#1008]
1061
+ - Add ability to customize retry schedule, like so [jmazzi, #1027]
1062
+
1063
+ ```ruby
1064
+ class MyWorker
1065
+ include Sidekiq::Worker
1066
+ sidekiq_retry_in { |count| count * 2 }
1067
+ end
1068
+ ```
1069
+ - Redesign Worker#retries\_exhausted callback to use same form as above [jmazzi, #1030]
1070
+
1071
+ ```ruby
1072
+ class MyWorker
1073
+ include Sidekiq::Worker
1074
+ sidekiq_retries_exhausted do |msg|
1075
+ Rails.logger.error "Failed to process #{msg['class']} with args: #{msg['args']}"
1076
+ end
1077
+ end
1078
+ ```
1079
+
1080
+ 2.12.4
1081
+ -----------
1082
+
1083
+ - Fix error in previous release which crashed the Manager when a
1084
+ Processor died.
1085
+
1086
+ 2.12.3
1087
+ -----------
1088
+
1089
+ - Revert back to Celluloid's TaskFiber for job processing which has proven to be more
1090
+ stable than TaskThread. [#985]
1091
+ - Avoid possible lockup during hard shutdown [#997]
1092
+
1093
+ At this point, if you are experiencing stability issues with Sidekiq in
1094
+ Ruby 1.9, please try Ruby 2.0. It seems to be more stable.
1095
+
1096
+ 2.12.2
1097
+ -----------
1098
+
1099
+ - Relax slim version requirement to >= 1.1.0
1100
+ - Refactor historical stats to use TTL, not explicit cleanup. [grosser, #971]
1101
+
1102
+ 2.12.1
1103
+ -----------
1104
+
1105
+ - Force Celluloid 0.14.1 as 0.14.0 has a serious bug. [#954]
1106
+ - Scheduled and Retry jobs now use Sidekiq::Client to push
1107
+ jobs onto the queue, so they use client middleware. [dimko, #948]
1108
+ - Record the timestamp when jobs are enqueued. Add
1109
+ Sidekiq::Job#enqueued\_at to query the time. [mariovisic, #944]
1110
+ - Add Sidekiq::Queue#latency - calculates diff between now and
1111
+ enqueued\_at for the oldest job in the queue.
1112
+ - Add testing method `perform_one` that dequeues and performs a single job.
1113
+ This is mainly to aid testing jobs that spawn other jobs. [fumin, #963]
1114
+
1115
+ 2.12.0
1116
+ -----------
1117
+
1118
+ - Upgrade to Celluloid 0.14, remove the use of Celluloid's thread
1119
+ pool. This should halve the number of threads in each Sidekiq
1120
+ process, thus requiring less resources. [#919]
1121
+ - Abstract Celluloid usage to Sidekiq::Actor for testing purposes.
1122
+ - Better handling for Redis downtime when fetching jobs and shutting
1123
+ down, don't print exceptions every second and print success message
1124
+ when Redis is back.
1125
+ - Fix unclean shutdown leading to duplicate jobs [#897]
1126
+ - Add Korean locale [#890]
1127
+ - Upgrade test suite to Minitest 5
1128
+ - Remove usage of `multi_json` as `json` is now robust on all platforms.
1129
+
1130
+ 2.11.2
1131
+ -----------
1132
+
1133
+ - Fix Web UI when used without Rails [#886]
1134
+ - Add Sidekiq::Stats#reset [#349]
1135
+ - Add Norwegian locale.
1136
+ - Updates for the JA locale.
1137
+
1138
+ 2.11.1
1139
+ -----------
1140
+
1141
+ - Fix timeout warning.
1142
+ - Add Dutch web UI locale.
1143
+
1144
+ 2.11.0
1145
+ -----------
1146
+
1147
+ - Upgrade to Celluloid 0.13. [#834]
1148
+ - Remove **timeout** support from `sidekiq_options`. Ruby's timeout
1149
+ is inherently unsafe in a multi-threaded application and was causing
1150
+ stability problems for many. See http://bit.ly/OtYpK
1151
+ - Add Japanese locale for Web UI [#868]
1152
+ - Fix a few issues with Web UI i18n.
1153
+
1154
+ 2.10.1
1155
+ -----------
1156
+
1157
+ - Remove need for the i18n gem. (brandonhilkert)
1158
+ - Improve redis connection info logging on startup for debugging
1159
+ purposes [#858]
1160
+ - Revert sinatra/slim as runtime dependencies
1161
+ - Add `find_job` method to sidekiq/api
1162
+
1163
+
1164
+ 2.10.0
1165
+ -----------
1166
+
1167
+ - Refactor algorithm for putting scheduled jobs onto the queue [#843]
1168
+ - Fix scheduler thread dying due to incorrect error handling [#839]
1169
+ - Fix issue which left stale workers if Sidekiq wasn't shutdown while
1170
+ quiet. [#840]
1171
+ - I18n for web UI. Please submit translations of `web/locales/en.yml` for
1172
+ your own language. [#811]
1173
+ - 'sinatra', 'slim' and 'i18n' are now gem dependencies for Sidekiq.
1174
+
1175
+
1176
+ 2.9.0
1177
+ -----------
1178
+
1179
+ - Update 'sidekiq/testing' to work with any Sidekiq::Client call. It
1180
+ also serializes the arguments as using Redis would. [#713]
1181
+ - Raise a Sidekiq::Shutdown error within workers which don't finish within the hard
1182
+ timeout. This is to prevent unwanted database transaction commits. [#377]
1183
+ - Lazy load Redis connection pool, you no longer need to specify
1184
+ anything in Passenger or Unicorn's after_fork callback [#794]
1185
+ - Add optional Worker#retries_exhausted hook after max retries failed. [jkassemi, #780]
1186
+ - Fix bug in pagination link to last page [pitr, #774]
1187
+ - Upstart scripts for multiple Sidekiq instances [dariocravero, #763]
1188
+ - Use select via pipes instead of poll to catch signals [mrnugget, #761]
1189
+
1190
+ 2.8.0
1191
+ -----------
1192
+
1193
+ - I18n support! Sidekiq can optionally save and restore the Rails locale
1194
+ so it will be properly set when your jobs execute. Just include
1195
+ `require 'sidekiq/middleware/i18n'` in your sidekiq initializer. [#750]
1196
+ - Fix bug which could lose messages when using namespaces and the message
1197
+ needs to be requeued in Redis. [#744]
1198
+ - Refactor Redis namespace support [#747]. The redis namespace can no longer be
1199
+ passed via the config file, the only supported way is via Ruby in your
1200
+ initializer:
1201
+
1202
+ ```ruby
1203
+ sidekiq_redis = { :url => 'redis://localhost:3679', :namespace => 'foo' }
1204
+ Sidekiq.configure_server { |config| config.redis = sidekiq_redis }
1205
+ Sidekiq.configure_client { |config| config.redis = sidekiq_redis }
1206
+ ```
1207
+
1208
+ A warning is printed out to the log if a namespace is found in your sidekiq.yml.
1209
+
1210
+
1211
+ 2.7.5
1212
+ -----------
1213
+
1214
+ - Capistrano no longer uses daemonization in order to work with JRuby [#719]
1215
+ - Refactor signal handling to work on Ruby 2.0 [#728, #730]
1216
+ - Fix dashboard refresh URL [#732]
1217
+
1218
+ 2.7.4
1219
+ -----------
1220
+
1221
+ - Fixed daemonization, was broken by some internal refactoring in 2.7.3 [#727]
1222
+
1223
+ 2.7.3
1224
+ -----------
1225
+
1226
+ - Real-time dashboard is now the default web page
1227
+ - Make config file optional for capistrano
1228
+ - Fix Retry All button in the Web UI
1229
+
1230
+ 2.7.2
1231
+ -----------
1232
+
1233
+ - Remove gem signing infrastructure. It was causing Sidekiq to break
1234
+ when used via git in Bundler. This is why we can't have nice things. [#688]
1235
+
1236
+
1237
+ 2.7.1
1238
+ -----------
1239
+
1240
+ - Fix issue with hard shutdown [#680]
1241
+
1242
+
1243
+ 2.7.0
1244
+ -----------
1245
+
1246
+ - Add -d daemonize flag, capistrano recipe has been updated to use it [#662]
1247
+ - Support profiling via `ruby-prof` with -p. When Sidekiq is stopped
1248
+ via Ctrl-C, it will output `profile.html`. You must add `gem 'ruby-prof'` to your Gemfile for it to work.
1249
+ - Dynamically update Redis stats on dashboard [brandonhilkert]
1250
+ - Add Sidekiq::Workers API giving programmatic access to the current
1251
+ set of active workers.
1252
+
1253
+ ```
1254
+ workers = Sidekiq::Workers.new
1255
+ workers.size => 2
1256
+ workers.each do |name, work|
1257
+ # name is a unique identifier per Processor instance
1258
+ # work is a Hash which looks like:
1259
+ # { 'queue' => name, 'run_at' => timestamp, 'payload' => msg }
1260
+ end
1261
+ ```
1262
+
1263
+ - Allow environment-specific sections within the config file which
1264
+ override the global values [dtaniwaki, #630]
1265
+
1266
+ ```
1267
+ ---
1268
+ :concurrency: 50
1269
+ :verbose: false
1270
+ staging:
1271
+ :verbose: true
1272
+ :concurrency: 5
1273
+ ```
1274
+
1275
+
1276
+ 2.6.5
1277
+ -----------
1278
+
1279
+ - Several reliability fixes for job requeueing upon termination [apinstein, #622, #624]
1280
+ - Fix typo in capistrano recipe
1281
+ - Add `retry_queue` option so retries can be given lower priority [ryanlower, #620]
1282
+
1283
+ ```ruby
1284
+ sidekiq_options queue: 'high', retry_queue: 'low'
1285
+ ```
1286
+
1287
+ 2.6.4
1288
+ -----------
1289
+
1290
+ - Fix crash upon empty queue [#612]
1291
+
1292
+ 2.6.3
1293
+ -----------
1294
+
1295
+ - sidekiqctl exits with non-zero exit code upon error [jmazzi]
1296
+ - better argument validation in Sidekiq::Client [karlfreeman]
1297
+
1298
+ 2.6.2
1299
+ -----------
1300
+
1301
+ - Add Dashboard beacon indicating when stats are updated. [brandonhilkert, #606]
1302
+ - Revert issue with capistrano restart. [#598]
1303
+
1304
+ 2.6.1
1305
+ -----------
1306
+
1307
+ - Dashboard now live updates summary stats also. [brandonhilkert, #605]
1308
+ - Add middleware chain APIs `insert_before` and `insert_after` for fine
1309
+ tuning the order of middleware. [jackrg, #595]
1310
+
1311
+ 2.6.0
1312
+ -----------
1313
+
1314
+ - Web UI much more mobile friendly now [brandonhilkert, #573]
1315
+ - Enable live polling for every section in Web UI [brandonhilkert, #567]
1316
+ - Add Stats API [brandonhilkert, #565]
1317
+ - Add Stats::History API [brandonhilkert, #570]
1318
+ - Add Dashboard to Web UI with live and historical stat graphs [brandonhilkert, #580]
1319
+ - Add option to log output to a file, reopen log file on USR2 signal [mrnugget, #581]
1320
+
1321
+ 2.5.4
1322
+ -----------
1323
+
1324
+ - `Sidekiq::Client.push` now accepts the worker class as a string so the
1325
+ Sidekiq client does not have to load your worker classes at all. [#524]
1326
+ - `Sidekiq::Client.push_bulk` now works with inline testing.
1327
+ - **Really** fix status icon in Web UI this time.
1328
+ - Add "Delete All" and "Retry All" buttons to Retries in Web UI
1329
+
1330
+
1331
+ 2.5.3
1332
+ -----------
1333
+
1334
+ - Small Web UI fixes
1335
+ - Add `delay_until` so you can delay jobs until a specific timestamp:
1336
+
1337
+ ```ruby
1338
+ Auction.delay_until(@auction.ends_at).close(@auction.id)
1339
+ ```
1340
+
1341
+ This is identical to the existing Sidekiq::Worker method, `perform_at`.
1342
+
1343
+ 2.5.2
1344
+ -----------
1345
+
1346
+ - Remove asset pipeline from Web UI for much faster, simpler runtime. [#499, #490, #481]
1347
+ - Add -g option so the procline better identifies a Sidekiq process, defaults to File.basename(Rails.root). [#486]
1348
+
1349
+ sidekiq 2.5.1 myapp [0 of 25 busy]
1350
+
1351
+ - Add splay to retry time so groups of failed jobs don't fire all at once. [#483]
1352
+
1353
+ 2.5.1
1354
+ -----------
1355
+
1356
+ - Fix issues with core\_ext
1357
+
1358
+ 2.5.0
1359
+ -----------
1360
+
1361
+ - REDESIGNED WEB UI! [unity, cavneb]
1362
+ - Support Honeybadger for error delivery
1363
+ - Inline testing runs the client middleware before executing jobs [#465]
1364
+ - Web UI can now remove jobs from queue. [#466, dleung]
1365
+ - Web UI can now show the full message, not just 100 chars [#464, dleung]
1366
+ - Add APIs for manipulating the retry and job queues. See sidekiq/api. [#457]
1367
+
1368
+
1369
+ 2.4.0
1370
+ -----------
1371
+
1372
+ - ActionMailer.delay.method now only tries to deliver if method returns a valid message.
1373
+ - Logging now uses "MSG-#{Job ID}", not a random msg ID
1374
+ - Allow generic Redis provider as environment variable. [#443]
1375
+ - Add ability to customize sidekiq\_options with delay calls [#450]
1376
+
1377
+ ```ruby
1378
+ Foo.delay(:retry => false).bar
1379
+ Foo.delay(:retry => 10).bar
1380
+ Foo.delay(:timeout => 10.seconds).bar
1381
+ Foo.delay_for(5.minutes, :timeout => 10.seconds).bar
1382
+ ```
1383
+
1384
+ 2.3.3
1385
+ -----------
1386
+
1387
+ - Remove option to disable Rails hooks. [#401]
1388
+ - Allow delay of any module class method
1389
+
1390
+ 2.3.2
1391
+ -----------
1392
+
1393
+ - Fix retry. 2.3.1 accidentally disabled it.
1394
+
1395
+ 2.3.1
1396
+ -----------
1397
+
1398
+ - Add Sidekiq::Client.push\_bulk for bulk adding of jobs to Redis.
1399
+ My own simple test case shows pushing 10,000 jobs goes from 5 sec to 1.5 sec.
1400
+ - Add support for multiple processes per host to Capistrano recipe
1401
+ - Re-enable Celluloid::Actor#defer to fix stack overflow issues [#398]
1402
+
1403
+ 2.3.0
1404
+ -----------
1405
+
1406
+ - Upgrade Celluloid to 0.12
1407
+ - Upgrade Twitter Bootstrap to 2.1.0
1408
+ - Rescue more Exceptions
1409
+ - Change Job ID to be Hex, rather than Base64, for HTTP safety
1410
+ - Use `Airbrake#notify_or_ignore`
1411
+
1412
+ 2.2.1
1413
+ -----------
1414
+
1415
+ - Add support for custom tabs to Sidekiq::Web [#346]
1416
+ - Change capistrano recipe to run 'quiet' before deploy:update\_code so
1417
+ it is run upon both 'deploy' and 'deploy:migrations'. [#352]
1418
+ - Rescue Exception rather than StandardError to catch and log any sort
1419
+ of Processor death.
1420
+
1421
+ 2.2.0
1422
+ -----------
1423
+
1424
+ - Roll back Celluloid optimizations in 2.1.0 which caused instability.
1425
+ - Add extension to delay any arbitrary class method to Sidekiq.
1426
+ Previously this was limited to ActiveRecord classes.
1427
+
1428
+ ```ruby
1429
+ SomeClass.delay.class_method(1, 'mike', Date.today)
1430
+ ```
1431
+
1432
+ - Sidekiq::Client now generates and returns a random, 128-bit Job ID 'jid' which
1433
+ can be used to track the processing of a Job, e.g. for calling back to a webhook
1434
+ when a job is finished.
1435
+
1436
+ 2.1.1
1437
+ -----------
1438
+
1439
+ - Handle networking errors causing the scheduler thread to die [#309]
1440
+ - Rework exception handling to log all Processor and actor death (#325, subelsky)
1441
+ - Clone arguments when calling worker so modifications are discarded. (#265, hakanensari)
1442
+
1443
+ 2.1.0
1444
+ -----------
1445
+
1446
+ - Tune Celluloid to no longer run message processing within a Fiber.
1447
+ This gives us a full Thread stack and also lowers Sidekiq's memory
1448
+ usage.
1449
+ - Add pagination within the Web UI [#253]
1450
+ - Specify which Redis driver to use: *hiredis* or *ruby* (default)
1451
+ - Remove FailureJobs and UniqueJobs, which were optional middleware
1452
+ that I don't want to support in core. [#302]
1453
+
1454
+ 2.0.3
1455
+ -----------
1456
+ - Fix sidekiq-web's navbar on mobile devices and windows under 980px (ezkl)
1457
+ - Fix Capistrano task for first deploys [#259]
1458
+ - Worker subclasses now properly inherit sidekiq\_options set in
1459
+ their superclass [#221]
1460
+ - Add random jitter to scheduler to spread polls across POLL\_INTERVAL
1461
+ window. [#247]
1462
+ - Sidekiq has a new mailing list: sidekiq@librelist.org See README.
1463
+
1464
+ 2.0.2
1465
+ -----------
1466
+
1467
+ - Fix "Retry Now" button on individual retry page. (ezkl)
1468
+
1469
+ 2.0.1
1470
+ -----------
1471
+
1472
+ - Add "Clear Workers" button to UI. If you kill -9 Sidekiq, the workers
1473
+ set can fill up with stale entries.
1474
+ - Update sidekiq/testing to support new scheduled jobs API:
1475
+
1476
+ ```ruby
1477
+ require 'sidekiq/testing'
1478
+ DirectWorker.perform_in(10.seconds, 1, 2)
1479
+ assert_equal 1, DirectWorker.jobs.size
1480
+ assert_in_delta 10.seconds.from_now.to_f, DirectWorker.jobs.last['at'], 0.01
1481
+ ```
1482
+
1483
+ 2.0.0
1484
+ -----------
1485
+
1486
+ - **SCHEDULED JOBS**!
1487
+
1488
+ You can now use `perform_at` and `perform_in` to schedule jobs
1489
+ to run at arbitrary points in the future, like so:
1490
+
1491
+ ```ruby
1492
+ SomeWorker.perform_in(5.days, 'bob', 13)
1493
+ SomeWorker.perform_at(5.days.from_now, 'bob', 13)
1494
+ ```
1495
+
1496
+ It also works with the delay extensions:
1497
+
1498
+ ```ruby
1499
+ UserMailer.delay_for(5.days).send_welcome_email(user.id)
1500
+ ```
1501
+
1502
+ The time is approximately when the job will be placed on the queue;
1503
+ it is not guaranteed to run at precisely at that moment in time.
1504
+
1505
+ This functionality is meant for one-off, arbitrary jobs. I still
1506
+ recommend `whenever` or `clockwork` if you want cron-like,
1507
+ recurring jobs. See `examples/scheduling.rb`
1508
+
1509
+ I want to specially thank @yabawock for his work on sidekiq-scheduler.
1510
+ His extension for Sidekiq 1.x filled an obvious functional gap that I now think is
1511
+ useful enough to implement in Sidekiq proper.
1512
+
1513
+ - Fixed issues due to Redis 3.x API changes. Sidekiq now requires
1514
+ the Redis 3.x client.
1515
+ - Inline testing now round trips arguments through JSON to catch
1516
+ serialization issues (betelgeuse)
1517
+
1518
+ 1.2.1
1519
+ -----------
1520
+
1521
+ - Sidekiq::Worker now has access to Sidekiq's standard logger
1522
+ - Fix issue with non-StandardErrors leading to Processor exhaustion
1523
+ - Fix issue with Fetcher slowing Sidekiq shutdown
1524
+ - Print backtraces for all threads upon TTIN signal [#183]
1525
+ - Overhaul retries Web UI with new index page and bulk operations [#184]
1526
+
1527
+ 1.2.0
1528
+ -----------
1529
+
1530
+ - Full or partial error backtraces can optionally be stored as part of the retry
1531
+ for display in the web UI if you aren't using an error service. [#155]
1532
+
1533
+ ```ruby
1534
+ class Worker
1535
+ include Sidekiq::Worker
1536
+ sidekiq_options :backtrace => [true || 10]
1537
+ end
1538
+ ```
1539
+ - Add timeout option to kill a worker after N seconds (blackgold9)
1540
+
1541
+ ```ruby
1542
+ class HangingWorker
1543
+ include Sidekiq::Worker
1544
+ sidekiq_options :timeout => 600
1545
+ def perform
1546
+ # will be killed if it takes longer than 10 minutes
1547
+ end
1548
+ end
1549
+ ```
1550
+
1551
+ - Fix delayed extensions not available in workers [#152]
1552
+ - In test environments add the `#drain` class method to workers. This method
1553
+ executes all previously queued jobs. (panthomakos)
1554
+ - Sidekiq workers can be run inline during tests, just `require 'sidekiq/testing/inline'` (panthomakos)
1555
+ - Queues can now be deleted from the Sidekiq web UI [#154]
1556
+ - Fix unnecessary shutdown delay due to Retry Poller [#174]
1557
+
1558
+ 1.1.4
1559
+ -----------
1560
+
1561
+ - Add 24 hr expiry for basic keys set in Redis, to avoid any possible leaking.
1562
+ - Only register workers in Redis while working, to avoid lingering
1563
+ workers [#156]
1564
+ - Speed up shutdown significantly.
1565
+
1566
+ 1.1.3
1567
+ -----------
1568
+
1569
+ - Better network error handling when fetching jobs from Redis.
1570
+ Sidekiq will retry once per second until it can re-establish
1571
+ a connection. (ryanlecompte)
1572
+ - capistrano recipe now uses `bundle_cmd` if set [#147]
1573
+ - handle multi\_json API changes (sferik)
1574
+
1575
+ 1.1.2
1576
+ -----------
1577
+
1578
+ - Fix double restart with cap deploy [#137]
1579
+
1580
+ 1.1.1
1581
+ -----------
1582
+
1583
+ - Set procline for easy monitoring of Sidekiq status via "ps aux"
1584
+ - Fix race condition on shutdown [#134]
1585
+ - Fix hang with cap sidekiq:start [#131]
1586
+
1587
+ 1.1.0
1588
+ -----------
1589
+
1590
+ - The Sidekiq license has switched from GPLv3 to LGPLv3!
1591
+ - Sidekiq::Client.push now returns whether the actual Redis
1592
+ operation succeeded or not. [#123]
1593
+ - Remove UniqueJobs from the default middleware chain. Its
1594
+ functionality, while useful, is unexpected for new Sidekiq
1595
+ users. You can re-enable it with the following config.
1596
+ Read #119 for more discussion.
1597
+
1598
+ ```ruby
1599
+ Sidekiq.configure_client do |config|
1600
+ require 'sidekiq/middleware/client/unique_jobs'
1601
+ config.client_middleware do |chain|
1602
+ chain.add Sidekiq::Middleware::Client::UniqueJobs
1603
+ end
1604
+ end
1605
+ Sidekiq.configure_server do |config|
1606
+ require 'sidekiq/middleware/server/unique_jobs'
1607
+ config.server_middleware do |chain|
1608
+ chain.add Sidekiq::Middleware::Server::UniqueJobs
1609
+ end
1610
+ end
1611
+ ```
1612
+
1613
+ 1.0.0
1614
+ -----------
1615
+
1616
+ Thanks to all Sidekiq users and contributors for helping me
1617
+ get to this big milestone!
1618
+
1619
+ - Default concurrency on client-side to 5, not 25 so we don't
1620
+ create as many unused Redis connections, same as ActiveRecord's
1621
+ default pool size.
1622
+ - Ensure redis= is given a Hash or ConnectionPool.
1623
+
1624
+ 0.11.2
1625
+ -----------
1626
+
1627
+ - Implement "safe shutdown". The messages for any workers that
1628
+ are still busy when we hit the TERM timeout will be requeued in
1629
+ Redis so the messages are not lost when the Sidekiq process exits.
1630
+ [#110]
1631
+ - Work around Celluloid's small 4kb stack limit [#115]
1632
+ - Add support for a custom Capistrano role to limit Sidekiq to
1633
+ a set of machines. [#113]
1634
+
1635
+ 0.11.1
1636
+ -----------
1637
+
1638
+ - Fix fetch breaking retry when used with Redis namespaces. [#109]
1639
+ - Redis connection now just a plain ConnectionPool, not CP::Wrapper.
1640
+ - Capistrano initial deploy fix [#106]
1641
+ - Re-implemented weighted queues support (ryanlecompte)
1642
+
1643
+ 0.11.0
1644
+ -----------
1645
+
1646
+ - Client-side API changes, added sidekiq\_options for Sidekiq::Worker.
1647
+ As a side effect of this change, the client API works on Ruby 1.8.
1648
+ It's not officially supported but should work [#103]
1649
+ - NO POLL! Sidekiq no longer polls Redis, leading to lower network
1650
+ utilization and lower latency for message processing.
1651
+ - Add --version CLI option
1652
+
1653
+ 0.10.1
1654
+ -----------
1655
+
1656
+ - Add details page for jobs in retry queue (jcoene)
1657
+ - Display relative timestamps in web interface (jcoene)
1658
+ - Capistrano fixes (hinrik, bensie)
1659
+
1660
+ 0.10.0
1661
+ -----------
1662
+
1663
+ - Reworked capistrano recipe to make it more fault-tolerant [#94].
1664
+ - Automatic failure retry! Sidekiq will now save failed messages
1665
+ and retry them, with an exponential backoff, over about 20 days.
1666
+ Did a message fail to process? Just deploy a bug fix in the next
1667
+ few days and Sidekiq will retry the message eventually.
1668
+
1669
+ 0.9.1
1670
+ -----------
1671
+
1672
+ - Fix missed deprecations, poor method name in web UI
1673
+
1674
+ 0.9.0
1675
+ -----------
1676
+
1677
+ - Add -t option to configure the TERM shutdown timeout
1678
+ - TERM shutdown timeout is now configurable, defaults to 5 seconds.
1679
+ - USR1 signal now stops Sidekiq from accepting new work,
1680
+ capistrano sends USR1 at start of deploy and TERM at end of deploy
1681
+ giving workers the maximum amount of time to finish.
1682
+ - New Sidekiq::Web rack application available
1683
+ - Updated Sidekiq.redis API
1684
+
1685
+ 0.8.0
1686
+ -----------
1687
+
1688
+ - Remove :namespace and :server CLI options (mperham)
1689
+ - Add ExceptionNotifier support (masterkain)
1690
+ - Add capistrano support (mperham)
1691
+ - Workers now log upon start and finish (mperham)
1692
+ - Messages for terminated workers are now automatically requeued (mperham)
1693
+ - Add support for Exceptional error reporting (bensie)
1694
+
1695
+ 0.7.0
1696
+ -----------
1697
+
1698
+ - Example chef recipe and monitrc script (jc00ke)
1699
+ - Refactor global configuration into Sidekiq.configure\_server and
1700
+ Sidekiq.configure\_client blocks. (mperham)
1701
+ - Add optional middleware FailureJobs which saves failed jobs to a
1702
+ 'failed' queue (fbjork)
1703
+ - Upon shutdown, workers are now terminated after 5 seconds. This is to
1704
+ meet Heroku's hard limit of 10 seconds for a process to shutdown. (mperham)
1705
+ - Refactor middleware API for simplicity, see sidekiq/middleware/chain. (mperham)
1706
+ - Add `delay` extensions for ActionMailer and ActiveRecord. (mperham)
1707
+ - Added config file support. See test/config.yml for an example file. (jc00ke)
1708
+ - Added pidfile for tools like monit (jc00ke)
1709
+
1710
+ 0.6.0
1711
+ -----------
1712
+
1713
+ - Resque-compatible processing stats in redis (mperham)
1714
+ - Simple client testing support in sidekiq/testing (mperham)
1715
+ - Plain old Ruby support via the -r cli flag (mperham)
1716
+ - Refactored middleware support, introducing ability to add client-side middleware (ryanlecompte)
1717
+ - Added middleware for ignoring duplicate jobs (ryanlecompte)
1718
+ - Added middleware for displaying jobs in resque-web dashboard (maxjustus)
1719
+ - Added redis namespacing support (maxjustus)
1720
+
1721
+ 0.5.1
1722
+ -----------
1723
+
1724
+ - Initial release!