kotovalexarian-likes-github/mperham--sidekiq

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

Simple, efficient background processing for Ruby

Find a file

Ryan LeCompte 144bc904cf rework how middleware chain is invoked, add middleware tests and cleanup		2012-02-04 21:45:34 -08:00
bin	Fix dev load path logic	2012-01-26 11:50:23 -08:00
lib	rework how middleware chain is invoked, add middleware tests and cleanup	2012-02-04 21:45:34 -08:00
myapp	Rename workers to processors. New Railtie support.	2012-01-25 13:32:51 -08:00
test	rework how middleware chain is invoked, add middleware tests and cleanup	2012-02-04 21:45:34 -08:00
.rvmrc	SimpleCov fixes	2012-01-23 22:07:21 -08:00
Changes.md	Documentation, start client work	2012-01-21 16:42:21 -08:00
COMM-LICENSE	Add GPL and commercial license info	2012-01-24 19:44:57 -08:00
Gemfile	Integrate simplecov	2012-01-23 21:02:54 -08:00
Gemfile.lock	Add full multithreaded integration test for manager	2012-02-03 10:02:57 -08:00
LICENSE	Add GPL and commercial license info	2012-01-24 19:44:57 -08:00
Rakefile	SimpleCov fixes	2012-01-23 22:07:21 -08:00
README.md	readme overhaul	2012-01-25 21:12:18 -08:00
sidekiq.gemspec	Add Sidekiq::Processor testing, with bug fixes	2012-01-26 12:45:04 -08:00
TODO.md	Add Sidekiq::Processor testing, with bug fixes	2012-01-26 12:45:04 -08:00

README.md

Sidekiq

Simple, efficient message processing for Ruby.

Sidekiq aims to be a drop-in replacement for Resque. It uses the exact same message format as Resque so it can slowly replace an existing Resque processing farm. You can have Sidekiq and Resque run side-by-side at the same time and use the Resque client to enqueue messages in Redis to be processed by Sidekiq.

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 and how I was able to shrink a Carbon Five client's resque processing farm 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 untested.

Installation

gem install sidekiq

Getting Started

See the sidekiq home page for the simple 4-step process.

More Information

Please see the sidekiq wiki for more information.

License

sidekiq is GPLv3 licensed for non-commercial use only. For a commercial license, you must give $50 to my Pledgie campaign. 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 with the Support (section 11) terms removed.

Author

Mike Perham, @mperham, http://mikeperham.com