0ddc6c9858
* Introduce the ability to pause queue from the UI Considering sidekiq web UI allow to perform complex tasks with ease. Having the ability to pause a queue during an emergency (or operational intense) scenarios would come in quite handy. This PR introduces a new button to under the "Actions" column on `sidekiq/queues` pages, right next to the `Delete` button. Depending on the state of the queue, it will according show the `Pause` or `Unpause` text, with appropriate form element that `POST`s to the same endpoint. The endpoint logic is updated to handle the new cases. Added some relevant unit tests. Adding mock `Sidekiq::Queue#pause!` and `Sidekiq::Queue#unpause!` functions to the API, which I believe will be overridden by sidekiq pro. * Remove confirmation text and switch ordering of new copy in en.yml * Only allow pause/unpause operations from sidekiq pro This means the button from UI is hidden and api route has validation in place such that it will only perform the respective pause/unpause operation on proper payload, in sidekiq pro. Its using `Sidekiq::Pro` constant as a check to detect whether or not pro is present. * Initialize Queue only once in api router action |
||
|---|---|---|
| .circleci | ||
| .github | ||
| bin | ||
| examples | ||
| lib | ||
| myapp | ||
| test | ||
| web | ||
| .gitignore | ||
| .standard.yml | ||
| 3.0-Upgrade.md | ||
| 4.0-Upgrade.md | ||
| 5.0-Upgrade.md | ||
| 6.0-Upgrade.md | ||
| Changes.md | ||
| code_of_conduct.md | ||
| COMM-LICENSE | ||
| Ent-2.0-Upgrade.md | ||
| Ent-Changes.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| Pro-2.0-Upgrade.md | ||
| Pro-3.0-Upgrade.md | ||
| Pro-4.0-Upgrade.md | ||
| Pro-5.0-Upgrade.md | ||
| Pro-Changes.md | ||
| Rakefile | ||
| README.md | ||
| sidekiq.gemspec | ||
Sidekiq
Simple, efficient background processing for Ruby.
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+.
Sidekiq 6.0 supports Rails 5.0+ but does not require it.
Installation
gem install sidekiq
Getting Started
See the Getting Started wiki page and follow the simple setup process. You can watch this Youtube playlist to learn all about Sidekiq and see its features in action. Here's the Web UI:
Want to Upgrade?
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 homepage for more detail.
Subscribe to the quarterly newsletter 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.
If you have a problem, please review the FAQ and Troubleshooting wiki pages. Searching the 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.
Useful resources:
- Product documentation is in the wiki.
- Occasional announcements are made to the @sidekiq Twitter account.
- The Sidekiq tag on Stack Overflow has lots of useful Q & A.
Every Friday morning is Sidekiq happy hour: I video chat and answer questions. See the Sidekiq support page for details.
License
Please see LICENSE for licensing details.
Author
Mike Perham, @mperham@mastodon.xyz / @sidekiq, https://www.mikeperham.com / https://www.contribsys.com