ultra-fast-tool 0.0.1

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