Simple, efficient background processing for Ruby

Go to file

Mike Perham fba25e1f64 Merge branch '7-0' into xa		2022-04-08 12:11:19 -07:00
.github	merge main	2022-04-06 10:56:39 -07:00
bin	Cleanups for sidekiqload (#5136 )	2022-02-07 12:34:05 -08:00
docs	7.0 notes, fix CI	2022-02-14 15:27:16 -08:00
examples	Change systemd restart method to "always"	2022-03-24 12:53:37 -04:00
lib	return callback	2022-04-06 11:42:59 -07:00
myapp	Fix API change	2022-03-11 10:28:24 -08:00
test	fix flaky test	2022-04-06 11:14:44 -07:00
web	merge main	2022-04-06 10:56:39 -07:00
.gitignore	Ignore Docker config in git (#5223 )	2022-02-27 10:55:23 -08:00
.standard.yml	Update standard to use ruby 2.7 rules	2022-01-26 09:09:03 -08:00
.yalphabetize.yml	Add yalphabetize for yaml normalisation (#5199 )	2022-02-28 15:30:54 -08:00
COMM-LICENSE.txt	Rename master branch to main	2021-10-12 07:49:36 -07:00
Changes.md	merge main	2022-04-06 10:56:39 -07:00
Ent-Changes.md	Merge branch 'main' into 7-0	2022-02-14 14:59:18 -08:00
Gemfile	Remove a_c_e as a direct dependency	2022-04-06 11:14:43 -07:00
LICENSE	Wording and formatting, no significant changes	2022-01-05 19:43:53 -08:00
Pro-Changes.md	merge main	2022-04-06 10:56:39 -07:00
README.md	merge main	2022-04-06 10:56:39 -07:00
Rakefile	Add yalphabetize for yaml normalisation (#5199 )	2022-02-28 15:30:54 -08:00
code_of_conduct.md	Add code of conduct	2016-01-22 10:08:58 -08:00
sidekiq.gemspec	Remove a_c_e as a direct dependency	2022-04-06 11:14:43 -07:00

README.md

Sidekiq

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.0+
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:

Want to Upgrade?

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

Contributing

Please see the contributing guidelines.

License

Please see LICENSE for licensing details.

Author

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