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
2331 commits 15 branches 164 tags 17 MiB
Ruby 82%
HTML 14.3%
JavaScript 2.8%
CSS 0.9%
Find a file
Mike Perham f89a0eed56 Merge pull request #2194 from rmm5t/svg-badges 
Switch README badges from PNG to SVG
2015-02-18 16:42:06 -08:00
bin Better usage text for sidekiqctl 2014-12-26 09:20:15 -08:00
examples Better example 2015-01-27 08:26:52 -08:00
lib Delete excess self 2015-02-12 22:59:49 +03:00
myapp Add a Procfile for testing Foreman 2014-10-22 13:57:41 -07:00
test test for Stats#queues 2015-01-28 08:49:29 -08:00
web Extract product version, #1991 2015-01-21 10:36:17 -08:00
.gitignore Add worker generator test 2014-10-21 22:55:40 +08:00
.travis.yml 🍏 build 2015-01-06 11:16:46 +00:00
3.0-Upgrade.md Mention support for REDIS_URL 2014-06-02 11:20:04 -04:00
Changes.md update notes, prepare for release 2015-02-05 12:24:52 -08:00
COMM-LICENSE verbage 2014-01-11 14:43:49 -08:00
Contributing.md update notes, prepare for release 2015-02-05 12:24:52 -08:00
Gemfile Add debugging tools by default (byebug and pry) 2014-11-14 17:22:52 +00:00
LICENSE Move copyright to contribsys 2014-07-17 13:53:54 -07:00
Pro-2.0-Upgrade.md wordsmithing 2015-02-18 11:08:23 -08:00
Pro-Changes.md shipped 2015-02-18 08:30:31 -08:00
Rakefile allow every test to be run with just ruby test/xxx_test.rb 2014-12-30 12:54:58 -08:00
README.md Switch README badges from PNG to SVG 2015-02-18 17:32:12 -07:00
sidekiq.gemspec Require latest connection_pool to deal with timeout issue 2015-01-26 16:24:41 -08:00

README.md

Sidekiq

Gem Version Code Climate Build Status Coverage Status Gitter Chat

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 10 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 MRI (2.2, 2.1 and 2.0) and JRuby versions (1.7). Other versions/VMs are untested but might work fine. MRI 1.9 is no longer supported.

All Rails releases starting from 3.2 are officially supported.

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 the official documentation. mperham/sidekiq on Gitter is dedicated to this project, but bug reports or feature requests suggestions should still go through issues on Github. Release announcements are made to the @sidekiq Twitter account.

You may also find useful a Google Group dedicated to Sidekiq discussion and a Sidekiq tag on Stack Overflow.

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, chat in Gitter, 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.

Thanks

Sidekiq stays fast by using the JProfiler java profiler to find and fix performance problems on JRuby. Unfortunately MRI does not have good profile tooling.

License

Please see LICENSE for licensing details.

Author

Mike Perham, @mperham / @sidekiq, http://www.mikeperham.com / http://www.contribsys.com