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
2944 commits 15 branches 164 tags 17 MiB
Ruby 82%
HTML 14.3%
JavaScript 2.8%
CSS 0.9%
Find a file
Mike Perham 99667863e8 Remove note about ephemeral_hostname 
It was a hack and I don't want to document or support it long-term.  Instead call out timed_fetch as the right solution for most people.
2016-04-26 10:23:45 -07:00
.github Use the .github directory 2016-02-22 20:28:46 -08:00
bin bump version 2015-11-25 09:20:53 -08:00
examples typo 2015-12-18 13:52:26 -08:00
lib Merge branch 'master' into frozen 2016-04-21 13:15:00 -07:00
myapp Merge branch '3_x' 2016-02-08 13:43:45 -08:00
test Merge branch 'master' into frozen 2016-04-21 13:15:00 -07:00
web Add confirmation when quieting and stopping all workers 2016-04-20 19:23:41 -07:00
.gitignore Add worker generator test 2014-10-21 22:55:40 +08:00
.travis.yml Fix JRuby build 2016-04-14 00:51:18 +03: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 Client middleware should be able to stop bulk job push, fixes #2887 2016-03-16 09:26:07 -07:00
code_of_conduct.md Add code of conduct 2016-01-22 10:08:58 -08:00
COMM-LICENSE Section 3.2 is too broad 2016-03-08 09:05:19 -08:00
Ent-Changes.md Remove note about ephemeral_hostname 2016-04-26 10:23:45 -07: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 Remove note about ephemeral_hostname 2016-04-26 10:23:45 -07:00
Pro-Changes.md release note 2016-04-05 13:27:10 -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 not that frequently 2016-03-03 12:58:44 -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 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

Sidekiq supports CRuby 2.0+ and JRuby 9k.

All Rails releases >= 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.

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.
  • Here's a Reddit forum dedicated to Sidekiq discussion
  • The Sidekiq tag on Stack Overflow has lots of useful Q & A.

No support via Twitter, 140 characters is not enough.

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

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