sidekiq 6.5.10 → 7.1.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (107) hide show
  1. checksums.yaml +4 -4
  2. data/Changes.md +159 -18
  3. data/README.md +42 -34
  4. data/bin/sidekiq +3 -8
  5. data/bin/sidekiqload +204 -118
  6. data/bin/sidekiqmon +3 -0
  7. data/lib/sidekiq/api.rb +114 -128
  8. data/lib/sidekiq/capsule.rb +127 -0
  9. data/lib/sidekiq/cli.rb +56 -74
  10. data/lib/sidekiq/client.rb +66 -37
  11. data/lib/sidekiq/component.rb +4 -1
  12. data/lib/sidekiq/config.rb +287 -0
  13. data/lib/sidekiq/deploy.rb +62 -0
  14. data/lib/sidekiq/embedded.rb +61 -0
  15. data/lib/sidekiq/fetch.rb +11 -14
  16. data/lib/sidekiq/job.rb +371 -10
  17. data/lib/sidekiq/job_logger.rb +2 -2
  18. data/lib/sidekiq/job_retry.rb +33 -15
  19. data/lib/sidekiq/job_util.rb +51 -15
  20. data/lib/sidekiq/launcher.rb +66 -62
  21. data/lib/sidekiq/logger.rb +1 -26
  22. data/lib/sidekiq/manager.rb +9 -11
  23. data/lib/sidekiq/metrics/query.rb +3 -3
  24. data/lib/sidekiq/metrics/shared.rb +8 -7
  25. data/lib/sidekiq/metrics/tracking.rb +20 -18
  26. data/lib/sidekiq/middleware/chain.rb +19 -18
  27. data/lib/sidekiq/middleware/current_attributes.rb +52 -20
  28. data/lib/sidekiq/monitor.rb +16 -3
  29. data/lib/sidekiq/paginator.rb +1 -1
  30. data/lib/sidekiq/processor.rb +46 -51
  31. data/lib/sidekiq/rails.rb +7 -17
  32. data/lib/sidekiq/redis_client_adapter.rb +10 -69
  33. data/lib/sidekiq/redis_connection.rb +12 -111
  34. data/lib/sidekiq/scheduled.rb +21 -22
  35. data/lib/sidekiq/testing.rb +24 -39
  36. data/lib/sidekiq/transaction_aware_client.rb +4 -5
  37. data/lib/sidekiq/version.rb +2 -1
  38. data/lib/sidekiq/web/action.rb +3 -3
  39. data/lib/sidekiq/web/application.rb +76 -11
  40. data/lib/sidekiq/web/csrf_protection.rb +2 -2
  41. data/lib/sidekiq/web/helpers.rb +39 -24
  42. data/lib/sidekiq/web.rb +17 -16
  43. data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
  44. data/lib/sidekiq.rb +76 -274
  45. data/sidekiq.gemspec +12 -10
  46. data/web/assets/javascripts/application.js +18 -0
  47. data/web/assets/javascripts/base-charts.js +106 -0
  48. data/web/assets/javascripts/dashboard-charts.js +168 -0
  49. data/web/assets/javascripts/dashboard.js +3 -223
  50. data/web/assets/javascripts/metrics.js +117 -115
  51. data/web/assets/stylesheets/application-dark.css +4 -0
  52. data/web/assets/stylesheets/application-rtl.css +2 -91
  53. data/web/assets/stylesheets/application.css +23 -298
  54. data/web/locales/ar.yml +70 -70
  55. data/web/locales/cs.yml +62 -62
  56. data/web/locales/da.yml +60 -53
  57. data/web/locales/de.yml +65 -65
  58. data/web/locales/el.yml +2 -7
  59. data/web/locales/en.yml +78 -70
  60. data/web/locales/es.yml +68 -68
  61. data/web/locales/fa.yml +65 -65
  62. data/web/locales/fr.yml +81 -67
  63. data/web/locales/gd.yml +99 -0
  64. data/web/locales/he.yml +65 -64
  65. data/web/locales/hi.yml +59 -59
  66. data/web/locales/it.yml +53 -53
  67. data/web/locales/ja.yml +67 -69
  68. data/web/locales/ko.yml +52 -52
  69. data/web/locales/lt.yml +66 -66
  70. data/web/locales/nb.yml +61 -61
  71. data/web/locales/nl.yml +52 -52
  72. data/web/locales/pl.yml +45 -45
  73. data/web/locales/pt-br.yml +79 -69
  74. data/web/locales/pt.yml +51 -51
  75. data/web/locales/ru.yml +67 -66
  76. data/web/locales/sv.yml +53 -53
  77. data/web/locales/ta.yml +60 -60
  78. data/web/locales/uk.yml +62 -61
  79. data/web/locales/ur.yml +64 -64
  80. data/web/locales/vi.yml +67 -67
  81. data/web/locales/zh-cn.yml +20 -18
  82. data/web/locales/zh-tw.yml +10 -1
  83. data/web/views/_footer.erb +5 -2
  84. data/web/views/_job_info.erb +18 -2
  85. data/web/views/_metrics_period_select.erb +12 -0
  86. data/web/views/_paging.erb +2 -0
  87. data/web/views/_poll_link.erb +1 -1
  88. data/web/views/busy.erb +39 -28
  89. data/web/views/dashboard.erb +36 -5
  90. data/web/views/filtering.erb +7 -0
  91. data/web/views/metrics.erb +33 -20
  92. data/web/views/metrics_for_job.erb +25 -44
  93. data/web/views/morgue.erb +5 -9
  94. data/web/views/queue.erb +10 -14
  95. data/web/views/queues.erb +3 -1
  96. data/web/views/retries.erb +5 -9
  97. data/web/views/scheduled.erb +12 -13
  98. metadata +44 -39
  99. data/lib/sidekiq/delay.rb +0 -43
  100. data/lib/sidekiq/extensions/action_mailer.rb +0 -48
  101. data/lib/sidekiq/extensions/active_record.rb +0 -43
  102. data/lib/sidekiq/extensions/class_methods.rb +0 -43
  103. data/lib/sidekiq/extensions/generic_proxy.rb +0 -33
  104. data/lib/sidekiq/metrics/deploy.rb +0 -47
  105. data/lib/sidekiq/worker.rb +0 -370
  106. data/web/assets/javascripts/graph.js +0 -16
  107. /data/{LICENSE → LICENSE.txt} +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b12bc33857058ca07b776ff3f9e39eb98a84533c8f1c78367626a6a514d53607
4
- data.tar.gz: d783f3060fc348786c7128ffc3b14703d9ee676a1a4972d88bc2e995fbabfd16
3
+ metadata.gz: b50ab03f32263dd24ee37ce2ddadc7a4e5e226860146c1a677262dd3a417329d
4
+ data.tar.gz: 0af1051781796465d5ce5dd0d0e454016fdc04b7cb5fcf0b8d62e447faff11ed
5
5
  SHA512:
6
- metadata.gz: 0471f10240cbf2a1e2337e50111690a32153da3fa23f3e8462ff545dcc9cde06d67574cc26ed1c2be3fed88d31a34002ec30641a6c40a4f668a44005e9d5d297
7
- data.tar.gz: 88f36a02144dbdf6fa58eb5d58f9615d99321049a76717dd2a4bd03a0bc7ebfe69e4709b860afd22782c80e5a868d8c85026d15ce42824675e3f6f09534c6335
6
+ metadata.gz: f2e84e49ceb024e8cb24a7213ffe81e40ed9423d646e39778ed51049bf89a04c28890a21e93eeb38bb9daefe88b94b150d71a0cdf80ecdad712a2167dd0a3421
7
+ data.tar.gz: 39ffc3e4eee3e2c27a3f774f2a2120c50a52ab9e2049b0fc925123c622553bf4fd19512c16e63882031909bba6ea5b2d15cf856256a3c453d080e89253196fc6
data/Changes.md CHANGED
@@ -1,12 +1,154 @@
1
1
  # Sidekiq Changes
2
2
 
3
- [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/main/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/main/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/main/Ent-Changes.md)
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
4
 
5
- 6.5.10
5
+ 7.1.6
6
6
  ----------
7
7
 
8
- - Web UI DoS vector [#6045] CVE-2023-26141
9
- - Fix broadcast logger with Rails 7.1 [#6054]
8
+ - The block forms of testing modes (inline, fake) are now thread-safe so you can have
9
+ a multithreaded test suite which uses different modes for different tests. [#6069]
10
+ - Fix breakage with non-Proc error handlers [#6065]
11
+
12
+ 7.1.5
13
+ ----------
14
+
15
+ - **FEATURE**: Job filtering within the Web UI. This feature has been open
16
+ sourced from Sidekiq Pro. [#6052]
17
+ - **API CHANGE** Error handlers now take three arguments `->(ex, context, config)`.
18
+ The previous calling convention will work until Sidekiq 8.0 but will print
19
+ out a deprecation warning. [#6051]
20
+ - Fix issue with the `batch_size` and `at` options in `S::Client.push_bulk` [#6040]
21
+ - Fix inline testing firing batch callbacks early [#6057]
22
+ - Use new log broadcast API in Rails 7.1 [#6054]
23
+ - Crash if user tries to use RESP2 `protocol: 2` [#6061]
24
+
25
+ 7.1.4
26
+ ----------
27
+
28
+ - Fix empty `retry_for` logic [#6035]
29
+
30
+ 7.1.3
31
+ ----------
32
+
33
+ - Add `sidekiq_options retry_for: 48.hours` to allow time-based retry windows [#6029]
34
+ - Support sidekiq_retry_in and sidekiq_retries_exhausted_block in ActiveJobs (#5994)
35
+ - Lowercase all Rack headers for Rack 3.0 [#5951]
36
+ - Validate Sidekiq::Web page refresh delay to avoid potential DoS,
37
+ CVE-2023-26141, thanks for reporting Keegan!
38
+
39
+ 7.1.2
40
+ ----------
41
+
42
+ - Mark Web UI assets as private so CDNs won't cache them [#5936]
43
+ - Fix stackoverflow when using Oj and the JSON log formatter [#5920]
44
+ - Remove spurious `enqueued_at` from scheduled ActiveJobs [#5937]
45
+
46
+ 7.1.1
47
+ ----------
48
+
49
+ - Support multiple CurrentAttributes [#5904]
50
+ - Speed up latency fetch with large queues on Redis <7 [#5910]
51
+ - Allow a larger default client pool [#5886]
52
+ - Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
53
+
54
+ 7.1.0
55
+ ----------
56
+
57
+ - Improve display of ActiveJob arguments in Web UI [#5825, cover]
58
+ - Update `push_bulk` to push `batch_size` jobs at a time and allow laziness [#5827, fatkodima]
59
+ This allows Sidekiq::Client to push unlimited jobs as long as it has enough memory for the batch_size.
60
+ - Update `perform_bulk` to use `push_bulk` internally.
61
+ - Change return value of `push_bulk` to map 1-to-1 with arguments.
62
+ If you call `push_bulk(args: [[1], [2], [3]])`, you will now always get
63
+ an array of 3 values as the result: `["jid1", nil, "jid3"]` where nil means
64
+ that particular job did not push successfully (possibly due to middleware
65
+ stopping it). Previously nil values were removed so it was impossible to tell
66
+ which jobs pushed successfully and which did not.
67
+ - Migrate away from all deprecated Redis commands [#5788]
68
+ Sidekiq will now print a warning if you use one of those deprecated commands.
69
+ - Prefix all Sidekiq thread names [#5872]
70
+
71
+ 7.0.9
72
+ ----------
73
+
74
+ - Restore confirmation dialogs in Web UI [#5881, shevaun]
75
+ - Increase fetch timeout to minimize ReadTimeoutError [#5874]
76
+ - Reverse histogram tooltip ordering [#5868]
77
+ - Add Scottish Gaelic (gd) locale [#5867, GunChleoc]
78
+
79
+ 7.0.8
80
+ ----------
81
+
82
+ - **SECURITY** Sanitize `period` input parameter on Metrics pages.
83
+ Specially crafted values can lead to XSS. This functionality
84
+ was introduced in 7.0.4. Thank you to spercex @ huntr.dev [#5694]
85
+ - Add job hash as 3rd parameter to the `sidekiq_retry_in` block.
86
+
87
+ 7.0.7
88
+ ----------
89
+
90
+ - Fix redis-client API usage which could result in stuck Redis
91
+ connections [#5823]
92
+ - Fix AS::Duration with `sidekiq_retry_in` [#5806]
93
+ - Restore dumping config options on startup with `-v` [#5822]
94
+
95
+ 7.0.5,7.0.6
96
+ ----------
97
+
98
+ - More context for debugging json unsafe errors [#5787]
99
+
100
+ 7.0.4
101
+ ----------
102
+
103
+ - Performance and memory optimizations [#5768, fatkodima]
104
+ - Add 1-8 hour period selector to Metrics pages [#5694]
105
+ - Fix process display with `sidekiqmon` [#5733]
106
+
107
+ 7.0.3
108
+ ----------
109
+
110
+ - Don't warn about memory policy on Redis Enterprise [#5712]
111
+ - Don't allow Quiet/Stop on embedded Sidekiq instances [#5716]
112
+ - Fix `size: X` for configuring the default Redis pool size [#5702]
113
+ - Improve the display of queue weights on Busy page [#5642]
114
+ - Freeze CurrentAttributes on a job once initially set [#5692]
115
+
116
+ 7.0.2
117
+ ----------
118
+
119
+ - Improve compatibility with custom loggers [#5673]
120
+ - Add queue weights on Busy page [#5640]
121
+ - Add BID link on job_info page if job is part of a Batch [#5623]
122
+ - Allow custom extensions to add rows/links within Job detail pages [#5624]
123
+ ```ruby
124
+ Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
125
+
126
+ class AddAccountLink
127
+ include CGI::Util
128
+ def add_pair(job)
129
+ # yield a (name, value) pair
130
+ # You can include HTML tags and CSS, Sidekiq does not do any
131
+ # escaping so beware user data injection! Note how we use CGI's
132
+ # `h` escape helper.
133
+ aid = job["account_id"]
134
+ yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
135
+ end
136
+ end
137
+ ```
138
+
139
+ 7.0.1
140
+ ----------
141
+
142
+ - Allow an embedding process to reuse its own heartbeat thread
143
+ - Update zh-cn localization
144
+
145
+ 7.0.0
146
+ ----------
147
+
148
+ - Embedded mode!
149
+ - Capsules!!
150
+ - Job Execution metrics!!!
151
+ - See `docs/7.0-Upgrade.md` for release notes
10
152
 
11
153
  6.5.9
12
154
  ----------
@@ -19,8 +161,7 @@
19
161
  - Fail if using a bad version of scout_apm [#5616]
20
162
  - Add pagination to Busy page [#5556]
21
163
  - Speed up WorkSet#each [#5559]
22
- - Adjust CurrentAttributes to work with the String class name so we aren't referencing
23
- the Class within a Rails initializer [#5536]
164
+ - Adjust CurrentAttributes to work with the String class name so we aren't referencing the Class within a Rails initializer [#5536]
24
165
 
25
166
  6.5.7
26
167
  ----------
@@ -54,7 +195,7 @@ the Class within a Rails initializer [#5536]
54
195
  6.5.2
55
196
  ----------
56
197
 
57
- - [Job Metrics are under active development, help wanted!](https://github.com/mperham/sidekiq/wiki/Metrics#contributing) **BETA**
198
+ - [Job Metrics are under active development, help wanted!](https://github.com/sidekiq/sidekiq/wiki/Metrics#contributing) **BETA**
58
199
  - Add `Context` column on queue page which shows any CurrentAttributes [#5450]
59
200
  - `sidekiq_retry_in` may now return `:discard` or `:kill` to dynamically stop job retries [#5406]
60
201
  - Smarter sorting of processes in /busy Web UI [#5398]
@@ -73,7 +214,7 @@ the Class within a Rails initializer [#5536]
73
214
  - Substantial refactoring of Sidekiq server internals, part of a larger effort
74
215
  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).
75
216
  - **Add beta support for the `redis-client` gem**. This will become the default Redis driver in Sidekiq 7.0. [#5298]
76
- Read more: https://github.com/mperham/sidekiq/wiki/Using-redis-client
217
+ Read more: https://github.com/sidekiq/sidekiq/wiki/Using-redis-client
77
218
  - **Add beta support for DB transaction-aware client** [#5291]
78
219
  Add this line to your initializer and any jobs created during a transaction
79
220
  will only be pushed to Redis **after the transaction commits**. You will need to add the
@@ -273,7 +414,7 @@ If this is a Rails app in API mode, you need to enable sessions.
273
414
  ---------
274
415
 
275
416
  - **Integrate with systemd's watchdog and notification features** [#4488]
276
- Set `Type=notify` in [sidekiq.service](https://github.com/mperham/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
417
+ Set `Type=notify` in [sidekiq.service](https://github.com/sidekiq/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
277
418
  - Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
278
419
  - Fix edge case where a job can be pushed without a queue.
279
420
  - Flush job stats at exit [#4498]
@@ -286,7 +427,7 @@ If this is a Rails app in API mode, you need to enable sessions.
286
427
  - Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
287
428
  - Update APIs to use `UNLINK`, not `DEL`. [#4449]
288
429
  - Fix Ruby 2.7 warnings [#4412]
289
- - Add support for `APP_ENV` [[95fa5d9]](https://github.com/mperham/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
430
+ - Add support for `APP_ENV` [[95fa5d9]](https://github.com/sidekiq/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
290
431
 
291
432
  6.0.4
292
433
  ---------
@@ -398,7 +539,7 @@ Sidekiq.configure_server do |config|
398
539
  config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
399
540
  end
400
541
  ```
401
- See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for more details.
542
+ See the [Logging wiki page](https://github.com/sidekiq/sidekiq/wiki/Logging) for more details.
402
543
  - **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
403
544
  variable. This variable is meant to hold the name of the environment
404
545
  variable which contains your Redis URL, so that you can switch Redis
@@ -590,7 +731,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
590
731
  - The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
591
732
  - Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
592
733
  of random hex bytes.
593
- - Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
734
+ - Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail.
594
735
 
595
736
  4.2.10
596
737
  -----------
@@ -808,7 +949,7 @@ Sidekiq::Queues.clear_all
808
949
  - Sidekiq's internals have been completely overhauled for performance
809
950
  and to remove dependencies. This has resulted in major speedups, as
810
951
  [detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
811
- - See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
952
+ - See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail.
812
953
 
813
954
  3.5.4
814
955
  -----------
@@ -845,7 +986,7 @@ Sidekiq::Queues.clear_all
845
986
  - **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
846
987
  - Add Ukrainian locale [#2561, elrakita]
847
988
  - Disconnect and retry Redis operations if we see a READONLY error [#2550]
848
- - Add server middleware testing harness; see [wiki](https://github.com/mperham/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
989
+ - Add server middleware testing harness; see [wiki](https://github.com/sidekiq/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
849
990
 
850
991
  3.5.0
851
992
  -----------
@@ -863,7 +1004,7 @@ Sidekiq::Queues.clear_all
863
1004
  - Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
864
1005
  reporting. [#2422] If you are running the Web UI as a standalone Rack app,
865
1006
  ensure you have a [session middleware
866
- configured](https://github.com/mperham/sidekiq/wiki/Monitoring#standalone):
1007
+ configured](https://github.com/sidekiq/sidekiq/wiki/Monitoring#standalone):
867
1008
  ```ruby
868
1009
  use Rack::Session::Cookie, :secret => "some unique secret string here"
869
1010
  ```
@@ -1075,7 +1216,7 @@ sidekiq_options :dead => false, :retry => 5
1075
1216
  3.0.0
1076
1217
  -----------
1077
1218
 
1078
- Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
1219
+ Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes.
1079
1220
 
1080
1221
  - **Dead Job Queue** - jobs which run out of retries are now moved to a dead
1081
1222
  job queue. These jobs must be retried manually or they will expire
@@ -1119,7 +1260,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
1119
1260
  end
1120
1261
  ```
1121
1262
  **Sharding support does require a breaking change to client-side
1122
- middleware, see 3.0-Upgrade.md.**
1263
+ middleware, see docs/3.0-Upgrade.md.**
1123
1264
  - New Chinese, Greek, Swedish and Czech translations for the Web UI.
1124
1265
  - Updated most languages translations for the new UI features.
1125
1266
  - **Remove official Capistrano integration** - this integration has been
@@ -1247,7 +1388,7 @@ middleware, see 3.0-Upgrade.md.**
1247
1388
  appear to be doing any work. [#1194]
1248
1389
  - Sidekiq's testing behavior is now dynamic. You can choose between
1249
1390
  `inline` and `fake` behavior in your tests. See
1250
- [Testing](https://github.com/mperham/sidekiq/wiki/Testing) for detail. [#1193]
1391
+ [Testing](https://github.com/sidekiq/sidekiq/wiki/Testing) for detail. [#1193]
1251
1392
  - The Retries table has a new column for the error message.
1252
1393
  - The Web UI topbar now contains the status and live poll button.
1253
1394
  - Orphaned worker records are now auto-vacuumed when you visit the
data/README.md CHANGED
@@ -2,7 +2,7 @@ Sidekiq
2
2
  ==============
3
3
 
4
4
  [![Gem Version](https://badge.fury.io/rb/sidekiq.svg)](https://rubygems.org/gems/sidekiq)
5
- ![Build](https://github.com/mperham/sidekiq/workflows/CI/badge.svg)
5
+ ![Build](https://github.com/sidekiq/sidekiq/workflows/CI/badge.svg)
6
6
 
7
7
  Simple, efficient background processing for Ruby.
8
8
 
@@ -10,27 +10,14 @@ Sidekiq uses threads to handle many jobs at the same time in the
10
10
  same process. It does not require Rails but will integrate tightly with
11
11
  Rails to make background processing dead simple.
12
12
 
13
- Performance
14
- ---------------
15
-
16
- Version | Latency | Garbage created for 10k jobs | Time to process 100k jobs | Throughput | Ruby
17
- -----------------|------|---------|---------|------------------------|-----
18
- Sidekiq 6.0.2 | 3 ms | 156 MB | 14.0 sec| **7100 jobs/sec** | MRI 2.6.3
19
- Sidekiq 6.0.0 | 3 ms | 156 MB | 19 sec | 5200 jobs/sec | MRI 2.6.3
20
- Sidekiq 4.0.0 | 10 ms | 151 MB | 22 sec | 4500 jobs/sec |
21
- Sidekiq 3.5.1 | 22 ms | 1257 MB | 125 sec | 800 jobs/sec |
22
- Resque 1.25.2 | - | - | 420 sec | 240 jobs/sec |
23
- DelayedJob 4.1.1 | - | - | 465 sec | 215 jobs/sec |
24
-
25
- This benchmark can be found in `bin/sidekiqload` and assumes a Redis network latency of 1ms.
26
13
 
27
14
  Requirements
28
15
  -----------------
29
16
 
30
- - Redis: 4.0+
31
- - Ruby: MRI 2.5+ or JRuby 9.2+.
17
+ - Redis: 6.2+
18
+ - Ruby: MRI 2.7+ or JRuby 9.3+.
32
19
 
33
- Sidekiq 6.0 supports Rails 5.0+ but does not require it.
20
+ Sidekiq 7.0 supports Rails 6.0+ but does not require it.
34
21
 
35
22
 
36
23
  Installation
@@ -42,57 +29,78 @@ Installation
42
29
  Getting Started
43
30
  -----------------
44
31
 
45
- See the [Getting Started wiki page](https://github.com/mperham/sidekiq/wiki/Getting-Started) and follow the simple setup process.
32
+ See the [Getting Started wiki page](https://github.com/sidekiq/sidekiq/wiki/Getting-Started) and follow the simple setup process.
46
33
  You can watch [this YouTube playlist](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1) to learn all about
47
34
  Sidekiq and see its features in action. Here's the Web UI:
48
35
 
49
- ![Web UI](https://github.com/mperham/sidekiq/raw/main/examples/web-ui.png)
36
+ ![Web UI](https://github.com/sidekiq/sidekiq/raw/main/examples/web-ui.png)
37
+
38
+ Performance
39
+ ---------------
50
40
 
41
+ The benchmark in `bin/sidekiqload` creates 500,000 no-op jobs and drains them as fast as possible, assuming a fixed Redis network latency of 1ms.
42
+ This requires a lot of Redis network I/O and JSON parsing.
43
+ This benchmark is IO-bound so we increase the concurrency to 25.
44
+ If your application is sending lots of emails or performing other network-intensive work, you could see a similar benefit but be careful not to saturate the CPU.
45
+
46
+ Version | Time to process 500k jobs | Throughput (jobs/sec) | Ruby | Concurrency | Job Type
47
+ -----------------|------|---------|---------|------------------------|---
48
+ Sidekiq 7.0.3 | 21.3 sec| 23,500 | 3.2.0+yjit | 30 | Sidekiq::Job
49
+ Sidekiq 7.0.3 | 33.8 sec| 14,700 | 3.2.0+yjit | 30 | ActiveJob 7.0.4
50
+ Sidekiq 7.0.3 | 23.5 sec| 21,300 | 3.2.0 | 30 | Sidekiq::Job
51
+ Sidekiq 7.0.3 | 46.5 sec| 10,700 | 3.2.0 | 30 | ActiveJob 7.0.4
52
+ Sidekiq 7.0.3 | 23.0 sec| 21,700 | 2.7.5 | 30 | Sidekiq::Job
53
+ Sidekiq 7.0.3 | 46.5 sec| 10,850 | 2.7.5 | 30 | ActiveJob 7.0.4
54
+
55
+ Most of Sidekiq's overhead is Redis network I/O.
56
+ ActiveJob adds a notable amount of CPU overhead due to argument deserialization and callbacks.
57
+ Concurrency of 30 was determined experimentally to maximize one CPU without saturating it.
51
58
 
52
59
  Want to Upgrade?
53
60
  -------------------
54
61
 
62
+ Use `bundle up sidekiq` to upgrade Sidekiq and all its dependencies.
63
+ Upgrade notes between each major version can be found in the `docs/` directory.
64
+
55
65
  I also sell Sidekiq Pro and Sidekiq Enterprise, extensions to Sidekiq which provide more
56
66
  features, a commercial-friendly license and allow you to support high
57
67
  quality open source development all at the same time. Please see the
58
68
  [Sidekiq](https://sidekiq.org/) homepage for more detail.
59
69
 
60
- Subscribe to the **[quarterly newsletter](https://tinyletter.com/sidekiq)** to stay informed about the latest
61
- features and changes to Sidekiq and its bigger siblings.
62
-
63
70
 
64
71
  Problems?
65
72
  -----------------
66
73
 
67
- **Please do not directly email any Sidekiq committers with questions or problems.** A community is best served when discussions are held in public.
74
+ **Please do not directly email any Sidekiq committers with questions or problems.**
75
+ A community is best served when discussions are held in public.
68
76
 
69
- If you have a problem, please review the [FAQ](https://github.com/mperham/sidekiq/wiki/FAQ) and [Troubleshooting](https://github.com/mperham/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages.
70
- Searching the [issues](https://github.com/mperham/sidekiq/issues) for your problem is also a good idea.
77
+ If you have a problem, please review the [FAQ](https://github.com/sidekiq/sidekiq/wiki/FAQ) and [Troubleshooting](https://github.com/sidekiq/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages.
78
+ Searching the [issues](https://github.com/sidekiq/sidekiq/issues) for your problem is also a good idea.
71
79
 
72
- Sidekiq Pro and Sidekiq Enterprise customers get private email support. You can purchase at https://sidekiq.org; email support@contribsys.com for help.
80
+ Sidekiq Pro and Sidekiq Enterprise customers get private email support.
81
+ You can purchase at https://sidekiq.org; email support@contribsys.com for help.
73
82
 
74
83
  Useful resources:
75
84
 
76
- * Product documentation is in the [wiki](https://github.com/mperham/sidekiq/wiki).
77
- * Occasional announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
85
+ * Product documentation is in the [wiki](https://github.com/sidekiq/sidekiq/wiki).
86
+ * Occasional announcements are made to the [@sidekiq](https://ruby.social/@sidekiq) Mastodon account.
78
87
  * The [Sidekiq tag](https://stackoverflow.com/questions/tagged/sidekiq) on Stack Overflow has lots of useful Q &amp; A.
79
88
 
80
- Every Friday morning is Sidekiq happy hour: I video chat and answer questions.
89
+ Every Friday morning is Sidekiq office hour: I video chat and answer questions.
81
90
  See the [Sidekiq support page](https://sidekiq.org/support.html) for details.
82
91
 
83
92
  Contributing
84
93
  -----------------
85
94
 
86
- Please see [the contributing guidelines](https://github.com/mperham/sidekiq/blob/main/.github/contributing.md).
87
-
95
+ Please see [the contributing guidelines](https://github.com/sidekiq/sidekiq/blob/main/.github/contributing.md).
88
96
 
89
97
  License
90
98
  -----------------
91
99
 
92
- Please see [LICENSE](https://github.com/mperham/sidekiq/blob/main/LICENSE) for licensing details.
93
-
100
+ Please see [LICENSE.txt](https://github.com/sidekiq/sidekiq/blob/main/LICENSE.txt) for licensing details.
101
+ The license for Sidekiq Pro and Sidekiq Enterprise can be found in [COMM-LICENSE.txt](https://github.com/sidekiq/sidekiq/blob/main/COMM-LICENSE.txt).
94
102
 
95
103
  Author
96
104
  -----------------
97
105
 
98
- Mike Perham, [@getajobmike](https://twitter.com/getajobmike) / [@sidekiq](https://twitter.com/sidekiq), [https://www.mikeperham.com](https://www.mikeperham.com) / [https://www.contribsys.com](https://www.contribsys.com)
106
+ Mike Perham, [@getajobmike](https://ruby.social/@getajobmike) / [@sidekiq](https://ruby.social/@sidekiq), [https://www.mikeperham.com](https://www.mikeperham.com) / [https://www.contribsys.com](https://www.contribsys.com)
data/bin/sidekiq CHANGED
@@ -10,7 +10,7 @@ def integrate_with_systemd
10
10
  return unless ENV["NOTIFY_SOCKET"]
11
11
 
12
12
  Sidekiq.configure_server do |config|
13
- Sidekiq.logger.info "Enabling systemd notification integration"
13
+ config.logger.info "Enabling systemd notification integration"
14
14
  require "sidekiq/sd_notify"
15
15
  config.on(:startup) do
16
16
  Sidekiq::SdNotify.ready
@@ -31,12 +31,7 @@ begin
31
31
  cli.run
32
32
  rescue => e
33
33
  raise e if $DEBUG
34
- if Sidekiq.error_handlers.length == 0
35
- warn e.message
36
- warn e.backtrace.join("\n")
37
- else
38
- cli.handle_exception e
39
- end
40
-
34
+ warn e.message
35
+ warn e.backtrace.join("\n")
41
36
  exit 1
42
37
  end