resque-worker-killer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9828594da6a4652add1a03fcd46ad5b3f3e06c68
+  data.tar.gz: d31927afb2293274a0755de5047821fb5c99cb87
+SHA512:
+  metadata.gz: 0d5c4fa9aebe743de6fd326ebc9e5b7491c7a79bc4fd438c5ac69cd101ddb8d59887ea1b5220a7f4424a021be808c2d4c3ee5c9e975b16c1b261ec771851e727
+  data.tar.gz: 9da4c88ed48f8a63f05e6b51938258b187192a756fe95a9be4f34da4d831f2d73b02b9f5441bf91b8d9a4ad2fd5846997550523564b0540ecd7179fd1a8265db

data/.gitignore

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2016/08/20)
+
+First vesion

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# 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 a project maintainer at sonots@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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-worker-killer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Naotoshi Seo
+
+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,77 @@
+# Resque::Worker::Killer
+
+[Resque](https://github.com/resque/resque) is widely used Redis-backed Ruby library for creating background jobs. One thing we thought Resque missed, is killing a forked child of Resque worker based on consumed memories.
+
+resque-worker-killer gem provides automatic kill of a forked child of Resque worker based on process memory size (RSS) not to exceed the maximum allowed memory size.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-worker-killer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-worker-killer
+
+## Usage
+
+Use the plugin:
+
+```ruby
+require 'resque'
+require 'resque-worker-killer'
+
+class MyJob
+  extend Resque::Plugins::WorkerKiller
+  @queue = :example_queue
+
+  extend Resque::Plugins::WorkerKiller
+  @worker_killer_monitor_interval = 0.5 # sec
+  @worker_killer_mem_limit = 300_000 # KB
+  @worker_killer_max_term = 10 # try TERM 10 times, then KILL
+  @worker_killer_verbose = false # verbose log
+  @worker_killer_logger = Resque.logger
+
+  def self.perform(*args)
+    puts 'started'
+    sleep 10
+    puts 'finished'
+  rescue Resque::TermException => e # env TERM_CHILD=1
+    puts 'terminated'
+  end
+end
+```
+
+`TERM_CHILD` environment variable must be set on starting resque worker:
+
+```
+$ TERM_CHILD=1 bundle exec rake resque:work
+```
+
+Options are:
+
+* `@worker_killer_monitor_interval`: Monotring interval to check RSS size (default: 1.0 sec)
+* `@worker_killer_mem_limit`: RSS usage limit, in killobytes (default: 300MB)
+* `@worker_killer_max_term`: Try kiling child process with SIGTERM in `@worker_killer_max_term` times (default: 10), then SIGKILL if it still does not die. Please note that resque worker must be started `TERM_CHILD=1` environment variable.
+* `@worker_killer_verbose`: Verbose log
+* `@worker_killer_logger`: Logger instance (default: Resque.logger)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/resque-worker-killer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## ChangeLog
+
+[CHANGELOG.md](./CHANGELOG.md)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resque/worker/killer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'rake'
+gem 'resque'
+gem 'resque-worker-killer', path: '../../'
+gem 'pry'
+gem 'pry-nav'

data/example/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: ../../
+  specs:
+    resque-worker-killer (0.1.0)
+      get_process_mem
+      resque
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    get_process_mem (0.2.1)
+    method_source (0.8.2)
+    mono_logger (1.1.0)
+    multi_json (1.12.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rake (11.2.2)
+    redis (3.3.1)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
+    resque (1.26.0)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.3)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    slop (3.6.0)
+    tilt (2.0.5)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  pry-nav
+  rake
+  resque
+  resque-worker-killer!
+
+BUNDLED WITH
+   1.11.2

data/example/README.md

@@ -0,0 +1,13 @@
+Start a resque worker
+
+```
+$ QUEUE=* TERM_CHILD=1 bundle exec rake resque:work
+```
+
+Enqueue
+
+```
+$ bundle exec rake test
+```
+
+See logs of resque:work

data/example/Rakefile

@@ -0,0 +1,6 @@
+require 'resque/tasks'
+require_relative 'my_job'
+
+task :test do
+  Resque.enqueue(MyJob, {})
+end

data/example/my_job.rb

@@ -0,0 +1,24 @@
+require 'logger'
+require 'resque'
+require 'resque-worker-killer'
+
+class MyJob
+  @queue = :resque_worker_killer
+
+  extend Resque::Plugins::WorkerKiller
+  @worker_killer_monitor_interval = 0.5 # sec
+  @worker_killer_mem_limit = 10_000 # KB
+  @worker_killer_max_term = 10
+  @worker_killer_verbose = true
+  @worker_killer_logger = ::Logger.new(STDOUT)
+
+  def self.perform(params)
+    puts 'started'
+    sleep 3
+    str = 'a' * 10 * 1024 * 1024
+    sleep 7
+    puts 'finished'
+  rescue Resque::TermException => e # env TERM_CHILD=1
+    puts 'terminated'
+  end
+end

data/lib/resque-worker-killer.rb

@@ -0,0 +1 @@
+require 'resque/plugins/worker_killer'

data/lib/resque/plugins/worker_killer.rb

@@ -0,0 +1,93 @@
+require "resque/plugins/worker_killer/version"
+require 'get_process_mem'
+
+module Resque
+  module Plugins
+    module WorkerKiller
+      def worker_killer_monitor_interval
+        @worker_killer_monitor_interval ||= 1.0 # sec
+      end
+
+      def worker_killer_mem_limit
+        @worker_killer_mem_limit ||= 300 * 1024 # killo bytes
+      end
+
+      def worker_killer_max_term
+        @worker_killer_max_term ||= 10
+      end
+
+      def worker_killer_verbose
+        @worker_killer_verbose = false if @worker_killer_verbose.nil?
+        @worker_killer_verbose
+      end
+
+      def worker_killer_logger
+        @worker_killer_logger ||= ::Resque.logger
+      end
+
+      def self.extended(klass)
+        Resque.after_fork do |job|
+          # this is ran in the forked child process
+          # we do not let the monitor thread die since the process itself dies
+          Thread.start { PrivateMethods.new(klass).monitor_oom }
+        end
+      end
+
+      class PrivateMethods
+        def initialize(obj)
+          @obj = obj
+        end
+
+        # delegate attr_reader
+        %i[
+          monitor_interval
+          mem_limit
+          max_term
+          verbose
+          logger
+        ].each do |method|
+          define_method(method) do
+            @obj.send("worker_killer_#{method}")
+          end
+        end
+
+        def plugin_name
+          "Resque::Plugins::WorkerKiller"
+        end
+
+        def monitor_oom
+          start_time = Time.now
+          loop do
+            one_shot_monitor_oom(start_time)
+            sleep monitor_interval
+          end
+        end
+
+        def one_shot_monitor_oom(start_time)
+          rss = GetProcessMem.new.kb
+          logger.info "#{plugin_name}: worker (pid: #{Process.pid}) using #{rss} KB." if verbose
+          if rss > mem_limit
+            logger.warn "#{plugin_name}: worker (pid: #{Process.pid}) exceeds memory limit (#{rss} KB > #{mem_limit} KB)"
+            kill_self(logger, start_time)
+          end
+        end
+
+        # Kill the current process by telling it to send signals to itself If
+        # the process isn't killed after `@max_term` TERM signals,
+        # send a KILL signal.
+        def kill_self(logger, start_time)
+          alive_sec = (Time.now - start_time).round
+
+          @@kill_attempts ||= 0
+          @@kill_attempts += 1
+
+          sig = :TERM
+          sig = :KILL if @@kill_attempts > max_term
+
+          logger.warn "#{plugin_name}: send SIG#{sig} (pid: #{Process.pid}) alive: #{alive_sec} sec (trial #{@@kill_attempts})"
+          Process.kill(sig, Process.pid)
+        end
+      end
+    end
+  end
+end

data/lib/resque/plugins/worker_killer/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module WorkerKiller
+      VERSION = "0.1.0"
+    end
+  end
+end

data/resque-worker-killer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/plugins/worker_killer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-worker-killer"
+  spec.version       = Resque::Plugins::WorkerKiller::VERSION
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+
+  spec.summary       = %q{Automatically kill a child of resque worker based on max memory.}
+  spec.description   = %q{Automatically kill a child of resque worker based on max memory.}
+  spec.homepage      = "https://github.com/sonots/resque-worker-killer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "resque"
+  spec.add_dependency "get_process_mem"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: resque-worker-killer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Automatically kill a child of resque worker based on max memory.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.md
+- example/Rakefile
+- example/my_job.rb
+- lib/resque-worker-killer.rb
+- lib/resque/plugins/worker_killer.rb
+- lib/resque/plugins/worker_killer/version.rb
+- resque-worker-killer.gemspec
+homepage: https://github.com/sonots/resque-worker-killer
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Automatically kill a child of resque worker based on max memory.
+test_files: []