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

Hinrik Örn Sigurðsson bc7fdd1748 Prevent "cap deploy" from hanging		2012-03-29 12:17:38 +00:00
bin	Die, pidfile, die!	2012-03-28 18:51:57 -07:00
examples	Updating chef recipe	2012-03-21 20:44:21 -07:00
lib	Prevent "cap deploy" from hanging	2012-03-29 12:17:38 +00:00
myapp	Update deps	2012-03-27 20:16:27 -07:00
test	API cleanup, remove deprecations	2012-03-28 19:16:54 -07:00
web	API cleanup, remove deprecations	2012-03-28 19:16:54 -07:00
.gitignore	Use ENV var for coverage	2012-03-18 19:53:26 -07:00
.rvmrc	jruby fix	2012-02-12 21:16:49 -08:00
Changes.md	Prepare for release	2012-03-28 08:45:11 -07:00
COMM-LICENSE	Add GPL and commercial license info	2012-01-24 19:44:57 -08:00
config.ru	Implement simple home page and queue page	2012-03-05 20:53:14 -08:00
Gemfile	Initial spike of Sinatra/TwB2 based web UI	2012-03-04 12:58:16 -08:00
LICENSE	Clarify licensing to be per-site	2012-03-08 12:15:49 -08:00
Rakefile	Test cleanup	2012-03-17 21:36:33 -07:00
README.md	Clarify that Sidekiq uses multithreading instead of forking, which improves efficiency but should not be used for non-thread-safe or memory-leaking jobs. For #88	2012-03-26 10:26:05 -03:00
sidekiq.gemspec	Update capistrano recipe to use a custom ruby script, #95	2012-03-27 20:19:24 -07:00
TODO.md	Fix redis database URLs to use numeric indexes, #83	2012-03-18 20:09:27 -07:00

README.md

Sidekiq

Simple, efficient message processing for Ruby.

Sidekiq is compatible with Resque. It uses the exact same message format as Resque so it can integrate into 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.

At the same time, Sidekiq uses multithreading so it much more memory efficient than 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 efficiency and how I was able to shrink a Carbon Five client's resque processing farm from 9 machines to 1 machine.

In sum, if your jobs are well-behaved and threadsafe, Sidekiq is probably a good replacement for Resque. If your jobs are not thread-safe or they leak memory, you may want to continue using Resque, because its forking model gives you more protection.

Requirements

I test on Ruby 1.9.3 and JRuby 1.6.5 in 1.9 mode. Other versions/VMs are untested but I will do my best to support them. Ruby 1.8 is not supported.

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. #sidekiq on irc.freenode.net is dedicated to this project, but bug reports or feature requests suggestions should still go through issues on Github.

License

Please see LICENSE for licensing details.

Author

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