kotovalexarian-likes-github/mperham--sidekiq
1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00
Code Releases Activity
Simple, efficient background processing for Ruby
1539 commits 15 branches 164 tags 17 MiB
Ruby 82%
HTML 14.3%
JavaScript 2.8%
CSS 0.9%
Find a file
Aaron Ackerman 812c1dc0bd Fix method name collision between Sidekiq::Fetcher and Sidekiq::ExceptionHandler
2013-11-09 21:48:54 -06:00
bin Remove superfluous binary and remove examples from gem 2013-03-03 16:24:36 -08:00
examples Remove environment support in .yml, #1257 2013-10-16 19:24:22 -07:00
lib Fix method name collision between Sidekiq::Fetcher and Sidekiq::ExceptionHandler 2013-11-09 21:48:54 -06:00
myapp Upgrade test app to Rails 4 2013-09-22 14:44:37 -07:00
test Sidekiq::Web add testcase for escaping 2013-10-31 00:12:23 +01:00
web Sidekiq::Web escape args on workers and queues page 2013-10-30 23:11:12 +01:00
.gitignore Allow setting of a custom timeout for the Redis Connection Pool 2013-07-16 15:40:50 -06:00
.travis.yml Revert travis config. 2013-02-01 12:26:03 -05:00
Changes.md Changes update, bump version 2013-10-30 20:37:38 -07:00
COMM-LICENSE Add commercial license for Sidekiq Pro 2012-10-04 09:34:56 -07:00
config.ru Add delete and retry now operations to web UI 2012-03-29 20:55:16 -07:00
Contributing.md Update Contributing.md 2013-10-23 20:48:10 -07:00
Gemfile Gemfile cleanup 2013-08-22 11:47:50 -07:00
LICENSE Add commercial license for Sidekiq Pro 2012-10-04 09:34:56 -07:00
Pro-Changes.md Latest Pro and OSS changes 2013-10-21 13:45:11 -07:00
Rakefile Test cleanup 2012-03-17 21:36:33 -07:00
README.md Update readme with latest supported versions 2013-09-22 14:24:23 -07:00
sidekiq.gemspec Use new celluloid/test.rb 2013-10-07 12:59:28 +13:00

README.md

Sidekiq

Gem Version Code Climate Build Status Coverage Status

Simple, efficient background processing for Ruby.

Sidekiq uses threads to handle many jobs at the same time in the same process. It does not require Rails but will integrate tightly with Rails 3/4 to make background 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 jobs 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.

Requirements

I test with the latest Ruby (2.0) and JRuby versions (1.7). Other versions/VMs are untested but might work fine.

The last two major Rails releases (3.2 and 4.0) are officially supported, other versions might work fine.

Redis 2.4 or greater is required.

Installation

gem install sidekiq

Getting Started

See the sidekiq home page for the simple 3-step process. You can watch Railscast #366 to see Sidekiq in action. If you do everything right, you should see this:

Web UI

Want to Upgrade?

I also sell Sidekiq Pro, an extension to Sidekiq which provides more features, a commercial-friendly license and allows you to support high quality open source development all at the same time. Please see the Sidekiq Pro homepage for more detail.

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 an 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