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
3283 commits 15 branches 164 tags 17 MiB
Ruby 82%
HTML 14.3%
JavaScript 2.8%
CSS 0.9%
Find a file
Mike Perham b38bb6f676 polish
2017-06-07 10:26:44 -07:00
.github tweak 2017-03-16 13:44:33 -07:00
bin merge master 2017-02-20 10:12:49 -08:00
examples Remove more USR1 references 2017-01-03 15:41:48 -08:00
lib polish 2017-06-07 10:26:44 -07:00
myapp Make Sidekiq Web UI RTL-friendly (#3381) 2017-03-16 13:51:29 -07:00
test polish 2017-06-07 10:26:44 -07:00
web rework leader api change to avoid breaking processset#to_a 2017-05-26 10:35:19 -07:00
.gitignore Rework job processing in light of Rails 5's Reloader (#3235) 2017-01-17 14:58:08 -08:00
.travis.yml Remove percy, the Web UI doesn’t change enough to justify the complex dependency 2017-06-06 14:54:20 -07:00
3.0-Upgrade.md
4.0-Upgrade.md Add note, fixes #2977 2016-05-18 08:55:35 -07:00
5.0-Upgrade.md Verify graceful handling of ill-formed job payloads, fixes #3406 2017-03-24 11:59:48 -07:00
Changes.md polish 2017-06-07 10:26:44 -07:00
code_of_conduct.md Add code of conduct 2016-01-22 10:08:58 -08:00
COMM-LICENSE Update COMM-LICENSE to fix a broken url (#3465) 2017-05-09 06:13:32 -07:00
Ent-Changes.md Add support for showing the Sidekiq Enterprise cluster leader process in Web UI, fixes mperham/sidekiq#2867 2017-05-26 10:26:46 -07:00
Gemfile Fix minitest warnings (#3300) 2017-01-02 12:06:02 -08:00
LICENSE
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 Remove note about ephemeral_hostname 2016-04-26 10:23:45 -07:00
Pro-Changes.md changes 2017-04-27 10:43:23 -07:00
Rakefile Minimize Ruby warnings in test suite 2016-11-23 14:50:11 -08:00
README.md note 2017-06-02 16:41:21 -07:00
sidekiq.gemspec Remove percy, the Web UI doesn’t change enough to justify the complex dependency 2017-06-06 14:54:20 -07: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 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.

Performance

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

This benchmark can be found in bin/sidekiqload.

Requirements

Sidekiq supports CRuby 2.2.2+ and JRuby 9k.

All Rails releases >= 4.0 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 this Youtube playlist to learn all about Sidekiq and see its features in action. Here's the Web UI:

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.

Subscribe to the quarterly newsletter to stay informed about the latest features and changes to Sidekiq and its bigger siblings.

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.

Useful resources:

  • Product documentation is in the wiki.
  • Release announcements are made to the @sidekiq Twitter account.
  • The Sidekiq tag on Stack Overflow has lots of useful Q & A.

No support via Twitter, 140 characters is not enough.

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

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