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
2762 commits 15 branches 164 tags 17 MiB
Ruby 82%
HTML 14.3%
JavaScript 2.8%
CSS 0.9%
Find a file
Mike Perham 078b2faead concurrent-ruby 1.0!
2015-11-15 09:53:40 -06:00
bin Fix script to work with pro and ent 2015-11-12 14:00:04 -08:00
examples rsn 2015-07-29 15:37:24 -07:00
lib Ensure comparison between strings 2015-11-14 13:54:01 +01:00
myapp Merge branch 'master' into internal_rewrite 2015-10-08 10:20:11 -07:00
test Unique all workers and ensure symbol queues are stringified via testing 2015-11-13 17:08:54 -05:00
web be consistent with names 2015-11-06 15:24:57 -06: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
4.0-Upgrade.md Update code samples to be valid 2015-11-13 17:27:12 -05:00
Changes.md Update code samples to be valid 2015-11-13 17:27:12 -05: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 078 2015-11-13 09:56:40 -08:00
Gemfile Found and killed the test suite instability. 2015-10-21 09:29:58 -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-3.0-Upgrade.md Sidekiq Pro 3.0 release notes 2015-10-23 15:54:44 -07:00
Pro-Changes.md 2.1.3 release notes 2015-11-03 13:41:19 -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 latest 2015-10-30 13:41:18 -07:00
sidekiq.gemspec concurrent-ruby 1.0! 2015-11-15 09:53:40 -06:00

README.md

Sidekiq

Gem Version Code Climate Build 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.8 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:

Web UI

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 Reddit area 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. StackOverflow or Reddit 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 multithreaded profiling tools.

License

Please see LICENSE for licensing details.

Author

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