sidekiq 2.15.1 → 4.2.10

data/README.md

@@ -1,36 +1,43 @@
 Sidekiq
 ==============
 
-[![Gem Version](https://badge.fury.io/rb/sidekiq.png)](https://rubygems.org/gems/sidekiq) [![Code Climate](https://codeclimate.com/github/mperham/sidekiq.png)](https://codeclimate.com/github/mperham/sidekiq) [![Build Status](https://travis-ci.org/mperham/sidekiq.png)](https://travis-ci.org/mperham/sidekiq) [![Coverage Status](https://coveralls.io/repos/mperham/sidekiq/badge.png?branch=master)](https://coveralls.io/r/mperham/sidekiq)
+[![Gem Version](https://badge.fury.io/rb/sidekiq.svg)](https://rubygems.org/gems/sidekiq)
+[![Code Climate](https://codeclimate.com/github/mperham/sidekiq.svg)](https://codeclimate.com/github/mperham/sidekiq)
+[![Build Status](https://travis-ci.org/mperham/sidekiq.svg)](https://travis-ci.org/mperham/sidekiq)
+[![Gitter Chat](https://badges.gitter.im/mperham/sidekiq.svg)](https://gitter.im/mperham/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 3/4 to make background processing dead simple.
+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.
 
-At the same time, Sidekiq uses multithreading so it is much more memory efficient than
-Resque (which forks a new process for every job).  You'll find that you might need
-50 200MB resque processes to peg your CPU whereas one 300MB Sidekiq process will peg
-the same CPU and perform the same amount of work.
+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
 
 
 Requirements
 -----------------
 
-I test with the latest Ruby (2.0) and JRuby versions (1.7).  Other versions/VMs
-are untested but might work fine.
+Sidekiq supports CRuby 2.0+ and JRuby 9k.
 
-The last two major Rails releases (3.2 and 4.0) are officially supported, other
-versions might work fine.
+All Rails releases >= 3.2 are officially supported.
 
-Redis 2.4 or greater is required.
+Redis 2.8 or greater is required.  3.0.3+ is recommended for large
+installations with thousands of worker threads.
 
 
 Installation
@@ -42,8 +49,9 @@ Installation
 Getting Started
 -----------------
 
-See the [sidekiq home page](http://mperham.github.com/sidekiq) for the simple 3-step process.
-You can watch [Railscast #366](http://railscasts.com/episodes/366-sidekiq) to see Sidekiq in action.  If you do everything right, you should see this: 
+See the [Getting Started wiki page](https://github.com/mperham/sidekiq/wiki/Getting-Started) and follow the simple setup process.
+You can watch [this Youtube playlist](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1) to learn all about
+Sidekiq and see its features in action.  Here's the Web UI:
 
 ![Web UI](https://github.com/mperham/sidekiq/raw/master/examples/web-ui.png)
 
@@ -51,31 +59,40 @@ You can watch [Railscast #366](http://railscasts.com/episodes/366-sidekiq) to se
 Want to Upgrade?
 -------------------
 
-I also sell Sidekiq Pro, an extension to Sidekiq which provides more
-features, a commercial-friendly license and allows you to support high
+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 Pro](http://sidekiq.org/pro) homepage for more detail.
+[Sidekiq](http://sidekiq.org/) homepage for more detail.
+
+Subscribe to the **[quarterly newsletter](https://tinyletter.com/sidekiq)** to stay informed about the latest
+features and changes to Sidekiq and its bigger siblings.
 
 
-More Information
+Problems?
 -----------------
 
-Please see the [sidekiq wiki](https://github.com/mperham/sidekiq/wiki) for more information.
-[#sidekiq on irc.freenode.net](irc://irc.freenode.net/#sidekiq) is dedicated to this project,
-but bug reports or feature requests suggestions should still go through [issues on Github](https://github.com/mperham/sidekiq/issues).
+**Please do not directly email any Sidekiq committers with questions or problems.**  A community is best served when discussions are held in public.
 
-There's also a mailing list via [Librelist](http://librelist.org) that you can subscribe to by sending
-an email to <sidekiq@librelist.org> with a greeting in the body. To unsubscribe, send an email to <sidekiq-unsubscribe@librelist.org> and that's it!
-Once archiving begins, you'll be able to visit [the archives](http://librelist.com/browser/sidekiq/) to see past threads.
+If you have a problem, please review the [FAQ](https://github.com/mperham/sidekiq/wiki/FAQ) and [Troubleshooting](https://github.com/mperham/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages.
+Searching the [issues](https://github.com/mperham/sidekiq/issues) for your problem is also a good idea.
 
+Useful resources:
 
-Problems?
------------------
+* Product documentation is in the [wiki](https://github.com/mperham/sidekiq/wiki).
+* Release announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
+* Here's a [Reddit forum](https://reddit.com/r/sidekiq) dedicated to Sidekiq discussion
+* The [Sidekiq tag](https://stackoverflow.com/questions/tagged/sidekiq) on Stack Overflow has lots of useful Q &amp; A.
 
-**Please do not directly email any Sidekiq committers with questions or problems.**  A community is best served when discussions are held in public.
+**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](http://sidekiq.org/support) for details.
+
+Thanks
+-----------------
 
-If you have a problem, please review the [FAQ](https://github.com/mperham/sidekiq/wiki/FAQ) and [Troubleshooting](https://github.com/mperham/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages. Searching the issues for your problem is also a good idea.  If that doesn't help, feel free to email the Sidekiq mailing list or open a new issue.
-The mailing list is the preferred place to ask questions on usage. If you are encountering what you think is a bug, please open an issue.
+Sidekiq stays fast by using the [JProfiler java profiler](http://www.ej-technologies.com/products/jprofiler/overview.html) to find and fix
+performance problems on JRuby.  Unfortunately MRI does not have good multithreaded profiling tools.
 
 
 License
@@ -87,4 +104,4 @@ Please see [LICENSE](https://github.com/mperham/sidekiq/blob/master/LICENSE) for
 Author
 -----------------
 
-Mike Perham, [@mperham](https://twitter.com/mperham), [http://mikeperham.com](http://mikeperham.com)
+Mike Perham, [@mperham](https://twitter.com/mperham) / [@sidekiq](https://twitter.com/sidekiq), [http://www.mikeperham.com](http://www.mikeperham.com) / [http://www.contribsys.com](http://www.contribsys.com)

data/Rakefile

@@ -1,9 +1,12 @@
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-  #SO MUCH NOISE
-  #test.warning = true
+  test.warning = true
   test.pattern = 'test/**/test_*.rb'
 end
 
 task :default => :test
+
+task :appraise do
+  exec("cd myapp && rake appraise")
+end

data/bin/sidekiq

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 
+# Quiet some warnings we see when running in warning mode:
+# RUBYOPT=-w bundle exec sidekiq
+$TESTING = false
+
 require_relative '../lib/sidekiq/cli'
 
 begin

data/bin/sidekiqctl

@@ -3,16 +3,32 @@
 require 'fileutils'
 
 class Sidekiqctl
-
-  attr_reader :stage, :pidfile, :timeout
+  DEFAULT_KILL_TIMEOUT = 10
+
+  attr_reader :stage, :pidfile, :kill_timeout
+
+  def self.print_usage
+    puts "#{File.basename($0)} - stop a Sidekiq process from the command line."
+    puts
+    puts "Usage: #{File.basename($0)} <command> <pidfile> <kill_timeout>"
+    puts " where <command> is either 'quiet' or 'stop'"
+    puts "       <pidfile> is path to a pidfile"
+    puts "       <kill_timeout> is number of seconds to wait until Sidekiq exits"
+    puts "       (default: #{Sidekiqctl::DEFAULT_KILL_TIMEOUT}), after which Sidekiq will be KILL'd"
+    puts
+    puts "Be sure to set the kill_timeout LONGER than Sidekiq's -t timeout.  If you want"
+    puts "to wait 60 seconds for jobs to finish, use `sidekiq -t 60` and `sidekiqctl stop"
+    puts " path_to_pidfile 61`"
+    puts
+  end
 
   def initialize(stage, pidfile, timeout)
     @stage = stage
     @pidfile = pidfile
-    @timeout = timeout
+    @kill_timeout = timeout
 
     done('No pidfile given', :error) if !pidfile
-    done("Pidfile #{pidfile} does not exist", :error) if !File.exist?(pidfile)
+    done("Pidfile #{pidfile} does not exist", :warn) if !File.exist?(pidfile)
     done('Invalid pidfile content', :error) if pid == 0
 
     fetch_process
@@ -20,14 +36,18 @@ class Sidekiqctl
     begin
       send(stage)
     rescue NoMethodError
-      done 'Invalid control command', :error
+      done "Invalid command: #{stage}", :error
     end
   end
 
   def fetch_process
-    Process.getpgid(pid)
+    Process.kill(0, pid)
   rescue Errno::ESRCH
     done "Process doesn't exist", :error
+  # We were not allowed to send a signal, but the process must have existed
+  # when Process.kill() was called.
+  rescue Errno::EPERM
+    return pid
   end
 
   def done(msg, error = nil)
@@ -40,7 +60,7 @@ class Sidekiqctl
   end
 
   def pid
-    File.read(pidfile).to_i
+    @pid ||= File.read(pidfile).to_i
   end
 
   def quiet
@@ -49,12 +69,14 @@ class Sidekiqctl
 
   def stop
     `kill -TERM #{pid}`
-    timeout.times do
+    kill_timeout.times do
       begin
-        Process.getpgid(pid)
+        Process.kill(0, pid)
       rescue Errno::ESRCH
         FileUtils.rm_f pidfile
         done 'Sidekiq shut down gracefully.'
+      rescue Errno::EPERM
+        done 'Not permitted to shut down Sidekiq.'
       end
       sleep 1
     end
@@ -62,17 +84,16 @@ class Sidekiqctl
     FileUtils.rm_f pidfile
     done 'Sidekiq shut down forcefully.'
   end
-
-  def shutdown
-    quiet
-    stop
-  end
-
+  alias_method :shutdown, :stop
 end
 
-stage = ARGV[0]
-pidfile = ARGV[1]
-timeout = ARGV[2].to_i
-timeout = 10 if timeout == 0
+if ARGV.length < 2
+  Sidekiqctl.print_usage
+else
+  stage = ARGV[0]
+  pidfile = ARGV[1]
+  timeout = ARGV[2].to_i
+  timeout = Sidekiqctl::DEFAULT_KILL_TIMEOUT if timeout == 0
 
-Sidekiqctl.new(stage, pidfile, timeout)
+  Sidekiqctl.new(stage, pidfile, timeout)
+end

data/bin/sidekiqload

@@ -0,0 +1,154 @@
+#!/usr/bin/env ruby
+
+# Quiet some warnings we see when running in warning mode:
+# RUBYOPT=-w bundle exec sidekiq
+$TESTING = false
+
+#require 'ruby-prof'
+Bundler.require(:default)
+
+require_relative '../lib/sidekiq/cli'
+require_relative '../lib/sidekiq/launcher'
+
+include Sidekiq::Util
+
+Sidekiq.configure_server do |config|
+  #config.options[:concurrency] = 1
+  config.redis = { db: 13 }
+  config.options[:queues] << 'default'
+  config.logger.level = Logger::ERROR
+  config.average_scheduled_poll_interval = 2
+  config.reliable! if defined?(Sidekiq::Pro)
+end
+
+class LoadWorker
+  include Sidekiq::Worker
+  sidekiq_options retry: 1
+  sidekiq_retry_in do |x|
+    1
+  end
+
+  def perform(idx)
+    #raise idx.to_s if idx % 100 == 1
+  end
+end
+
+# brew tap shopify/shopify
+# brew install toxiproxy
+# gem install toxiproxy
+#require 'toxiproxy'
+# simulate a non-localhost network for realer-world conditions.
+# adding 1ms of network latency has an ENORMOUS impact on benchmarks
+#Toxiproxy.populate([{
+    #"name": "redis",
+    #"listen": "127.0.0.1:6380",
+    #"upstream": "127.0.0.1:6379"
+#}])
+
+self_read, self_write = IO.pipe
+%w(INT TERM USR1 USR2 TTIN).each do |sig|
+  begin
+    trap sig do
+      self_write.puts(sig)
+    end
+  rescue ArgumentError
+    puts "Signal #{sig} not supported"
+  end
+end
+
+Sidekiq.redis {|c| c.flushdb}
+def handle_signal(launcher, sig)
+  Sidekiq.logger.debug "Got #{sig} signal"
+  case sig
+  when 'INT'
+    # Handle Ctrl-C in JRuby like MRI
+    # http://jira.codehaus.org/browse/JRUBY-4637
+    raise Interrupt
+  when 'TERM'
+    # Heroku sends TERM and then waits 10 seconds for process to exit.
+    raise Interrupt
+  when 'USR1'
+    Sidekiq.logger.info "Received USR1, no longer accepting new work"
+    launcher.quiet
+  when 'USR2'
+    if Sidekiq.options[:logfile]
+      Sidekiq.logger.info "Received USR2, reopening log file"
+      Sidekiq::Logging.reopen_logs
+    end
+  when 'TTIN'
+    Thread.list.each do |thread|
+      Sidekiq.logger.warn "Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}"
+      if thread.backtrace
+        Sidekiq.logger.warn thread.backtrace.join("\n")
+      else
+        Sidekiq.logger.warn "<no backtrace available>"
+      end
+    end
+  end
+end
+
+def Process.rss
+  `ps -o rss= -p #{Process.pid}`.chomp.to_i
+end
+
+iter = 10
+count = 10_000
+
+iter.times do
+  arr = Array.new(count) do
+    []
+  end
+  count.times do |idx|
+    arr[idx][0] = idx
+  end
+  Sidekiq::Client.push_bulk('class' => LoadWorker, 'args' => arr)
+end
+Sidekiq.logger.error "Created #{count*iter} jobs"
+
+Monitoring = Thread.new do
+  watchdog("monitor thread") do
+    while true
+      sleep 1
+      qsize, retries = Sidekiq.redis do |conn|
+        conn.pipelined do
+          conn.llen "queue:default"
+          conn.zcard "retry"
+        end
+      end.map(&:to_i)
+      total = qsize + retries
+      #GC.start
+      Sidekiq.logger.error("RSS: #{Process.rss} Pending: #{total}")
+      if total == 0
+        Sidekiq.logger.error("Done")
+        exit(0)
+      end
+    end
+  end
+end
+
+begin
+  #RubyProf::exclude_threads = [ Monitoring ]
+  #RubyProf.start
+  fire_event(:startup)
+  #Sidekiq.logger.error "Simulating 1ms of latency between Sidekiq and redis"
+  #Toxiproxy[:redis].downstream(:latency, latency: 1).apply do
+    launcher = Sidekiq::Launcher.new(Sidekiq.options)
+    launcher.run
+
+    while readable_io = IO.select([self_read])
+      signal = readable_io.first[0].gets.strip
+      handle_signal(launcher, signal)
+    end
+  #end
+rescue SystemExit => e
+  #Sidekiq.logger.error("Profiling...")
+  #result = RubyProf.stop
+  #printer = RubyProf::GraphHtmlPrinter.new(result)
+  #printer.print(File.new("output.html", "w"), :min_percent => 1)
+  # normal
+rescue => e
+  raise e if $DEBUG
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/code_of_conduct.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project maintainer at mperham AT gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/