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
2881 commits 15 branches 164 tags 17 MiB
Ruby 82%
HTML 14.3%
JavaScript 2.8%
CSS 0.9%
Find a file
Mike Perham 8761a23c20 notes for #2806
2016-02-01 10:29:31 -08:00
bin bump version 2015-11-25 09:20:53 -08:00
examples typo 2015-12-18 13:52:26 -08:00
lib Update redis_connection.rb 2016-01-29 20:12:39 +01:00
myapp Push a job to fill queue so we can delete it in UI 2015-11-23 09:39:14 -08:00
test Merge pull request #2745 from ckersh/test_coverage_handle_signal 2016-01-30 10:55:55 -08:00
web Oops, use display_class here 2016-01-27 08:59:25 -08:00
.gitignore Add worker generator test 2014-10-21 22:55:40 +08:00
.travis.yml fix build 2016-01-21 09:29:37 -08: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 Revert "Revert "Merge pull request #2659 from mperham/queue-testing-api"" 2015-11-17 13:07:30 -05:00
Changes.md bump version 2016-01-28 13:28:45 -08:00
code_of_conduct.md Add code of conduct 2016-01-22 10:08:58 -08: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 New ent feature 2016-01-28 13:27:19 -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 notes for #2806 2016-02-01 10:29: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 more support details 2016-01-20 14:00:49 -08:00
sidekiq.gemspec remove json, fixes #2743 2015-12-31 15:43:16 -08: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.

Sidekiq is fast.

Version Latency Garbage created for 10,000 jobs Time to process 100,000 jobs Throughput
Sidekiq 4.0.0 10ms 151 MB 22 sec 4500 jobs/sec
Sidekiq 3.5.1 22ms 1257 MB 125 sec 800 jobs/sec
Resque 1.25.2 - - 420 sec 240 jobs/sec
DelayedJob 4.1.1 - - 465 sec 215 jobs/sec

Requirements

I test with the latest CRuby (2.2, 2.1 and 2.0) and JRuby versions (9k). Other versions/VMs are untested but might work fine. CRuby 1.9 is not supported.

All Rails releases from 3.2 are officially supported.

Redis 2.8 or greater is required. 3.0.3+ is recommended for large installations with thousands of worker threads.

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.

Problems?

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

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. No support via Twitter.

Every Friday morning is Sidekiq happy hour: I video chat and answer questions. See the Sidekiq support page.

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

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