1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00
mperham--sidekiq/README.md

65 lines
2.4 KiB
Markdown
Raw Normal View History

2012-01-16 18:17:42 -05:00
Sidekiq
2012-01-21 19:42:21 -05:00
==============
2012-01-16 18:17:42 -05:00
2012-01-21 19:42:21 -05:00
Simple, efficient message processing for Ruby.
2012-02-05 10:55:18 -05:00
Sidekiq aims to be compatible with Resque. It uses the exact same
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
Sidekiq is different from Resque in how it processes messages: it
processes many messages concurrently per process. Resque only processes
one message at a time per process so it is far less memory efficient.
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
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
-----------------
I test on Ruby 1.9.3 and JRuby 1.6.5 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
Installation
-----------------
gem install sidekiq
2012-01-26 00:12:18 -05:00
Getting Started
2012-01-21 19:42:21 -05:00
-----------------
2012-01-26 00:12:18 -05:00
See the [sidekiq home page](http://mperham.github.com/sidekiq) for the simple 4-step process.
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-01-24 21:07:18 -05:00
2012-01-24 22:44:57 -05:00
License
-----------------
sidekiq is GPLv3 licensed for **non-commercial use only**. For a commercial
license, you must give $50 to my [Pledgie campaign](http://www.pledgie.com/campaigns/16623).
2012-01-26 00:12:18 -05:00
Considering the hundreds of hours I've spent writing OSS, I hope you
think this is a reasonable price. BTW, the commercial license is in
COMM-LICENSE and is the [Sencha commercial license v1.10](http://www.sencha.com/legal/sencha-commercial-software-license-agreement/) with the Support (section 11) terms removed.
2012-02-05 13:02:51 -05:00
Support is provided through GitHub Issues. You are welcome to try the
software for 2 weeks.
2012-01-24 22:44:57 -05:00
<a href='http://www.pledgie.com/campaigns/16623'><img alt='Click here to lend your support to Open Source and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/16623.png?skin_name=chrome' border='0' /></a>
2012-01-21 19:42:21 -05:00
Author
-----------------
Mike Perham, [@mperham](https://twitter.com/mperham), [http://mikeperham.com](http://mikeperham.com)
2012-01-23 23:56:06 -05:00