sidekiq 2.15.1 → 4.2.10

data/lib/sidekiq/launcher.rb

@@ -1,4 +1,5 @@
-require 'sidekiq/actor'
+# encoding: utf-8
+# frozen_string_literal: true
 require 'sidekiq/manager'
 require 'sidekiq/fetch'
 require 'sidekiq/scheduled'
@@ -9,51 +10,164 @@ module Sidekiq
   # If any of these actors die, the Sidekiq process exits
   # immediately.
   class Launcher
-    include Actor
     include Util
 
-    trap_exit :actor_died
-
-    attr_reader :manager, :poller, :fetcher
+    attr_accessor :manager, :poller, :fetcher
 
     def initialize(options)
-      @manager = Sidekiq::Manager.new_link options
-      @poller = Sidekiq::Scheduled::Poller.new_link
-      @fetcher = Sidekiq::Fetcher.new_link @manager, options
-      @manager.fetcher = @fetcher
+      @manager = Sidekiq::Manager.new(options)
+      @poller = Sidekiq::Scheduled::Poller.new
       @done = false
       @options = options
     end
 
-    def actor_died(actor, reason)
-      return if @done
-      Sidekiq.logger.warn("Sidekiq died due to the following error, cannot recover, process exiting")
-      handle_exception(reason)
-      exit(1)
+    def run
+      @thread = safe_thread("heartbeat", &method(:start_heartbeat))
+      @poller.start
+      @manager.start
     end
 
-    def run
-      watchdog('Launcher#run') do
-        manager.async.start
-        poller.async.poll(true)
-      end
+    # Stops this instance from processing any more jobs,
+    #
+    def quiet
+      @done = true
+      @manager.quiet
+      @poller.terminate
     end
 
+    # Shuts down the process.  This method does not
+    # return until all work is complete and cleaned up.
+    # It can take up to the timeout to complete.
     def stop
-      watchdog('Launcher#stop') do
-        @done = true
-        Sidekiq::Fetcher.done!
-        fetcher.async.terminate if fetcher.alive?
-        poller.async.terminate if poller.alive?
-
-        manager.async.stop(:shutdown => true, :timeout => @options[:timeout])
-        manager.wait(:shutdown)
+      deadline = Time.now + @options[:timeout]
+
+      @done = true
+      @manager.quiet
+      @poller.terminate
+
+      @manager.stop(deadline)
+
+      # Requeue everything in case there was a worker who grabbed work while stopped
+      # This call is a no-op in Sidekiq but necessary for Sidekiq Pro.
+      strategy = (@options[:fetch] || Sidekiq::BasicFetch)
+      strategy.bulk_requeue([], @options)
+
+      clear_heartbeat
+    end
+
+    def stopping?
+      @done
+    end
+
+    private unless $TESTING
+
+    JVM_RESERVED_SIGNALS = ['USR1', 'USR2'] # Don't Process#kill if we get these signals via the API
+
+    def heartbeat
+      results = Sidekiq::CLI::PROCTITLES.map {|x| x.(self, to_data) }
+      results.compact!
+      $0 = results.join(' ')
+
+      ❤
+    end
+
+    def ❤
+      key = identity
+      fails = procd = 0
+      begin
+        Processor::FAILURE.update {|curr| fails = curr; 0 }
+        Processor::PROCESSED.update {|curr| procd = curr; 0 }
+
+        workers_key = "#{key}:workers".freeze
+        nowdate = Time.now.utc.strftime("%Y-%m-%d".freeze)
+        Sidekiq.redis do |conn|
+          conn.multi do
+            conn.incrby("stat:processed".freeze, procd)
+            conn.incrby("stat:processed:#{nowdate}", procd)
+            conn.incrby("stat:failed".freeze, fails)
+            conn.incrby("stat:failed:#{nowdate}", fails)
+            conn.del(workers_key)
+            Processor::WORKER_STATE.each_pair do |tid, hash|
+              conn.hset(workers_key, tid, Sidekiq.dump_json(hash))
+            end
+            conn.expire(workers_key, 60)
+          end
+        end
+        fails = procd = 0
+
+        _, exists, _, _, msg = Sidekiq.redis do |conn|
+          conn.multi do
+            conn.sadd('processes', key)
+            conn.exists(key)
+            conn.hmset(key, 'info', to_json, 'busy', Processor::WORKER_STATE.size, 'beat', Time.now.to_f, 'quiet', @done)
+            conn.expire(key, 60)
+            conn.rpop("#{key}-signals")
+          end
+        end
+
+        # first heartbeat or recovering from an outage and need to reestablish our heartbeat
+        fire_event(:heartbeat) if !exists
+
+        return unless msg
+
+        if JVM_RESERVED_SIGNALS.include?(msg)
+          Sidekiq::CLI.instance.handle_signal(msg)
+        else
+          ::Process.kill(msg, $$)
+        end
+      rescue => e
+        # ignore all redis/network issues
+        logger.error("heartbeat: #{e.message}")
+        # don't lose the counts if there was a network issue
+        Processor::PROCESSED.increment(procd)
+        Processor::FAILURE.increment(fails)
+      end
+    end
+
+    def start_heartbeat
+      while true
+        heartbeat
+        sleep 5
       end
+      Sidekiq.logger.info("Heartbeat stopping...")
     end
 
-    def procline(tag)
-      $0 = manager.procline(tag)
-      manager.after(5) { procline(tag) }
+    def to_data
+      @data ||= begin
+        {
+          'hostname' => hostname,
+          'started_at' => Time.now.to_f,
+          'pid' => $$,
+          'tag' => @options[:tag] || '',
+          'concurrency' => @options[:concurrency],
+          'queues' => @options[:queues].uniq,
+          'labels' => @options[:labels],
+          'identity' => identity,
+        }
+      end
+    end
+
+    def to_json
+      @json ||= begin
+        # this data changes infrequently so dump it to a string
+        # now so we don't need to dump it every heartbeat.
+        Sidekiq.dump_json(to_data)
+      end
     end
+
+    def clear_heartbeat
+      # Remove record from Redis since we are shutting down.
+      # Note we don't stop the heartbeat thread; if the process
+      # doesn't actually exit, it'll reappear in the Web UI.
+      Sidekiq.redis do |conn|
+        conn.pipelined do
+          conn.srem('processes', identity)
+          conn.del("#{identity}:workers")
+        end
+      end
+    rescue
+      # best effort, ignore network errors
+    end
+
   end
 end

data/lib/sidekiq/logging.rb

@@ -1,45 +1,102 @@
+# frozen_string_literal: true
 require 'time'
 require 'logger'
+require 'fcntl'
 
 module Sidekiq
   module Logging
 
     class Pretty < Logger::Formatter
+      SPACE = " "
+
       # Provide a call() method that returns the formatted message.
       def call(severity, time, program_name, message)
-        "#{time.utc.iso8601} #{Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{context} #{severity}: #{message}\n"
+        "#{time.utc.iso8601(3)} #{::Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{context} #{severity}: #{message}\n"
       end
 
       def context
         c = Thread.current[:sidekiq_context]
-        c ? " #{c}" : ''
+        " #{c.join(SPACE)}" if c && c.any?
       end
     end
 
-    def self.with_context(msg)
-      begin
-        Thread.current[:sidekiq_context] = msg
-        yield
-      ensure
-        Thread.current[:sidekiq_context] = nil
+    class WithoutTimestamp < Pretty
+      def call(severity, time, program_name, message)
+        "#{::Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{context} #{severity}: #{message}\n"
       end
     end
 
+    def self.with_context(msg)
+      Thread.current[:sidekiq_context] ||= []
+      Thread.current[:sidekiq_context] << msg
+      yield
+    ensure
+      Thread.current[:sidekiq_context].pop
+    end
+
     def self.initialize_logger(log_target = STDOUT)
-      oldlogger = @logger
+      oldlogger = defined?(@logger) ? @logger : nil
       @logger = Logger.new(log_target)
       @logger.level = Logger::INFO
-      @logger.formatter = Pretty.new
+      @logger.formatter = ENV['DYNO'] ? WithoutTimestamp.new : Pretty.new
       oldlogger.close if oldlogger && !$TESTING # don't want to close testing's STDOUT logging
       @logger
     end
 
     def self.logger
-      @logger || initialize_logger
+      defined?(@logger) ? @logger : initialize_logger
     end
 
     def self.logger=(log)
-      @logger = (log ? log : Logger.new('/dev/null'))
+      @logger = (log ? log : Logger.new(File::NULL))
+    end
+
+    # This reopens ALL logfiles in the process that have been rotated
+    # using logrotate(8) (without copytruncate) or similar tools.
+    # A +File+ object is considered for reopening if it is:
+    #   1) opened with the O_APPEND and O_WRONLY flags
+    #   2) the current open file handle does not match its original open path
+    #   3) unbuffered (as far as userspace buffering goes, not O_SYNC)
+    # Returns the number of files reopened
+    def self.reopen_logs
+      to_reopen = []
+      append_flags = File::WRONLY | File::APPEND
+
+      ObjectSpace.each_object(File) do |fp|
+        begin
+          if !fp.closed? && fp.stat.file? && fp.sync && (fp.fcntl(Fcntl::F_GETFL) & append_flags) == append_flags
+            to_reopen << fp
+          end
+        rescue IOError, Errno::EBADF
+        end
+      end
+
+      nr = 0
+      to_reopen.each do |fp|
+        orig_st = begin
+          fp.stat
+        rescue IOError, Errno::EBADF
+          next
+        end
+
+        begin
+          b = File.stat(fp.path)
+          next if orig_st.ino == b.ino && orig_st.dev == b.dev
+        rescue Errno::ENOENT
+        end
+
+        begin
+          File.open(fp.path, 'a') { |tmpfp| fp.reopen(tmpfp) }
+          fp.sync = true
+          nr += 1
+        rescue IOError, Errno::EBADF
+          # not much we can do...
+        end
+      end
+      nr
+    rescue RuntimeError => ex
+      # RuntimeError: ObjectSpace is disabled; each_object will only work with Class, pass -X+O to enable
+      puts "Unable to reopen logs: #{ex.message}"
     end
 
     def logger

data/lib/sidekiq/manager.rb

@@ -1,188 +1,138 @@
+# encoding: utf-8
+# frozen_string_literal: true
 require 'sidekiq/util'
-require 'sidekiq/actor'
 require 'sidekiq/processor'
 require 'sidekiq/fetch'
+require 'thread'
+require 'set'
 
 module Sidekiq
 
   ##
-  # The main router in the system.  This
-  # manages the processor state and accepts messages
-  # from Redis to be dispatched to an idle processor.
+  # The Manager is the central coordination point in Sidekiq, controlling
+  # the lifecycle of the Processors.
+  #
+  # Tasks:
+  #
+  # 1. start: Spin up Processors.
+  # 3. processor_died: Handle job failure, throw away Processor, create new one.
+  # 4. quiet: shutdown idle Processors.
+  # 5. stop: hard stop the Processors by deadline.
+  #
+  # Note that only the last task requires its own Thread since it has to monitor
+  # the shutdown process.  The other tasks are performed by other threads.
   #
   class Manager
     include Util
-    include Actor
-    trap_exit :processor_died
 
-    attr_reader :ready
-    attr_reader :busy
-    attr_accessor :fetcher
+    attr_reader :workers
+    attr_reader :options
 
     def initialize(options={})
       logger.debug { options.inspect }
+      @options = options
       @count = options[:concurrency] || 25
-      @done_callback = nil
+      raise ArgumentError, "Concurrency of #{@count} is not supported" if @count < 1
 
-      @in_progress = {}
-      @threads = {}
       @done = false
-      @busy = []
-      @ready = @count.times.map do
-        p = Processor.new_link(current_actor)
-        p.proxy_id = p.object_id
-        p
+      @workers = Set.new
+      @count.times do
+        @workers << Processor.new(self)
       end
+      @plock = Mutex.new
     end
 
-    def stop(options={})
-      watchdog('Manager#stop died') do
-        shutdown = options[:shutdown]
-        timeout = options[:timeout]
-
-        @done = true
-
-        logger.info { "Shutting down #{@ready.size} quiet workers" }
-        @ready.each { |x| x.terminate if x.alive? }
-        @ready.clear
-
-        clear_worker_set
-
-        return after(0) { signal(:shutdown) } if @busy.empty?
-        hard_shutdown_in timeout if shutdown
+    def start
+      @workers.each do |x|
+        x.start
       end
     end
 
-    def start
-      @ready.each { dispatch }
-    end
+    def quiet
+      return if @done
+      @done = true
 
-    def when_done(&blk)
-      @done_callback = blk
+      logger.info { "Terminating quiet workers" }
+      @workers.each { |x| x.terminate }
+      fire_event(:quiet, true)
     end
 
-    def processor_done(processor)
-      watchdog('Manager#processor_done died') do
-        @done_callback.call(processor) if @done_callback
-        @in_progress.delete(processor.object_id)
-        @threads.delete(processor.object_id)
-        @busy.delete(processor)
-        if stopped?
-          processor.terminate if processor.alive?
-          signal(:shutdown) if @busy.empty?
-        else
-          @ready << processor if processor.alive?
-        end
-        dispatch
+    # hack for quicker development / testing environment #2774
+    PAUSE_TIME = STDOUT.tty? ? 0.1 : 0.5
+
+    def stop(deadline)
+      quiet
+      fire_event(:shutdown, true)
+
+      # some of the shutdown events can be async,
+      # we don't have any way to know when they're done but
+      # give them a little time to take effect
+      sleep PAUSE_TIME
+      return if @workers.empty?
+
+      logger.info { "Pausing to allow workers to finish..." }
+      remaining = deadline - Time.now
+      while remaining > PAUSE_TIME
+        return if @workers.empty?
+        sleep PAUSE_TIME
+        remaining = deadline - Time.now
       end
+      return if @workers.empty?
+
+      hard_shutdown
     end
 
-    def processor_died(processor, reason)
-      watchdog("Manager#processor_died died") do
-        @in_progress.delete(processor.object_id)
-        @threads.delete(processor.object_id)
-        @busy.delete(processor)
-
-        unless stopped?
-          p = Processor.new_link(current_actor)
-          p.proxy_id = p.object_id
-          @ready << p
-          dispatch
-        else
-          signal(:shutdown) if @busy.empty?
-        end
+    def processor_stopped(processor)
+      @plock.synchronize do
+        @workers.delete(processor)
       end
     end
 
-    def assign(work)
-      watchdog("Manager#assign died") do
-        if stopped?
-          # Race condition between Manager#stop if Fetcher
-          # is blocked on redis and gets a message after
-          # all the ready Processors have been stopped.
-          # Push the message back to redis.
-          work.requeue
-        else
-          processor = @ready.pop
-          @in_progress[processor.object_id] = work
-          @busy << processor
-          processor.async.process(work)
+    def processor_died(processor, reason)
+      @plock.synchronize do
+        @workers.delete(processor)
+        unless @done
+          p = Processor.new(self)
+          @workers << p
+          p.start
         end
       end
     end
 
-    # A hack worthy of Rube Goldberg.  We need to be able
-    # to hard stop a working thread.  But there's no way for us to
-    # get handle to the underlying thread performing work for a processor
-    # so we have it call us and tell us.
-    def real_thread(proxy_id, thr)
-      @threads[proxy_id] = thr
-    end
-
-    def procline(tag)
-      "sidekiq #{Sidekiq::VERSION} #{tag}[#{@busy.size} of #{@count} busy]#{stopped? ? ' stopping' : ''}"
+    def stopped?
+      @done
     end
 
     private
 
-    def clear_worker_set
-      # Clearing workers in Redis
-      # NOTE: we do this before terminating worker threads because the
-      # process will likely receive a hard shutdown soon anyway, which
-      # means the threads will killed.
-      logger.debug { "Clearing workers in redis" }
-      Sidekiq.redis do |conn|
-        workers = conn.smembers('workers')
-        workers_to_remove = workers.select do |worker_name|
-          worker_name =~ /:#{process_id}-/
-        end
-        conn.srem('workers', workers_to_remove) if !workers_to_remove.empty?
+    def hard_shutdown
+      # We've reached the timeout and we still have busy workers.
+      # They must die but their jobs shall live on.
+      cleanup = nil
+      @plock.synchronize do
+        cleanup = @workers.dup
       end
-    rescue => ex
-      Sidekiq.logger.warn("Unable to clear worker set while shutting down: #{ex.message}")
-    end
 
-    def hard_shutdown_in(delay)
-      logger.info { "Pausing up to #{delay} seconds to allow workers to finish..." }
-
-      after(delay) do
-        watchdog("Manager#hard_shutdown_in died") do
-          # We've reached the timeout and we still have busy workers.
-          # They must die but their messages shall live on.
-          logger.info("Still waiting for #{@busy.size} busy workers")
-
-          # Re-enqueue terminated jobs
-          # NOTE: You may notice that we may push a job back to redis before
-          # the worker thread is terminated. This is ok because Sidekiq's
-          # contract says that jobs are run AT LEAST once. Process termination
-          # is delayed until we're certain the jobs are back in Redis because
-          # it is worse to lose a job than to run it twice.
-          Sidekiq::Fetcher.strategy.bulk_requeue(@in_progress.values)
-
-          logger.debug { "Terminating #{@busy.size} busy worker threads" }
-          @busy.each do |processor|
-            if processor.alive? && t = @threads.delete(processor.object_id)
-              t.raise Shutdown
-            end
-          end
-
-          after(0) { signal(:shutdown) }
-        end
-      end
-    end
+      if cleanup.size > 0
+        jobs = cleanup.map {|p| p.job }.compact
 
-    def dispatch
-      return if stopped?
-      # This is a safety check to ensure we haven't leaked
-      # processors somehow.
-      raise "BUG: No processors, cannot continue!" if @ready.empty? && @busy.empty?
-      raise "No ready processor!?" if @ready.empty?
+        logger.warn { "Terminating #{cleanup.size} busy worker threads" }
+        logger.warn { "Work still in progress #{jobs.inspect}" }
 
-      @fetcher.async.fetch
-    end
+        # Re-enqueue unfinished jobs
+        # NOTE: You may notice that we may push a job back to redis before
+        # the worker thread is terminated. This is ok because Sidekiq's
+        # contract says that jobs are run AT LEAST once. Process termination
+        # is delayed until we're certain the jobs are back in Redis because
+        # it is worse to lose a job than to run it twice.
+        strategy = (@options[:fetch] || Sidekiq::BasicFetch)
+        strategy.bulk_requeue(jobs, @options)
+      end
 
-    def stopped?
-      @done
+      cleanup.each do |processor|
+        processor.kill
+      end
     end
+
   end
 end