2012-08-07 20:01:34 +00:00
Sidekiq
2012-01-22 00:42:21 +00:00
==============
2012-01-16 23:17:42 +00:00
2015-02-19 00:32:12 +00:00
[](https://rubygems.org/gems/sidekiq)
2020-08-28 20:32:13 +00:00
2012-08-07 20:01:34 +00:00
2013-06-26 04:55:51 +00:00
Simple, efficient background processing for Ruby.
2012-01-22 00:42:21 +00:00
2013-06-26 04:55:51 +00:00
Sidekiq uses threads to handle many jobs at the same time in the
2012-08-31 04:02:49 +00:00
same process. It does not require Rails but will integrate tightly with
2016-02-23 04:34:16 +00:00
Rails to make background processing dead simple.
2012-04-06 02:20:24 +00:00
2016-04-26 17:25:16 +00:00
Performance
---------------
2015-11-21 00:03:35 +00:00
2019-08-28 18:52:37 +00:00
Version | Latency | Garbage created for 10k jobs | Time to process 100k jobs | Throughput | Ruby
2019-08-28 18:50:52 +00:00
-----------------|------|---------|---------|------------------------|-----
2019-10-12 18:10:15 +00:00
Sidekiq 6.0.2 | 3 ms | 156 MB | 14.0 sec| **7100 jobs/sec** | MRI 2.6.3
2019-10-12 18:13:53 +00:00
Sidekiq 6.0.0 | 3 ms | 156 MB | 19 sec | 5200 jobs/sec | MRI 2.6.3
2019-08-28 18:52:37 +00:00
Sidekiq 4.0.0 | 10 ms | 151 MB | 22 sec | 4500 jobs/sec |
2019-08-28 18:50:01 +00:00
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 |
2012-01-22 00:42:21 +00:00
2019-08-28 18:52:37 +00:00
This benchmark can be found in `bin/sidekiqload` and assumes a Redis network latency of 1ms.
2019-08-28 18:50:01 +00:00
2012-01-22 00:42:21 +00:00
Requirements
-----------------
2022-09-02 17:17:50 +00:00
- Redis: 6.2+
2022-02-14 23:19:01 +00:00
- Ruby: MRI 2.7+ or JRuby 9.3+.
2012-01-22 00:42:21 +00:00
2022-02-14 23:19:01 +00:00
Sidekiq 7.0 supports Rails 6.0+ but does not require it.
2012-07-26 01:41:05 +00:00
2012-01-22 00:42:21 +00:00
Installation
-----------------
2022-03-21 15:34:43 +00:00
bundle add sidekiq
2012-01-22 00:42:21 +00:00
2012-01-26 05:12:18 +00:00
Getting Started
2012-01-22 00:42:21 +00:00
-----------------
2015-08-25 16:04:09 +00:00
See the [Getting Started wiki page ](https://github.com/mperham/sidekiq/wiki/Getting-Started ) and follow the simple setup process.
2021-12-23 14:38:35 +00:00
You can watch [this YouTube playlist ](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1 ) to learn all about
2016-11-11 15:04:56 +00:00
Sidekiq and see its features in action. Here's the Web UI:
2013-03-16 22:31:06 +00:00
2021-10-12 14:45:53 +00:00
2013-03-16 22:31:06 +00:00
2012-01-22 00:42:21 +00:00
2013-04-09 22:25:15 +00:00
Want to Upgrade?
2013-04-08 15:33:37 +00:00
-------------------
2022-09-02 17:17:50 +00:00
Use `bundle up sidekiq` to upgrade Sidekiq and all its dependencies.
2022-02-14 23:27:16 +00:00
Upgrade notes between each major version can be found in the `docs/` directory.
2015-08-17 22:31:11 +00:00
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
2013-04-08 15:33:37 +00:00
quality open source development all at the same time. Please see the
2019-07-11 18:11:35 +00:00
[Sidekiq ](https://sidekiq.org/ ) homepage for more detail.
2013-04-08 15:33:37 +00:00
2012-01-22 00:42:21 +00:00
2016-01-20 21:50:54 +00:00
Problems?
2012-01-25 02:07:18 +00:00
-----------------
2022-09-02 17:17:50 +00:00
**Please do not directly email any Sidekiq committers with questions or problems.**
A community is best served when discussions are held in public.
2016-01-20 21:50:54 +00:00
2016-02-05 21:30:34 +00:00
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.
2016-01-20 22:00:49 +00:00
2022-09-02 17:17:50 +00:00
Sidekiq Pro and Sidekiq Enterprise customers get private email support.
You can purchase at https://sidekiq.org; email support@contribsys.com for help.
2017-10-10 16:41:14 +00:00
2016-02-05 21:30:34 +00:00
Useful resources:
2012-01-25 02:07:18 +00:00
2016-02-05 21:30:34 +00:00
* Product documentation is in the [wiki ](https://github.com/mperham/sidekiq/wiki ).
2019-07-11 18:11:35 +00:00
* Occasional announcements are made to the [@sidekiq ](https://twitter.com/sidekiq ) Twitter account.
2016-02-05 21:30:34 +00:00
* The [Sidekiq tag ](https://stackoverflow.com/questions/tagged/sidekiq ) on Stack Overflow has lots of useful Q & A.
2012-06-19 19:26:36 +00:00
2022-09-02 17:17:50 +00:00
Every Friday morning is Sidekiq office hour: I video chat and answer questions.
2019-07-11 18:11:35 +00:00
See the [Sidekiq support page ](https://sidekiq.org/support.html ) for details.
2014-04-19 02:59:44 +00:00
2022-02-01 20:51:52 +00:00
Contributing
-----------------
Please see [the contributing guidelines ](https://github.com/mperham/sidekiq/blob/main/.github/contributing.md ).
2012-01-25 03:44:57 +00:00
License
-----------------
2022-09-02 17:17:50 +00:00
Please see [LICENSE.txt ](https://github.com/mperham/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/mperham/sidekiq/blob/main/COMM-LICENSE.txt ).
2012-01-25 03:44:57 +00:00
2012-01-22 00:42:21 +00:00
Author
-----------------
2020-06-20 00:31:45 +00:00
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 )
