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

Mike Perham 7a45208cf0 Defer loading message JSON until a full stack is available.		2012-06-21 20:51:47 -07:00
bin	Helpful error messages are helpful	2012-05-03 15:36:05 -07:00
examples	Don't execute sidekiq w/bundle exec in EY chef	2012-06-21 18:33:30 -07:00
lib	Defer loading message JSON until a full stack is available.	2012-06-21 20:51:47 -07:00
myapp	fix typo	2012-06-12 07:07:53 -07:00
test	Defer loading message JSON until a full stack is available.	2012-06-21 20:51:47 -07:00
web	Cleanup navigation for smaller screens	2012-06-20 03:38:16 -04: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	Defer loading message JSON until a full stack is available.	2012-06-21 20:51:47 -07:00
COMM-LICENSE	Fix references to GPL, #168	2012-05-02 20:23:24 -07:00
config.ru	Add delete and retry now operations to web UI	2012-03-29 20:55:16 -07:00
Gemfile	Allow deletion of queues from web UI [#154 ]	2012-05-02 20:19:59 -07:00
LICENSE	Update license to LGPLv3 [#124 ]	2012-04-12 07:09:27 -07:00
Rakefile	Test cleanup	2012-03-17 21:36:33 -07:00
README.md	Adding note about mailing list	2012-06-19 12:26:36 -07:00
sidekiq.gemspec	Declare the license in gemspec	2012-06-19 13:55:06 -04:00

README.md

Sidekiq

Simple, efficient message processing for Ruby.

Sidekiq uses threads to handle many messages at the same time in the same process. It integrates tightly with Rails 3 to make background message processing dead simple.

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 is 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.

Requirements

I test on Ruby 1.9.3 and JRuby 1.6.x 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.

There's also a mailing list via Librelist that you can subscribe to by sending and 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! Once archiving begins, you'll be able to visit the archives to see past threads.

License

Please see LICENSE for licensing details.

Author

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