Skip to content

Simple, efficient background processing for Ruby

License

Notifications You must be signed in to change notification settings

Breeze-Aviation/sidekiq

 
 

Repository files navigation

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: 6.2+
  • Ruby: MRI 2.7+ or JRuby 9.3+.

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

Installation

bundle add 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?

Use bundle up sidekiq to upgrade Sidekiq and all its dependencies. Upgrade notes between each major version can be found in the docs/ directory.

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.

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 office hour: I video chat and answer questions. See the Sidekiq support page for details.

Contributing

Please see the contributing guidelines.

License

Please see LICENSE.txt for licensing details. The license for Sidekiq Pro and Sidekiq Enterprise can be found in COMM-LICENSE.txt.

Author

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

About

Simple, efficient background processing for Ruby

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • Ruby 77.4%
  • HTML 13.5%
  • CSS 6.5%
  • JavaScript 2.6%