sidekiq 6.5.12 → 7.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55c6f9a8c0f2810bcbe7744c95204893d73f534666f6091c74dcb5199e7a4a28
-  data.tar.gz: c42690ef0d1876c94eb51fb68319275d11f10169826180db921b34d6334a1a54
+  metadata.gz: fce9a2bde54477663fcf80408ba57e3653b7cabad880d442a931f92725c1ee3c
+  data.tar.gz: 5f3d322fa77edd6dc83e00f5f3c5c1d2e275830065e4637b778e726f2a08c608
 SHA512:
-  metadata.gz: 461b559e18cbdf8fe6ba20ab9fa38d08fd3b7b8d14dce7a7f9369d678e92bd25c07734bc14b0167f83589c0f03501897195b3fdf9cfd5de5a60f039bf7436f98
-  data.tar.gz: ce0490b438a22a71c37e5a65193a7728e3297b437730d30a3653807ff1e89476db1f8c62d8de50c0c8cebbbce2ba6fb65f110855e071c62746fe8697a0f636e1
+  metadata.gz: 801864880ce896e750649e489d9b0f23e04a0c55ca1f3b3d13282dc71aa495cb7937027843321e10a02027d9316c7bb4f6399b1a58c4a1f66a1a4ca85440d66e
+  data.tar.gz: dcab086da52aca3518371632fc92dd469d22266f4b0728ec44ae5c42fbdbfe49485ed0c9244d8d0252b7203ef618304832cf8fb0d1bd95d0368f78bbbd10b7ca

data/Changes.md

@@ -1,22 +1,64 @@
 # Sidekiq Changes
 
-[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)
+[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)
 
-6.5.11
+7.0.5
 ----------
 
-- Fix for Rails 7.1 [#6067]
+- More context for debugging json unsafe errors [#5787]
 
-6.5.10
+7.0.4
 ----------
 
-- Web UI DoS vector [#6045] CVE-2023-26141
-- Fix broadcast logger with Rails 7.1 [#6054]
+- Performance and memory optimizations [#5768, fatkodima]
+- Add 1-8 hour period selector to Metrics pages [#5694]
+- Fix process display with `sidekiqmon` [#5733]
 
-6.5.9
+7.0.3
 ----------
 
-- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
+- Don't warn about memory policy on Redis Enterprise [#5712]
+- Don't allow Quiet/Stop on embedded Sidekiq instances [#5716]
+- Fix `size: X` for configuring the default Redis pool size [#5702]
+- Improve the display of queue weights on Busy page [#5642]
+- Freeze CurrentAttributes on a job once initially set [#5692]
+
+7.0.2
+----------
+
+- Improve compatibility with custom loggers [#5673]
+- Add queue weights on Busy page [#5640]
+- Add BID link on job_info page if job is part of a Batch [#5623]
+- Allow custom extensions to add rows/links within Job detail pages [#5624]
+```ruby
+Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
+
+class AddAccountLink
+  include CGI::Util
+  def add_pair(job)
+    # yield a (name, value) pair
+    # You can include HTML tags and CSS, Sidekiq does not do any
+    # escaping so beware user data injection! Note how we use CGI's
+    # `h` escape helper.
+    aid = job["account_id"]
+    yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
+  end
+end
+```
+
+7.0.1
+----------
+
+- Allow an embedding process to reuse its own heartbeat thread
+- Update zh-cn localization
+
+7.0.0
+----------
+
+- Embedded mode!
+- Capsules!!
+- Job Execution metrics!!!
+- See `docs/7.0-Upgrade.md` for release notes
 
 6.5.8
 ----------
@@ -24,8 +66,7 @@
 - Fail if using a bad version of scout_apm [#5616]
 - Add pagination to Busy page [#5556]
 - Speed up WorkSet#each [#5559]
-- Adjust CurrentAttributes to work with the String class name so we aren't referencing
-the Class within a Rails initializer [#5536]
+- Adjust CurrentAttributes to work with the String class name so we aren't referencing the Class within a Rails initializer [#5536]
 
 6.5.7
 ----------
@@ -59,7 +100,7 @@ the Class within a Rails initializer [#5536]
 6.5.2
 ----------
 
-- [Job Metrics are under active development, help wanted!](https://github.com/mperham/sidekiq/wiki/Metrics#contributing) **BETA**
+- [Job Metrics are under active development, help wanted!](https://github.com/sidekiq/sidekiq/wiki/Metrics#contributing) **BETA**
 - Add `Context` column on queue page which shows any CurrentAttributes [#5450]
 - `sidekiq_retry_in` may now return `:discard` or `:kill` to dynamically stop job retries [#5406]
 - Smarter sorting of processes in /busy Web UI [#5398]
@@ -78,7 +119,7 @@ the Class within a Rails initializer [#5536]
 - Substantial refactoring of Sidekiq server internals, part of a larger effort
   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).
 - **Add beta support for the `redis-client` gem**. This will become the default Redis driver in Sidekiq 7.0. [#5298]
-  Read more: https://github.com/mperham/sidekiq/wiki/Using-redis-client
+  Read more: https://github.com/sidekiq/sidekiq/wiki/Using-redis-client
 - **Add beta support for DB transaction-aware client** [#5291]
   Add this line to your initializer and any jobs created during a transaction
   will only be pushed to Redis **after the transaction commits**. You will need to add the
@@ -278,7 +319,7 @@ If this is a Rails app in API mode, you need to enable sessions.
 ---------
 
 - **Integrate with systemd's watchdog and notification features** [#4488]
-  Set `Type=notify` in [sidekiq.service](https://github.com/mperham/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
+  Set `Type=notify` in [sidekiq.service](https://github.com/sidekiq/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
 - Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
 - Fix edge case where a job can be pushed without a queue.
 - Flush job stats at exit [#4498]
@@ -291,7 +332,7 @@ If this is a Rails app in API mode, you need to enable sessions.
 - Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
 - Update APIs to use `UNLINK`, not `DEL`. [#4449]
 - Fix Ruby 2.7 warnings [#4412]
-- Add support for `APP_ENV` [[95fa5d9]](https://github.com/mperham/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
+- Add support for `APP_ENV` [[95fa5d9]](https://github.com/sidekiq/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
 
 6.0.4
 ---------
@@ -403,7 +444,7 @@ Sidekiq.configure_server do |config|
   config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
 end
 ```
-See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for more details.
+See the [Logging wiki page](https://github.com/sidekiq/sidekiq/wiki/Logging) for more details.
 - **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
   variable.  This variable is meant to hold the name of the environment
   variable which contains your Redis URL, so that you can switch Redis
@@ -595,7 +636,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
 - The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
 - Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
   of random hex bytes.
-- Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
+- Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail.
 
 4.2.10
 -----------
@@ -813,7 +854,7 @@ Sidekiq::Queues.clear_all
 - Sidekiq's internals have been completely overhauled for performance
   and to remove dependencies.  This has resulted in major speedups, as
   [detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
-- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
+- See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail.
 
 3.5.4
 -----------
@@ -850,7 +891,7 @@ Sidekiq::Queues.clear_all
 - **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
 - Add Ukrainian locale [#2561, elrakita]
 - Disconnect and retry Redis operations if we see a READONLY error [#2550]
-- Add server middleware testing harness; see [wiki](https://github.com/mperham/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
+- Add server middleware testing harness; see [wiki](https://github.com/sidekiq/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
 
 3.5.0
 -----------
@@ -868,7 +909,7 @@ Sidekiq::Queues.clear_all
 - Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
   reporting. [#2422] If you are running the Web UI as a standalone Rack app,
   ensure you have a [session middleware
-configured](https://github.com/mperham/sidekiq/wiki/Monitoring#standalone):
+configured](https://github.com/sidekiq/sidekiq/wiki/Monitoring#standalone):
 ```ruby
 use Rack::Session::Cookie, :secret => "some unique secret string here"
 ```
@@ -1080,7 +1121,7 @@ sidekiq_options :dead => false, :retry => 5
 3.0.0
 -----------
 
-Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
+Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes.
 
 - **Dead Job Queue** - jobs which run out of retries are now moved to a dead
   job queue.  These jobs must be retried manually or they will expire
@@ -1124,7 +1165,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
 end
 ```
   **Sharding support does require a breaking change to client-side
-middleware, see 3.0-Upgrade.md.**
+middleware, see docs/3.0-Upgrade.md.**
 - New Chinese, Greek, Swedish and Czech translations for the Web UI.
 - Updated most languages translations for the new UI features.
 - **Remove official Capistrano integration** - this integration has been
@@ -1252,7 +1293,7 @@ middleware, see 3.0-Upgrade.md.**
   appear to be doing any work. [#1194]
 - Sidekiq's testing behavior is now dynamic.  You can choose between
   `inline` and `fake` behavior in your tests. See
-[Testing](https://github.com/mperham/sidekiq/wiki/Testing) for detail. [#1193]
+[Testing](https://github.com/sidekiq/sidekiq/wiki/Testing) for detail. [#1193]
 - The Retries table has a new column for the error message.
 - The Web UI topbar now contains the status and live poll button.
 - Orphaned worker records are now auto-vacuumed when you visit the

data/README.md

@@ -2,7 +2,7 @@ Sidekiq
 ==============
 
 [![Gem Version](https://badge.fury.io/rb/sidekiq.svg)](https://rubygems.org/gems/sidekiq)
-![Build](https://github.com/mperham/sidekiq/workflows/CI/badge.svg)
+![Build](https://github.com/sidekiq/sidekiq/workflows/CI/badge.svg)
 
 Simple, efficient background processing for Ruby.
 
@@ -10,27 +10,14 @@ Sidekiq uses threads to handle many jobs at the same time in the
 same process.  It does not require Rails but will integrate tightly with
 Rails to make background processing dead simple.
 
-Performance
----------------
-
-Version |	Latency | Garbage created for 10k jobs	| Time to process 100k jobs |	Throughput | Ruby
------------------|------|---------|---------|------------------------|-----
-Sidekiq 6.0.2    | 3 ms	| 156 MB  | 14.0 sec| **7100 jobs/sec** | MRI 2.6.3
-Sidekiq 6.0.0    | 3 ms	| 156 MB  | 19 sec  | 5200 jobs/sec | MRI 2.6.3
-Sidekiq 4.0.0    | 10 ms	| 151 MB  | 22 sec  | 4500 jobs/sec |
-Sidekiq 3.5.1    | 22 ms	| 1257 MB | 125 sec | 800 jobs/sec |
-Resque 1.25.2    |  -	  | -       | 420 sec | 240 jobs/sec |
-DelayedJob 4.1.1 |  -   | -       | 465 sec | 215 jobs/sec |
-
-This benchmark can be found in `bin/sidekiqload` and assumes a Redis network latency of 1ms.
 
 Requirements
 -----------------
 
-- Redis: 4.0+
-- Ruby: MRI 2.5+ or JRuby 9.2+.
+- Redis: 6.2+
+- Ruby: MRI 2.7+ or JRuby 9.3+.
 
-Sidekiq 6.0 supports Rails 5.0+ but does not require it.
+Sidekiq 7.0 supports Rails 6.0+ but does not require it.
 
 
 Installation
@@ -42,55 +29,76 @@ Installation
 Getting Started
 -----------------
 
-See the [Getting Started wiki page](https://github.com/mperham/sidekiq/wiki/Getting-Started) and follow the simple setup process.
+See the [Getting Started wiki page](https://github.com/sidekiq/sidekiq/wiki/Getting-Started) and follow the simple setup process.
 You can watch [this YouTube playlist](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1) to learn all about
 Sidekiq and see its features in action.  Here's the Web UI:
 
-![Web UI](https://github.com/mperham/sidekiq/raw/main/examples/web-ui.png)
+![Web UI](https://github.com/sidekiq/sidekiq/raw/main/examples/web-ui.png)
+
+Performance
+---------------
 
+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.
+This requires a lot of Redis network I/O and JSON parsing.
+This benchmark is IO-bound so we increase the concurrency to 25.
+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.
+
+Version | Time to process 500k jobs | Throughput (jobs/sec) | Ruby | Concurrency | Job Type
+-----------------|------|---------|---------|------------------------|---
+Sidekiq 7.0.3 | 21.3 sec| 23,500 | 3.2.0+yjit | 30 | Sidekiq::Job
+Sidekiq 7.0.3 | 33.8 sec| 14,700 | 3.2.0+yjit | 30 | ActiveJob 7.0.4
+Sidekiq 7.0.3 | 23.5 sec| 21,300 | 3.2.0 | 30 | Sidekiq::Job
+Sidekiq 7.0.3 | 46.5 sec| 10,700 | 3.2.0 | 30 | ActiveJob 7.0.4
+Sidekiq 7.0.3 | 23.0 sec| 21,700 | 2.7.5 | 30 | Sidekiq::Job
+Sidekiq 7.0.3 | 46.5 sec| 10,850 | 2.7.5 | 30 | ActiveJob 7.0.4
+
+Most of Sidekiq's overhead is Redis network I/O.
+ActiveJob adds a notable amount of CPU overhead due to argument deserialization and callbacks.
+Concurrency of 30 was determined experimentally to maximize one CPU without saturating it.
 
 Want to Upgrade?
 -------------------
 
+Use `bundle up sidekiq` to upgrade Sidekiq and all its dependencies.
+Upgrade notes between each major version can be found in the `docs/` directory.
+
 I also sell Sidekiq Pro and Sidekiq Enterprise, extensions to Sidekiq which provide more
 features, a commercial-friendly license and allow you to support high
 quality open source development all at the same time.  Please see the
 [Sidekiq](https://sidekiq.org/) homepage for more detail.
 
-Subscribe to the **[quarterly newsletter](https://tinyletter.com/sidekiq)** to stay informed about the latest
-features and changes to Sidekiq and its bigger siblings.
-
 
 Problems?
 -----------------
 
-**Please do not directly email any Sidekiq committers with questions or problems.**  A community is best served when discussions are held in public.
+**Please do not directly email any Sidekiq committers with questions or problems.**
+A community is best served when discussions are held in public.
 
-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.
-Searching the [issues](https://github.com/mperham/sidekiq/issues) for your problem is also a good idea.
+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.
+Searching the [issues](https://github.com/sidekiq/sidekiq/issues) for your problem is also a good idea.
 
-Sidekiq Pro and Sidekiq Enterprise customers get private email support.  You can purchase at https://sidekiq.org; email support@contribsys.com for help.
+Sidekiq Pro and Sidekiq Enterprise customers get private email support.
+You can purchase at https://sidekiq.org; email support@contribsys.com for help.
 
 Useful resources:
 
-* Product documentation is in the [wiki](https://github.com/mperham/sidekiq/wiki).
+* Product documentation is in the [wiki](https://github.com/sidekiq/sidekiq/wiki).
 * Occasional announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
 * The [Sidekiq tag](https://stackoverflow.com/questions/tagged/sidekiq) on Stack Overflow has lots of useful Q & A.
 
-Every Friday morning is Sidekiq happy hour: I video chat and answer questions.
+Every Friday morning is Sidekiq office hour: I video chat and answer questions.
 See the [Sidekiq support page](https://sidekiq.org/support.html) for details.
 
 Contributing
 -----------------
 
-Please see [the contributing guidelines](https://github.com/mperham/sidekiq/blob/main/.github/contributing.md).
-
+Please see [the contributing guidelines](https://github.com/sidekiq/sidekiq/blob/main/.github/contributing.md).
 
 License
 -----------------
 
-Please see [LICENSE](https://github.com/mperham/sidekiq/blob/main/LICENSE) for licensing details.
-
+Please see [LICENSE.txt](https://github.com/sidekiq/sidekiq/blob/main/LICENSE.txt) for licensing details.
+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).
 
 Author
 -----------------

data/bin/sidekiq

@@ -10,7 +10,7 @@ def integrate_with_systemd
   return unless ENV["NOTIFY_SOCKET"]
 
   Sidekiq.configure_server do |config|
-    Sidekiq.logger.info "Enabling systemd notification integration"
+    config.logger.info "Enabling systemd notification integration"
     require "sidekiq/sd_notify"
     config.on(:startup) do
       Sidekiq::SdNotify.ready
@@ -31,12 +31,7 @@ begin
   cli.run
 rescue => e
   raise e if $DEBUG
-  if Sidekiq.error_handlers.length == 0
-    warn e.message
-    warn e.backtrace.join("\n")
-  else
-    cli.handle_exception e
-  end
-
+  warn e.message
+  warn e.backtrace.join("\n")
   exit 1
 end