sidekiq-pool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69b664da7b6e3f336f809887dc3f99a997c40faf
+  data.tar.gz: 17673028467d9cbdb6d1b4ce99813d42b8ab6470
+SHA512:
+  metadata.gz: 1de8801d8ea2cc4493dca8b8e2649bfc03c87d9535f5fff17c6c8b689d9e86f1d24f8be202e883d39a79fc819f01a722072402791c93c7792ae3a1e31d69ba00
+  data.tar.gz: 4745c45574e730406e280c14c2d7273a87eef5c245364144ca77d889e19807c65250998949cca5354f716d0234cfc52278a04220ca97171e1fb9b7d5d58bf0b0

data/.gitignore

@@ -0,0 +1,10 @@
+/.ruby-version
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-pool.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Laurynas Butkus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Sidekiq::Pool
+
+Allows using more CPU cores with Sidekiq on Ruby MRI by forking multiple processes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-pool'
+```
+
+## Usage
+
+Help
+
+    $ bundle exec sidekiq-pool -h
+
+Start pool with 3 instances
+
+    $ bundle exec sidekiq-pool --pool-size 3 
+
+## Signals
+
+Signals `USR1`, `USR2` are forwarded to the children.
+ 
+`TTIN` forks new child 
+    
+    $ kill -TTIN masterpid
+    
+`TTOU` kills one child
+    
+    $ kill -TTOU masterpid
+    
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/laurynas/sidekiq-pool.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/sidekiq-pool

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# Quiet some warnings we see when running in warning mode:
+# RUBYOPT=-w bundle exec sidekiq-pool
+$TESTING = false
+
+require_relative '../lib/sidekiq/pool/cli'
+
+begin
+  cli = Sidekiq::Pool::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

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/

data/lib/sidekiq/pool.rb

@@ -0,0 +1,7 @@
+require 'sidekiq/pool/version'
+require 'sidekiq/pool/cli'
+
+module Sidekiq
+  module Pool
+  end
+end

data/lib/sidekiq/pool/cli.rb

@@ -0,0 +1,185 @@
+require 'sidekiq/cli'
+
+module Sidekiq
+  module Pool
+    class CLI < Sidekiq::CLI
+      def initialize
+        @child_index = 0
+        @pool = []
+        super
+      end
+
+      alias_method :run_child, :run
+
+      def run
+        raise ArgumentError, 'Please specify pool size' unless @pool_size
+
+        self_read, self_write = IO.pipe
+
+        %w(INT TERM USR1 USR2 TTIN TTOU CLD).each do |sig|
+          begin
+            trap sig do
+              self_write.puts(sig)
+            end
+          rescue ArgumentError
+            puts "Signal #{sig} not supported"
+          end
+        end
+
+        logger.info "Starting pool with #{@pool_size} instances"
+
+        @pool_size.times { fork_child }
+
+        while readable_io = IO.select([self_read])
+          signal = readable_io.first[0].gets.strip
+          handle_master_signal(signal)
+        end
+      end
+
+      private
+
+      def parse_options(argv)
+        opts = {}
+
+        @parser = OptionParser.new do |o|
+          o.on '--pool-size INT', "pool size" do |arg|
+            @pool_size = Integer(arg)
+          end
+
+          o.on '-c', '--concurrency INT', "processor threads to use" do |arg|
+            opts[:concurrency] = Integer(arg)
+          end
+
+          o.on '-d', '--daemon', "Daemonize process" do |arg|
+            opts[:daemon] = arg
+          end
+
+          o.on '-e', '--environment ENV', "Application environment" do |arg|
+            opts[:environment] = arg
+          end
+
+          o.on '-g', '--tag TAG', "Process tag for procline" do |arg|
+            opts[:tag] = arg
+          end
+
+          o.on "-q", "--queue QUEUE[,WEIGHT]", "Queues to process with optional weights" do |arg|
+            queue, weight = arg.split(",")
+            parse_queue opts, queue, weight
+          end
+
+          o.on '-r', '--require [PATH|DIR]', "Location of Rails application with workers or file to require" do |arg|
+            opts[:require] = arg
+          end
+
+          o.on '-t', '--timeout NUM', "Shutdown timeout" do |arg|
+            opts[:timeout] = Integer(arg)
+          end
+
+          o.on "-v", "--verbose", "Print more verbose output" do |arg|
+            opts[:verbose] = arg
+          end
+
+          o.on '-C', '--config PATH', "path to YAML config file" do |arg|
+            opts[:config_file] = arg
+          end
+
+          o.on '-L', '--logfile PATH', "path to writable logfile" do |arg|
+            opts[:logfile] = arg
+          end
+
+          o.on '-P', '--pidfile PATH', "path to pidfile" do |arg|
+            opts[:pidfile] = arg
+          end
+
+          o.on '-V', '--version', "Print version and exit" do |arg|
+            puts "Sidekiq #{Sidekiq::VERSION}"
+            die(0)
+          end
+        end
+
+        @parser.banner = 'sidekiq-pool [options]'
+        @parser.on_tail '-h', '--help', 'Show help' do
+          logger.info @parser
+          die 1
+        end
+        @parser.parse!(argv)
+
+        %w[config/sidekiq.yml config/sidekiq.yml.erb].each do |filename|
+          opts[:config_file] ||= filename if File.exist?(filename)
+        end
+
+        opts
+      end
+
+      def handle_master_signal(sig)
+        case sig
+        when 'INT', 'TERM'
+          signal_to_pool(sig)
+          wait_and_exit
+        when 'TTIN'
+          logger.info 'Adding child'
+          fork_child
+        when 'TTOU'
+          remove_child
+        when 'CLD'
+          check_pool
+        else
+          signal_to_pool(sig)
+        end
+      end
+
+      def fork_child
+        @pool << fork do
+          options[:index] = @child_index++
+          run_child
+        end
+      end
+
+      def remove_child
+        return if @pool.empty?
+
+        if @pool.size == 1
+          logger.info 'Cowardly refusing to kill the last child'
+          return
+        end
+
+        logger.info 'Removing child'
+        ::Process.kill('TERM', @pool.pop)
+      end
+
+      def signal_to_pool(sig)
+        logger.info "Sending #{sig} signal to the pool"
+        @pool.each { |pid| ::Process.kill(sig, pid) }
+      end
+
+      def check_pool
+        @pool.each do |pid|
+          next if alive?(pid)
+          handle_dead_child(pid)
+        end
+      end
+
+      def handle_dead_child(pid)
+        logger.info "Child #{pid} died"
+        @pool.delete(pid)
+      end
+
+      def alive?(pid)
+        ::Process.getpgid(pid)
+        true
+      rescue Errno::ESRCH
+        false
+      end
+
+      def wait_and_exit
+        loop do
+          break if @pool.none? { |pid| alive?(pid) }
+          sleep(0.1)
+        end
+
+        logger.info 'Bye!'
+        exit(0)
+      end
+    end
+  end
+end

data/lib/sidekiq/pool/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Pool
+    VERSION = '0.1.0'
+  end
+end

data/sidekiq-pool.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/pool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-pool'
+  spec.version       = Sidekiq::Pool::VERSION
+  spec.authors       = ['Laurynas Butkus']
+  spec.email         = ['laurynas.butkus@gmail.com']
+
+  spec.summary       = %q{Forks and manages multiple Sidekiq processes}
+  spec.description   = %q{Allows using more CPU cores with Sidekiq on Ruby MRI by forking multiple processes.}
+  spec.homepage      = 'https://github.com/laurynas/sidekiq-pool'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['sidekiq-pool']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sidekiq', '~> 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-pool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laurynas Butkus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Allows using more CPU cores with Sidekiq on Ruby MRI by forking multiple
+  processes.
+email:
+- laurynas.butkus@gmail.com
+executables:
+- sidekiq-pool
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sidekiq-pool
+- code_of_conduct.md
+- lib/sidekiq/pool.rb
+- lib/sidekiq/pool/cli.rb
+- lib/sidekiq/pool/version.rb
+- sidekiq-pool.gemspec
+homepage: https://github.com/laurynas/sidekiq-pool
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Forks and manages multiple Sidekiq processes
+test_files: []