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 99a3194a96 Make global stats processing gracefully handle errors		2015-10-14 11:08:36 -07:00
bin	load changes	2015-10-07 19:22:42 -07:00
examples	rsn	2015-07-29 15:37:24 -07:00
lib	Make global stats processing gracefully handle errors	2015-10-14 11:08:36 -07:00
myapp	Merge branch 'master' into internal_rewrite	2015-10-08 10:20:11 -07:00
test	Move proctitles into CLI, so they can be accessed in startup events	2015-10-12 09:43:51 -07:00
web	Fix Norwegian Bokmål (nb) locale	2015-10-04 20:47:41 +02:00
.gitignore	Add worker generator test	2014-10-21 22:55:40 +08:00
.travis.yml	See how jruby-head (2.2 compatible) does on sidekiq	2015-02-25 11:47:56 +01:00
3.0-Upgrade.md	Use new proc syntax instead all Proc.new	2015-06-10 23:10:16 +03:00
Changes.md	Give credit, #2598	2015-10-09 13:28:40 -07:00
COMM-LICENSE	Few typo fixes	2015-09-30 21:26:12 +05:30
Contributing.md	update notes, prepare for release	2015-02-05 12:24:52 -08:00
Ent-Changes.md	Update Ent-Changes.md	2015-09-21 09:39:58 -07:00
Gemfile	merge load changes	2015-10-07 19:21:53 -07:00
LICENSE	Move copyright to contribsys	2014-07-17 13:53:54 -07:00
Pro-2.0-Upgrade.md	Note that Redis Sentinel should be safe to use	2015-07-02 11:15:20 -07:00
Pro-Changes.md	release	2015-10-05 13:26:29 -07: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	Fixed 'Getting Started' link	2015-08-25 17:04:09 +01:00
sidekiq.gemspec	Pick up concurrent-ruby fix	2015-10-08 20:59:05 -07:00

README.md

Sidekiq

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 Getting Started wiki page and follow the simple setup process. You can watch Railscast #366 to see Sidekiq in action. If you do everything right, you should see this:

Want to Upgrade?

I also sell Sidekiq Pro and Sidekiq Enterprise, extensions to Sidekiq which provide more features, a commercial-friendly license and allow you to support high quality open source development all at the same time. Please see the Sidekiq 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