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