1
0
Fork 0
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
2021-05-14 05:24:33 -07:00
.github Remove old template 2020-08-28 13:41:17 -07:00
bin Use error handler(s) from CLI launch failure (#4581) 2020-05-27 09:42:45 -07:00
examples optimize PNGs 2021-03-12 16:16:33 -08:00
lib Minor text change to make the description correct. (#4902) 2021-05-14 05:24:33 -07:00
myapp Improve Web UI session experience (#4804) 2021-02-12 14:50:51 -08:00
test Add pessimistic regexp on queue name input to avoid XSS, fixes #4852 2021-03-25 16:16:55 -07:00
web UI heading polish via @mobilutz, closes #4866 2021-05-03 12:51:16 -07:00
.gitignore Enable Gemfile.lock as CircleCI needs a lockfile 2019-08-28 10:36:36 -07:00
.standard.yml standard 1.0, update format exceptions 2021-03-05 11:24:12 -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 Add note, fixes #2977 2016-05-18 08:55:35 -07:00
5.0-Upgrade.md Fix typo in upgrade manual, method is delay_for (#4721) 2020-10-19 10:16:08 -07:00
6.0-Upgrade.md didn't make it into 6.0.1 2019-11-30 10:18:10 -08:00
Changes.md Minimize scheduler load on Redis, closes #4882 2021-05-03 13:13:38 -07:00
code_of_conduct.md Add code of conduct 2016-01-22 10:08:58 -08:00
COMM-LICENSE.txt Add .txt extension for easier reading 2021-05-13 10:31:38 -07:00
Ent-2.0-Upgrade.md Commercial changes 2019-08-29 10:37:23 -07:00
Ent-Changes.md change 2021-02-05 17:16:53 -08:00
Gemfile gems 2021-01-21 09:58:11 -08:00
Gemfile.lock mimemagic!!!! 2021-04-06 08:28:50 -07:00
LICENSE Add .txt extension for easier reading 2021-05-13 10:31:38 -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-4.0-Upgrade.md polish 2018-02-03 12:33:26 -08:00
Pro-5.0-Upgrade.md Commercial changes 2019-08-29 10:37:23 -07:00
Pro-Changes.md ready for release 2021-04-07 13:34:33 -07:00
Rakefile Run code formatter as part of test suite 2019-04-01 09:36:24 -07:00
README.md this badge ain't really necessary 2020-08-28 13:37:13 -07:00
sidekiq.gemspec Update gemspec with files whitelist 2021-03-08 13:51:07 -08:00

Sidekiq

Gem Version Build

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.

Performance

Version Latency Garbage created for 10k jobs Time to process 100k jobs Throughput Ruby
Sidekiq 6.0.2 3 ms 156 MB 14.0 sec 7100 jobs/sec MRI 2.6.3
Sidekiq 6.0.0 3 ms 156 MB 19 sec 5200 jobs/sec MRI 2.6.3
Sidekiq 4.0.0 10 ms 151 MB 22 sec 4500 jobs/sec
Sidekiq 3.5.1 22 ms 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 and assumes a Redis network latency of 1ms.

Requirements

  • Redis: 4.0+
  • Ruby: MRI 2.5+ or JRuby 9.2+.

Sidekiq 6.0 supports Rails 5.0+ but does not require it.

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.

Sidekiq Pro and Sidekiq Enterprise customers get private email support. You can purchase at https://sidekiq.org; email support@contribsys.com for help.

Useful resources:

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

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

License

Please see LICENSE for licensing details.

Author

Mike Perham, @getajobmike / @sidekiq, https://www.mikeperham.com / https://www.contribsys.com