sidekiq-runner 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b7fa70811b720ebc2ab7a34f674df39ce1f2816
-  data.tar.gz: 61bbd1e7ba1e5b094f0b0b4dd3b9b8f2cef8cde9
+SHA256:
+  metadata.gz: c8918e2e7486207c0a59ae645ec003d7ce1de255ba8e60e48ae9265e3db829b9
+  data.tar.gz: 7931bf1755ef7b945443ea9a6b9c73199e88b3ad5d05e0975baf9b4cd7798480
 SHA512:
-  metadata.gz: 1e15d46d709d85d15832e1595a0601ffc77c7cc60b71dda140a5d92fa9d2644252c46f84e04e594f9880799f6680a9c0b68b00ba5455c5370479eaa6de1a6f7d
-  data.tar.gz: 9728647c72592024dba383849ded7f4ed3dc658ceb28cb09b944a7926f9314d0518422441b06a12e7dcb3690b009ec2363b546bb6ec746bf5d5c1edbaa29e211
+  metadata.gz: cf8d8f5617fa3eea88088bc14202ccb52a252e4c2e2ba9b7c53c455a9b6929e2218668e5a1b1790c2af42246dae8572b942a65ea645b242a8b53fede15fbad99
+  data.tar.gz: 861b4a172a2c35d738e12b178b9550b9df09d927cf1772a1a3866fc6564ba162d3aad5cb3337a5e21742e86ad417b6d97df2c5991c015031a1db8c41e7622204

data/lib/sidekiq-runner.rb

@@ -17,7 +17,7 @@ module SidekiqRunner
 
     abort 'God is already running.' if god_alive?(god_config)
 
-    run(:start, sidekiq_config) do
+    run(:start, sidekiq_config, god_config) do
       $0 = "SidekiqRunner/God (#{god_config.process_name})"
 
       puts 'Starting god.'
@@ -31,7 +31,7 @@ module SidekiqRunner
   def self.stop
     sidekiq_config, god_config = SidekiqConfiguration.get, GodConfiguration.get
 
-    run(:stop, sidekiq_config) do
+    run(:stop, sidekiq_config, god_config) do
       God::EventHandler.load
 
       if god_alive?(god_config)
@@ -48,6 +48,17 @@ module SidekiqRunner
     end
   end
 
+  def self.restart(sidekiq_instances: [])
+    sidekiq_config = SidekiqConfiguration.get
+    god_config = GodConfiguration.get
+
+    return unless god_alive?(god_config)
+
+    sidekiq_config.each_key do |name|
+      God::CLI::Command.new('restart', god_config.options, ['', name]) if sidekiq_instances.empty? || sidekiq_instances.include?(name.to_sym)
+    end
+  end
+
   def self.running?
     god_alive? GodConfiguration.get
   end
@@ -69,7 +80,7 @@ module SidekiqRunner
     true
   end
 
-  def self.run(action, sidekiq_config)
+  def self.run(action, sidekiq_config, god_config)
     begin
 
       # Use this flag to actually load all of the god infrastructure.
@@ -77,16 +88,21 @@ module SidekiqRunner
       require 'god'
       require 'god/cli/run'
 
+      if [:start, :stop].include? action
+        cb = god_config.send("before_#{action}_cb".to_sym)
+        cb.call if cb
+      end
+
       # Peform the action.
       yield if block_given?
 
     rescue SystemExit => e
-      cb = e.success? ? "#{action}_success_cb" : "#{action}_error_cb"
+      sidekiq_cb = e.success? ? "#{action}_success_cb" : "#{action}_error_cb"
     ensure
       if [:start, :stop].include? action
-        cb = "#{action}_success_cb" unless cb
-        cb = sidekiq_config.send(cb.to_sym)
-        cb.call if cb
+        sidekiq_cb = "#{action}_success_cb" unless sidekiq_cb
+        sidekiq_cb = sidekiq_config.send(sidekiq_cb.to_sym)
+        sidekiq_cb.call if sidekiq_cb
       end
     end
   end

data/lib/sidekiq-runner/god_configuration.rb

@@ -15,13 +15,16 @@ module SidekiqRunner
     RUNNER_ATTRIBUTES = [:config_file, :daemonize, :port, :syslog, :events]
     RUNNER_ATTRIBUTES.each { |att| attr_accessor att }
 
-    CONFIG_FILE_ATTRIBUTES = [:process_name, :interval, :stop_timeout, :log_file]
+    CONFIG_FILE_ATTRIBUTES = [:process_name, :interval, :stop_timeout, :log_file, :log_level, :maximum_memory_usage, :pid]
     CONFIG_FILE_ATTRIBUTES.each { |att| attr_accessor att }
 
+    attr_reader :generic_watchers
+
     def initialize
       @process_name = 'sidekiq'
       @interval  = 30
       @stop_timeout = 30
+      @maximum_memory_usage = nil
 
       @log_file   = File.join(Dir.pwd, 'log', 'god.log')
       @config_file  = File.join(Dir.pwd, 'config', 'god.yml')
@@ -29,10 +32,18 @@ module SidekiqRunner
       @daemonize = true
       @syslog = true
       @events = true
+      @pid = nil
+      @log_level = :warn
 
-      # This is going to be a part of the .sock file name e.g. "/tmp/god.17165.sock"
+      # This is going to be a part of the .sock file name e.g. "/tmp/god.17165.sock" and the pidfile name
       # Change this in the configuration file to be able to run multiple instances of god.
       @port = 17165
+
+      @generic_watchers = []
+    end
+
+    def add_generic(&blk)
+      @generic_watchers << blk
     end
 
     def options
@@ -44,7 +55,9 @@ module SidekiqRunner
         syslog: @syslog,
         events: @events,
         config: File.expand_path("../sidekiq.god", __FILE__),
-        log: @log_file
+        log: @log_file,
+        pid: @pid,
+        log_level: @log_level
       }
     end
 
@@ -59,7 +72,15 @@ module SidekiqRunner
     end
 
     def create_directories!
-      FileUtils.mkdir_p(File.dirname(log_file))
+      FileUtils.mkdir_p(File.dirname(log_file)) if log_file
+    end
+
+    %w(start stop).each do |action|
+      attr_reader "before_#{action}_cb".to_sym
+
+      define_method("before_#{action}") do |&block|
+        instance_variable_set("@before_#{action}_cb".to_sym, block)
+      end
     end
   end
 end

data/lib/sidekiq-runner/sidekiq.god

@@ -6,6 +6,12 @@ god_config = SidekiqRunner::GodConfiguration.get
 
 God.terminate_timeout = god_config.stop_timeout + 10
 
+god_config.generic_watchers.each do |block|
+  God.watch do |w|
+    block.call(w)
+  end
+end
+
 sidekiq_config.each do |name, skiq|
   God.watch do |w|
     w.name = name
@@ -13,13 +19,15 @@ sidekiq_config.each do |name, skiq|
     # Set start command.
     w.start = skiq.build_start_command
 
+    # Set logfile
+    w.log = skiq.logfile
+
     # Set stop command.
-    w.stop = skiq.build_stop_command(god_config.stop_timeout)
     w.stop_timeout = god_config.stop_timeout
 
-    # Make sure the pidfile is deleted as sidekiqctl does not delete stale pidfiles.
-    w.pid_file = skiq.pidfile
-    w.behavior(:clean_pid_file)
+    # Set uid/gid if requested.
+    w.uid = skiq.uid if skiq.uid
+    w.gid = skiq.gid if skiq.gid
 
     # Working directory has to be set properly.
     # Be aware that by default, God sets the working directory to / (root dir).
@@ -61,6 +69,21 @@ sidekiq_config.each do |name, skiq|
       end
     end
 
+    # Monitor process memory usage.
+    if god_config.maximum_memory_usage
+      w.restart_if do |restart|
+        restart.condition(:memory_usage) do |c|
+          c.above = god_config.maximum_memory_usage.to_i.megabytes
+          c.times = 3
+          c.interval = god_config.interval
+        end
+      end
+    end
+
+    if skiq.config_blocks.length > 0
+      skiq.config_blocks.each { |blk| blk.call(w) }
+    end
+
     w.lifecycle do |on|
       on.condition(:flapping) do |c|
         c.to_state = [:start, :restart] # If this watch is started or restarted...

data/lib/sidekiq-runner/sidekiq_configuration.rb

@@ -12,7 +12,7 @@ module SidekiqRunner
     def initialize
       @config_file =
         if defined?(Rails)
-          File.join(Rails.root, 'config', 'sidekiq.yml')  
+          File.join(Rails.root, 'config', 'sidekiq.yml')
         else
           File.join(Dir.pwd, 'config', 'sidekiq.yml')
         end
@@ -86,8 +86,6 @@ module SidekiqRunner
     end
 
     def merge_config_file!
-      sidekiqs_common_config = {}
-
       yml = File.exist?(config_file) ? YAML.load_file(config_file) : {}
       yml = Hash[yml.map { |k, v| [k.to_sym, v] }]
 
@@ -96,8 +94,6 @@ module SidekiqRunner
 
     def sane?
       fail 'No sidekiq instances defined. Nothing to run.' if @sidekiqs.empty?
-      fail 'Sidekiq instances with the same pidfile found.' if @sidekiqs.values.map(&:pidfile).uniq.size < @sidekiqs.size
-      fail 'Sidekiq instances with the same logfile found.' if @sidekiqs.values.map(&:logfile).uniq.size < @sidekiqs.size
 
       @sidekiqs.each_value { |skiq| skiq.sane? }
     end

data/lib/sidekiq-runner/sidekiq_instance.rb

@@ -1,16 +1,15 @@
 module SidekiqRunner
   class SidekiqInstance
-
     RUNNER_ATTRIBUTES = [:bundle_env, :chdir, :requirefile]
     RUNNER_ATTRIBUTES.each { |att| attr_accessor att }
 
-    CONFIG_FILE_ATTRIBUTES = [:concurrency, :verbose, :pidfile, :logfile, :tag]
+    CONFIG_FILE_ATTRIBUTES = [:concurrency, :verbose, :pidfile, :logfile, :tag, :rbtrace, :uid, :gid]
     CONFIG_FILE_ATTRIBUTES.each { |att| attr_accessor att }
 
-    attr_reader :name, :queues
+    attr_reader :name, :queues, :config_blocks
 
     def initialize(name)
-      fail "No sidekiq instance name given!" if name.empty?
+      raise "No sidekiq instance name given!" if name.empty?
 
       @name = name
       @queues = []
@@ -23,15 +22,24 @@ module SidekiqRunner
       @concurrency  = 4
       @verbose      = false
       @tag          = name
+      @rbtrace      = false
+      @uid          = nil
+      @gid          = nil
+      @config_blocks = []
     end
 
     def add_queue(queue_name, weight = 1)
-      fail "Cannot add the queue. The name is empty!" if queue_name.empty?
-      fail "Cannot add the queue. The weight is not an integer!" unless weight.is_a? Integer
-      fail "Cannot add the queue. The queue with \"#{queue_name}\" name already exist" if @queues.any? { |q| q.first == queue_name }
+      raise "Cannot add the queue. The name is empty!" if queue_name.empty?
+      raise "Cannot add the queue. The weight is not an integer!" unless weight.is_a? Integer
+      raise "Cannot add the queue. The queue with \"#{queue_name}\" name already exist" if @queues.any? { |q| q.first == queue_name }
+
       @queues << [queue_name, weight]
     end
 
+    def god_config(&block)
+      @config_blocks << block
+    end
+
     def merge_config_file!(yml)
       # Get global configuration options.
       SidekiqInstance::CONFIG_FILE_ATTRIBUTES.each do |k|
@@ -39,7 +47,7 @@ module SidekiqRunner
       end
 
       # Override with instance-specific options.
-      if (syml = yml[@name.to_sym]) && (syml.is_a?(Hash))
+      if (syml = yml[@name.to_sym]) && syml.is_a?(Hash)
         syml = Hash[syml.map { |k, v| [k.to_sym, v] }]
 
         SidekiqInstance::CONFIG_FILE_ATTRIBUTES.each do |k|
@@ -49,41 +57,30 @@ module SidekiqRunner
     end
 
     def sane?
-      fail "No queues given for #{@name}!" if @queues.empty?  
-      fail "No requirefile given for #{@name} and not in Rails environment!" if !defined?(Rails) && !requirefile
+      raise "No queues given for #{@name}!" if @queues.empty?
+      raise "No requirefile given for #{@name} and not in Rails environment!" if !defined?(Rails) && !requirefile
     end
 
     def build_start_command
       create_directories!
 
       cmd = []
-      cmd << (bundle_env ? 'bundle exec sidekiq' : 'sidekiq')
-      cmd << '-d'
+      cmd << 'bundle exec' if bundle_env
+      cmd << (rbtrace ? File.expand_path('../../script/sidekiq_rbtrace', __dir__) : 'sidekiq')
       cmd << "-c #{concurrency}"
       cmd << '-v' if verbose
-      cmd << "-L #{logfile}"
       cmd << "-P #{pidfile}"
       cmd << "-e #{Rails.env}" if defined?(Rails)
       cmd << "-r #{requirefile}" if requirefile
       cmd << "-g '#{tag}'"
 
       queues.each do |q, w|
-        cmd << "-q #{q},#{w.to_s}"
+        cmd << "-q #{q},#{w}"
       end
 
       cmd.join(' ')
     end
 
-    def build_stop_command(timeout)
-      cmd = []
-      cmd << (bundle_env ? 'bundle exec sidekiqctl' : 'sidekiqctl')
-      cmd << 'stop'
-      cmd << pidfile
-      cmd << timeout
-
-      cmd.join(' ')
-    end
-
     private
 
     def create_directories!

data/lib/sidekiq-runner/version.rb

@@ -1,3 +1,3 @@
 module SidekiqRunner
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/script/sidekiq_rbtrace

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rbtrace'
+
+def sidekiq_bin
+  require 'sidekiq/cli'
+
+  begin
+    cli = Sidekiq::CLI.instance
+    cli.parse
+    cli.run
+  rescue => e
+    raise e if $DEBUG
+    STDERR.puts e.message
+    STDERR.puts e.backtrace.join("\n")
+    exit 1
+  end
+end
+
+sidekiq = `which sidekiq` rescue ''
+if sidekiq.empty?
+  # When we can't locate the Sidekiq executable, mimick
+  # its behaviour here.
+  sidekiq_bin
+else
+  begin
+    # Otherwise load the sidekiq executable.
+    load sidekiq.strip
+  rescue
+    sidekiq_bin
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-runner
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - FlavourSys Technology GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: god
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Provide an easy way to configure, start, and monitor all your Sidekiq
   processes
 email: technology@flavoursys.com
@@ -52,6 +66,7 @@ files:
 - lib/sidekiq-runner/sidekiq_instance.rb
 - lib/sidekiq-runner/tasks.rb
 - lib/sidekiq-runner/version.rb
+- script/sidekiq_rbtrace
 homepage: https://github.com/FlavourSys/sidekiq-runner
 licenses:
 - MIT
@@ -72,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Sidekiq configuration and rake tasks