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

bray 1d29ea5455 Better number legibility		2012-08-31 10:21:44 -04:00
bin	Helpful error messages are helpful	2012-05-03 15:36:05 -07:00
examples	config files are named X.yml, not X.conf	2012-06-27 11:27:09 -05:00
lib	Better number legibility	2012-08-31 10:21:44 -04:00
myapp	Add pagination to Web UI	2012-07-17 22:14:15 -07:00
test	Add support for custom tabs to Sidekiq::Web #346	2012-08-20 19:28:14 -03:00
web	Better number legibility	2012-08-31 10:21:44 -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
.travis.yml	Allow jruby to fail for now, since 1.7 is not available	2012-06-25 22:28:40 -07:00
Changes.md	prepare for 2.2.1 release	2012-08-22 19:31:02 -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	update rails	2012-08-15 09:08:00 -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	Clarify that rails is not required	2012-08-30 21:02:49 -07:00
sidekiq.gemspec	Remove defer hack which caused Sidekiq to use more connections and memory than necessary	2012-07-17 07:11:11 -07: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 does not require Rails but will integrate 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.

Redis 2.0 or greater is required.

Installation

gem install sidekiq

Getting Started

See the sidekiq home page for the simple 4-step process. You can watch Railscast #366 to see Sidekiq in action.

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.

Problems?

Please do not directly email any Sidekiq committers with questions or problems. A community is best served when discussions are held in public.

If you have a problem, please review the FAQ 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. 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.

License

Please see LICENSE for licensing details.

Author

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