2012-08-07 16:01:34 -04:00
Sidekiq
2012-01-21 19:42:21 -05:00
==============
2012-01-16 18:17:42 -05:00
2013-03-11 21:40:11 -04:00
- [](https://rubygems.org/gems/sidekiq)
- [](https://codeclimate.com/github/mperham/sidekiq)
- [](https://travis-ci.org/mperham/sidekiq)
- [](https://coveralls.io/r/mperham/sidekiq)
2012-08-07 16:01:34 -04:00
2012-01-21 19:42:21 -05:00
Simple, efficient message processing for Ruby.
2012-04-05 22:20:24 -04:00
Sidekiq uses threads to handle many messages at the same time in the
2012-08-31 00:02:49 -04:00
same process. It does not require Rails but will integrate tightly with
Rails 3 to make background message processing dead simple.
2012-04-05 22:20:24 -04:00
2012-03-26 09:26:05 -04:00
Sidekiq is compatible with Resque. It uses the exact same
2012-02-05 10:55:18 -05:00
message format as Resque so it can integrate into an existing Resque processing farm.
2012-01-21 19:42:21 -05:00
You can have Sidekiq and Resque run side-by-side at the same time and
2012-01-23 23:56:06 -05:00
use the Resque client to enqueue messages in Redis to be processed by Sidekiq.
2012-01-21 19:42:21 -05:00
2012-05-13 23:50:25 -04:00
At the same time, Sidekiq uses multithreading so it is much more memory efficient than
2012-04-05 22:20:24 -04:00
Resque (which forks a new process for every job). You'll find that you might need
50 200MB resque processes to peg your CPU whereas one 300MB Sidekiq process will peg
the same CPU and perform the same amount of work. Please see [my blog post on Resque's memory
2012-01-21 19:42:21 -05:00
efficiency](http://blog.carbonfive.com/2011/09/16/improving-resques-memory-efficiency/)
2012-01-26 00:12:18 -05:00
and how I was able to shrink a Carbon Five client's resque processing farm
2012-01-21 19:42:21 -05:00
from 9 machines to 1 machine.
Requirements
-----------------
2012-04-05 22:20:24 -04:00
I test on Ruby 1.9.3 and JRuby 1.6.x in 1.9 mode. Other versions/VMs are
2012-02-05 16:06:33 -05:00
untested but I will do my best to support them. Ruby 1.8 is not supported.
2012-01-21 19:42:21 -05:00
2012-07-25 21:41:05 -04:00
Redis 2.0 or greater is required.
2012-01-21 19:42:21 -05:00
Installation
-----------------
2012-06-26 20:52:06 -04:00
gem install sidekiq
2012-01-21 19:42:21 -05:00
2012-01-26 00:12:18 -05:00
Getting Started
2012-01-21 19:42:21 -05:00
-----------------
2013-04-01 01:32:13 -04:00
See the [sidekiq home page ](http://mperham.github.com/sidekiq ) for the simple 3-step process.
2013-03-16 18:31:06 -04:00
You can watch [Railscast #366 ](http://railscasts.com/episodes/366-sidekiq ) to see Sidekiq in action. If you do everything right, you should see this:
2012-01-21 19:42:21 -05:00
2013-04-08 11:33:37 -04:00
Want More?
-------------------
I also sell Sidekiq Pro, an extension to Sidekiq which provides more
features, a commercial-friendly license and allows you to support high
quality open source development all at the same time. Please see the
[Sidekiq Pro ](http://sidekiq.org/pro ) homepage for more detail.
2012-01-21 19:42:21 -05:00
2012-01-24 21:07:18 -05:00
More Information
-----------------
2012-01-26 00:12:18 -05:00
Please see the [sidekiq wiki ](https://github.com/mperham/sidekiq/wiki ) for more information.
2012-03-06 13:20:06 -05:00
[#sidekiq on irc.freenode.net ](irc://irc.freenode.net/#sidekiq ) is dedicated to this project,
but bug reports or feature requests suggestions should still go through [issues on Github ](https://github.com/mperham/sidekiq/issues ).
2012-01-24 21:07:18 -05:00
2012-06-19 15:26:36 -04:00
There's also a mailing list via [Librelist ](http://librelist.org ) that you can subscribe to by sending
2012-12-15 23:40:35 -05:00
an email to < sidekiq @ librelist . org > with a greeting in the body. To unsubscribe, send an email to < sidekiq-unsubscribe @ librelist . org > and that's it!
2012-06-19 15:26:36 -04:00
Once archiving begins, you'll be able to visit [the archives ](http://librelist.com/browser/sidekiq/ ) to see past threads.
2012-01-24 21:07:18 -05:00
2012-08-02 12:01:56 -04:00
Problems?
-----------------
**Please do not directly email any Sidekiq committers with questions or problems.** A community is best served when discussions are held in public.
2013-02-12 09:59:41 -05: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 for your problem is also a good idea. If that doesn't help, feel free to email the Sidekiq mailing list or open a new issue.
2012-08-08 19:08:05 -04:00
The mailing list is the preferred place to ask questions on usage. If you are encountering what you think is a bug, please open an issue.
2012-08-02 12:01:56 -04:00
2012-01-24 22:44:57 -05:00
License
-----------------
2012-02-07 11:51:39 -05:00
Please see LICENSE for licensing details.
2012-01-24 22:44:57 -05:00
2012-01-21 19:42:21 -05:00
Author
-----------------
Mike Perham, [@mperham ](https://twitter.com/mperham ), [http://mikeperham.com ](http://mikeperham.com )
