noxa-sidekiq-killer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 494a438b2f6ab1d1a8ac903bad39a70ed7f2339b
+  data.tar.gz: 23609db323ec8ec7ec0cebefacd12a8a227a5f45
+SHA512:
+  metadata.gz: 5f1f4848bbc27686e011b8a1dc2fef29408fd454da4a3d7ef19f1cb53cf0b7edb3b0d0276d31c9e11a8b146af8a776d692457dc35f0af2adcba08d4ea6cfd48d
+  data.tar.gz: 4146234f006ff56e59ffc490ad07ae5906fe960ea7e5a9b99a64038f77a7758bdb910289ca9530a29da38407108c87083d36405f5dad0ed6c64ec8ff521ef271

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at k.hammer@youngcapital.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Karst Hammer
+
+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 @@
+# Sidekiq::Killer
+
+Kills Sidekiq processes when the RSS is too high.
+
+It checks the memory usage of sidekiq after each job, and if the memory usage is
+higher than specified, it will wait for the specified grace_time before quieting
+the sidekiq process. After the shutdown_wait time it will forcibly kill sidekiq
+using the signal specified in shutdown_signal.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'noxa-sidekiq-killer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install noxa-sidekiq-killer
+
+## Usage
+
+Add the following to your Sidekiq configuration:
+
+```
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Killer::Memory, max_rss: 250, grace_time: 0, shutdown_wait: (15 * 60), shutdown_signal: 'SIGKILL'
+  end
+end
+```
+
+## Configuration options
+
+| Setting         | Description                                                                                 |
+| --------------- | ------------------------------------------------------------------------------------------- |
+| max_rss         | Max RSS (in megabytes)                                                                      |
+| grace_time      | Time to wait before quieting sidekiq (in seconds)                                           |
+| shutdown_wait   | Time to wait after quieting to finish off jobs before forcibly killing sidekiq (in seconds) |
+| shutdown_signal | Signal to use to shutdown sidekiq                                                           |
+
+## Acknowledgements
+
+This killer is based on the code from GitLab (https://gitlab.com/gitlab-org/gitlab-ce/).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/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(__FILE__)

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/lib/noxa-sidekiq-killer.rb

@@ -0,0 +1 @@
+require 'sidekiq/killer'

data/lib/sidekiq/killer.rb

@@ -0,0 +1,7 @@
+require "sidekiq/killer/version"
+
+module Sidekiq
+  module Killer
+    require "sidekiq/killer/memory"
+  end
+end

data/lib/sidekiq/killer/memory.rb

@@ -0,0 +1,53 @@
+require 'get_process_mem'
+
+module Sidekiq
+  module Killer
+    class Memory
+      def initialize(options = {})
+        options.stringify_keys!
+
+        @max_rss         = (options["max_rss"]         || 0).to_s.to_i
+        @grace_time      = (options["grace_time"]      || 15 * 60).to_s.to_i
+        @shutdown_wait   = (options["shutdown_wait"]   || 30).to_s.to_i
+        @shutdown_signal = (options["shutdown_signal"] || "SIGKILL").to_s
+      end
+
+      # Create a mutex used to ensure there will be only one thread waiting to
+      # shut Sidekiq down
+      MUTEX = Mutex.new
+
+      def call(worker, job, queue)
+        yield
+        current_rss = get_rss
+
+        return unless @max_rss > 0 && current_rss > @max_rss
+
+        Thread.new do
+          # Return if another thread is already waiting to shut Sidekiq down
+          return unless MUTEX.try_lock
+
+          Sidekiq.logger.warn "current RSS #{current_rss} exceeds maximum RSS "\
+            "#{@max_rss}"
+          Sidekiq.logger.warn "this thread will shut down PID #{::Process.pid} - Worker #{worker.class} - JID-#{job['jid']}"\
+            "in #{@grace_time} seconds"
+          sleep(@grace_time)
+
+          Sidekiq.logger.warn "sending SIGTERM to PID #{::Process.pid} - Worker #{worker.class} - JID-#{job['jid']}"
+          ::Process.kill("SIGTERM", ::Process.pid)
+
+          Sidekiq.logger.warn "waiting #{@shutdown_wait} seconds before sending "\
+            "#{@shutdown_signal} to PID #{::Process.pid} - Worker #{worker.class} - JID-#{job['jid']}"
+          sleep(@shutdown_wait)
+
+          Sidekiq.logger.warn "sending #{@shutdown_signal} to PID #{::Process.pid} - Worker #{worker.class} - JID-#{job['jid']}"
+          ::Process.kill(@shutdown_signal, ::Process.pid)
+        end
+      end
+
+      private
+      def get_rss
+        GetProcessMem.new.mb
+      end
+    end
+  end
+end

data/lib/sidekiq/killer/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Killer
+    VERSION = "0.1.0"
+  end
+end

data/sidekiq-killer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/killer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "noxa-sidekiq-killer"
+  spec.version       = Sidekiq::Killer::VERSION
+  spec.authors       = ["Karst Hammer"]
+  spec.email         = ["k.hammer@youngcapital.nl"]
+
+  spec.summary       = %q{Quiets and kills sidekiq when memory usage is too high}
+  spec.description   = %q{Quiets and kills sidekiq processes when the RSS memory usage is too high.}
+  spec.homepage      = "https://github.com/Noxa/sidekiq-killer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "get_process_mem"
+  spec.add_dependency "sidekiq"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: noxa-sidekiq-killer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karst Hammer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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: sidekiq
+  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'
+description: Quiets and kills sidekiq processes when the RSS memory usage is too high.
+email:
+- k.hammer@youngcapital.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/noxa-sidekiq-killer.rb
+- lib/sidekiq/killer.rb
+- lib/sidekiq/killer/memory.rb
+- lib/sidekiq/killer/version.rb
+- sidekiq-killer.gemspec
+homepage: https://github.com/Noxa/sidekiq-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.6.11
+signing_key: 
+specification_version: 4
+summary: Quiets and kills sidekiq when memory usage is too high
+test_files: []