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