worker_killer 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d3e59b4a8d832b2bb2e7fa013b615962ba339055320fa194a8358cd37047001
-  data.tar.gz: b3d7cd5c9f2b236369e326254d1e80ab3dc922d6a6fe9395c90ac9fdfc460245
+  metadata.gz: dd68e0bf581f102ddbf11561cbafec2dea05b555f8349d9a86ff24aedf7fa682
+  data.tar.gz: 6d7df0e370ec8efc7375b727b99df99e806bdcc3bd28bca342d572a10ea3b80b
 SHA512:
-  metadata.gz: e8d2536fd509599eff5b74f97231e456ffe8dc80ea50cb853b03753d5d93dc4d359e9371a83c8dfe3131487ed8fc5d7f21163de1556bed127cd54cf342694ef7
-  data.tar.gz: a6d69e7e7b37854c4cafddb6a14c4a91c3f3c4a7329882c76e33f5ee19e41133ae1efa4a19ef7f181172cb8a04b8b82c09206211eaf1774bdc1aca3890fa4126
+  metadata.gz: 459b5cbc8c683dde9bd4ad995b4d61bfc1b82fb76c6b602ef84aec5dc0ba0dff8e0ac92eeac99c9a1cacff3d30e6e48a62da3f68c0235cd5aa67dff4f8aad926
+  data.tar.gz: 516c7d461f44f2ce30ef8d0d02421a1765d8e8a56f510d6f8f7b691c259e92dd85bc0166cfd15a9512c2de53ece760a418841b14d666020085331cfc97016bd7

data/.dockerignore

@@ -0,0 +1,20 @@
+*.gem
+log/*
+tmp/*
+doc/*
+envs/*
+coverage/*
+Dockerfile*
+docker-compose*
+/node_modules
+config/keys/*
+config/database.yml
+config/secrets.yml
+vendor/cache
+rspec*
+
+.gitignore
+.gitlab-ci.yml
+
+
+

data/.gitignore

@@ -0,0 +1,124 @@
+#----------------------------------------------------------------------------
+# Ignore these files when commiting to a git repository.
+#
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# The original version of this file is found here:
+# https://github.com/RailsApps/rails-composer/blob/master/files/gitignore.txt
+#
+# Corrections? Improvements? Create a GitHub issue:
+# http://github.com/RailsApps/rails-composer/issues
+#----------------------------------------------------------------------------
+
+# bundler state
+/.bundle
+/vendor/bundle/
+/vendor/ruby/
+vendor/cache
+
+# minimal Rails specific artifacts
+db/*.sqlite3
+db/schema.rb
+/db/*.sqlite3-journal
+/log/*
+/tmp/*
+/swagger/*
+
+
+# add /config/database.yml if it contains passwords
+# /config/database.yml
+
+# various artifacts
+**.war
+*.rbc
+*.sassc
+.redcar/
+.sass-cache
+/config/config.yml
+/coverage.data
+/coverage/
+/db/*.javadb/
+/db/*.sqlite3
+config/database.yml
+config/secrets.yml
+config/app.yml
+config/cable.yml
+config/bunny.yml
+oxymoron.js
+/doc/api/
+/doc/app/
+/doc/features.html
+/doc/specs.html
+/public/cache
+/public/uploads
+/public/stylesheets/compiled
+/public/system/*
+/spec/tmp/*
+/cache
+/capybara*
+/capybara-*.html
+/gems
+/specifications
+rerun.txt
+pickle-email-*.html
+*.sublime-project
+*.sublime-workspace
+.zeus.sock
+.byebug_history
+
+#test
+/docs
+
+
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+#
+# Here are some files you may want to ignore globally:
+
+# scm revert files
+**.orig
+
+# Mac finder artifacts
+.DS_Store
+
+# Netbeans project directory
+/nbproject/
+
+# RubyMine project files
+.idea
+
+# VsCode project files
+.vscode
+*.code-workspace
+
+# Textmate project files
+/*.tmproj
+
+# vim artifacts
+**.swp
+
+# Environment files that may contain sensitive data
+.powenv
+
+# tilde files are usually backup files from a text editor
+*~
+public/assets/
+config/keys
+public/.revision
+storage/*
+spec/reports/
+
+erd-schema.*
+.ruby-gemset
+.ruby-version
+passenger.*.pid.lock
+*.sublime-project
+*.sublime-workspace
+
+/public/packs
+/public/packs-test
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity

data/.rubocop.yml

@@ -0,0 +1,133 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - "storage/**/*"
+
+Layout/TrailingBlankLines:
+  Enabled: true
+  AutoCorrect: true
+  EnforcedStyle: final_blank_line
+
+#Layout/IndentationWidth:
+#  Enabled: true
+
+#Layout/IndentAssignment:
+#  Enabled: false
+#  IndentationWidth: false
+
+#Layout/ElseAlignment:
+#  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: new_line
+
+Layout/RescueEnsureAlignment:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceAroundBlockParameters:
+  EnforcedStyleInsidePipes: no_space
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+#Lint/AssignmentInCondition:
+#  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/LineLength:
+  Max: 100
+  IgnoredPatterns: ['(\A|\s)#']
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 20
+
+Security/YAMLLoad:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/GlobalVars:
+  AllowedVariables: ["$logger", "$root"]
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  AutoCorrect: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  AutoCorrect: true

data/AUTHORS

@@ -0,0 +1 @@
+Samoilenko Yuri <kinnalru _at_ gmail.com>

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014-2019 Рнд Софт
+
+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,49 @@
+# unicorn-worker-killer
+
+[Unicorn](http://unicorn.bogomips.org/) is widely used HTTP-server for Rack applications. One thing we thought Unicorn missed, is killing the Unicorn workers based on the number of requests and consumed memories.
+
+`unicorn-worker-killer` gem provides automatic restart of Unicorn workers based on 1) max number of requests, and 2) process memory size (RSS), without affecting any requests. This will greatly improves site's stability by avoiding unexpected memory exhaustion at the application nodes.
+
+# Install
+
+No external process like `god` is required. Just install one gem: `unicorn-worker-killer`.
+
+    gem 'unicorn-worker-killer'
+
+# Usage
+
+Add these lines to your `config.ru`. (These lines should be added above the `require ::File.expand_path('../config/environment',  __FILE__)` line.
+
+    # Unicorn self-process killer
+    require 'unicorn/worker_killer'
+    
+    # Max requests per worker
+    use Unicorn::WorkerKiller::MaxRequests, 3072, 4096
+    
+    # Max memory size (RSS) per worker
+    use Unicorn::WorkerKiller::Oom, (192*(1024**2)), (256*(1024**2))
+
+This gem provides two modules.
+
+### `Unicorn::WorkerKiller::MaxRequests(max_requests_min=3072, max_requests_max=4096, verbose=false)`
+
+This module automatically restarts the Unicorn workers, based on the number of requests which worker processed.
+
+`max_requests_min` and `max_requests_max` specify the min and max of maximum requests per worker. The actual limit is decided by rand() between `max_requests_min` and `max_requests_max` per worker, to prevent all workers to be dead at the same time. Once the number exceeds the limit, that worker is automatically restarted.
+
+If `verbose` is set to true, then after every request, your log will show the requests left before restart.  This logging is done at the `info` level.
+
+### `Unicorn::WorkerKiller::Oom(memory_limit_min=(1024\*\*3), memory_limit_max=(2\*(1024\*\*3)), check_cycle = 16, verbose = false)`
+
+This module automatically restarts the Unicorn workers, based on its memory size.
+
+`memory_limit_min` and `memory_limit_max` specify the min and max of maximum memory in bytes per worker. The actual limit is decided by rand() between `memory_limit_min` and `memory_limit_max` per worker, to prevent all workers to be dead at the same time.  Once the memory size exceeds `memory_size`, that worker is automatically restarted.
+
+The memory size check is done in every `check_cycle` requests.
+
+If `verbose` is set to true, then every memory size check will be shown in your logs.   This logging is done at the `info` level.
+
+# Special Thanks
+
+- [@hotchpotch](http://github.com/hotchpotch/) for the [original idea](https://gist.github.com/hotchpotch/1258681)
+

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/worker_killer/configuration.rb

@@ -0,0 +1,19 @@
+require 'logger'
+
+module WorkerKiller
+  # Methods for configuring WorkerKiller
+  class Configuration
+
+    attr_accessor :logger, :quit_attempts, :kill_attempts, :use_quit
+
+    # Override defaults for configuration
+    def initialize(quit_attempts: 5, kill_attempts: 10, use_quit: true)
+      @quit_attempts = quit_attempts
+      @kill_attempts = kill_attempts
+      @use_quit = use_quit
+      @logger = Logger.new(STDOUT, level: Logger::INFO, progname: 'WorkerKiller')
+    end
+
+  end
+end
+

data/lib/worker_killer/count_limiter.rb

@@ -0,0 +1,38 @@
+module WorkerKiller
+  class CountLimiter
+
+    attr_reader :min, :max, :limit, :started_at
+
+    def initialize(min: 3072, max: 4096, verbose: false, &block)
+      @min = min
+      @max = max
+      @limit = @min + WorkerKiller.randomize(@max - @min + 1)
+      @left = @limit
+      @verbose = verbose
+      @reaction = block
+    end
+
+    def check
+      return nil if @limit <= 1
+
+      @started_at ||= Time.now
+
+      if @verbose
+        logger.info "#{self}: worker (pid: #{Process.pid}) has #{@left} left before being limited"
+      end
+
+      return false if (@left -= 1) > 0
+
+      logger.warn "#{self}: worker (pid: #{Process.pid}) exceeds max number of requests (limit: #{@limit})"
+      @reaction.call(self)
+
+      true
+    end
+
+    def logger
+      WorkerKiller.configuration.logger
+    end
+
+  end
+end
+

data/lib/worker_killer/memory_limiter.rb

@@ -0,0 +1,46 @@
+require 'get_process_mem'
+
+module WorkerKiller
+  class MemoryLimiter
+
+    attr_reader :min, :max, :limit, :started_at, :check_cycle
+
+    def initialize(min: (1024**3), max: (2 * (1024**3)), check_cycle: 16, verbose: false, &block)
+      @min = min
+      @max = max
+      @limit = @min + WorkerKiller.randomize(@max - @min + 1)
+      @check_cycle = check_cycle
+      @check_count = 0
+      @verbose = verbose
+      @reaction = block
+    end
+
+    def check
+      return nil if @limit <= 1024**2
+
+      @started_at ||= Time.now
+      @check_count += 1
+
+      return false if (@check_count % @check_cycle) != 0
+
+      rss = GetProcessMem.new.bytes
+      if @verbose
+        logger.info "#{self}: worker (pid: #{Process.pid}) using #{rss} bytes(#{rss / 1024 / 1024}mb)."
+      end
+      @check_count = 0
+
+      return false if rss <= @limit
+
+      logger.warn "#{self}: worker (pid: #{Process.pid}) exceeds memory limit (#{rss} bytes > #{@limit} bytes)"
+      @reaction.call(self)
+
+      true
+    end
+
+    def logger
+      WorkerKiller.configuration.logger
+    end
+
+  end
+end
+

data/lib/worker_killer/middleware.rb

@@ -0,0 +1,43 @@
+require 'worker_killer/memory_limiter'
+require 'worker_killer/count_limiter'
+
+module WorkerKiller
+  class Middleware
+
+    def initialize(app, klass:, reaction: nil, **opts)
+      @app = app
+
+      reaction ||= proc do |limiter|
+        WorkerKiller.kill_self(limiter.logger, limiter.started_at)
+      end
+
+      @limiter = klass.new(opts) do |limiter|
+        reaction.call(limiter)
+      end
+    end
+
+    def call(env)
+      response = @app.call(env)
+      @limiter.check
+      response
+    end
+
+    class RequestsLimiter < ::WorkerKiller::Middleware
+
+      def initialize(app, **opts)
+        super(app, klass: ::WorkerKiller::CountLimiter, **opts)
+      end
+
+    end
+
+    class OOMLimiter < ::WorkerKiller::Middleware
+
+      def initialize(app, **opts)
+        super(app, klass: ::WorkerKiller::MemoryLimiter, **opts)
+      end
+
+    end
+
+  end
+end
+

data/lib/worker_killer.rb

@@ -0,0 +1,50 @@
+require 'worker_killer/configuration'
+require 'worker_killer/count_limiter'
+require 'worker_killer/memory_limiter'
+require 'worker_killer/middleware'
+
+module WorkerKiller
+
+  class << self
+
+    attr_accessor :configuration
+
+  end
+
+  def self.configure
+    self.configuration ||= WorkerKiller::Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  self.configure
+
+  def self.randomize(integer)
+    RUBY_VERSION > '1.9' ? Random.rand(integer.abs) : rand(integer)
+  end
+
+  # Kill the current process by telling it to send signals to itself. If
+  # the process isn't killed after `configuration.quit_attempts` QUIT signals,
+  # send TERM signals until `configuration.kill_attempts`. Finally, send a KILL
+  # signal. A single signal is sent per request.
+  def self.kill_self(logger, start_time)
+    alive_sec = (Time.now - start_time).round
+    self_pid = Process.pid
+
+    @kill_attempts ||= 0
+    @kill_attempts += 1
+
+    if configuration.use_quit
+      sig = :QUIT
+      sig = :TERM if @kill_attempts > configuration.quit_attempts
+    else
+      sig = :TERM
+    end
+
+    sig = :KILL if @kill_attempts > configuration.kill_attempts
+
+    logger.warn "#{self} send SIG#{sig} (pid: #{self_pid}) alive: #{alive_sec} sec (trial #{@kill_attempts})"
+    Process.kill sig, self_pid
+  end
+
+end
+

data/worker_killer.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path('lib', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'worker_killer'
+  gem.description = 'Kill any workers by memory and request counts or take custom reaction'
+  gem.homepage    = 'https://github.com/RnD-Soft/worker_killer'
+  gem.summary     = gem.description
+  gem.version     = File.read('VERSION').strip
+  gem.authors     = ['Samoilenko Yuri']
+  gem.email       = ['kinnalru@gmail.com']
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f) }
+  gem.license     = 'MIT'
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'get_process_mem'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec_junit_formatter'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'simplecov-console'
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worker_killer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Samoilenko Yuri
@@ -86,7 +86,22 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rubocop.yml"
+- AUTHORS
+- ChangeLog
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+- lib/worker_killer.rb
+- lib/worker_killer/configuration.rb
+- lib/worker_killer/count_limiter.rb
+- lib/worker_killer/memory_limiter.rb
+- lib/worker_killer/middleware.rb
+- worker_killer.gemspec
 homepage: https://github.com/RnD-Soft/worker_killer
 licenses:
 - MIT
@@ -106,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Kill any workers by memory and request counts or take custom reaction