sidekiq_process_killer 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 238e5c56b973d15c48532c8ae97ed69e618ef2df
+  data.tar.gz: 36bbaea2b7b882acc74eb0cda54ddea5206c5bdf
+SHA512:
+  metadata.gz: f07e2f56f74e42bcced965174a4142643de77b3a90c4ab453b9bc1930e4ef921fe422ea7c2b7d8ed93648515acae994ab3a04f09ae2ea8e233b4df06724dd8e4
+  data.tar.gz: 39ed73ecfcf7d7b9a3fda70dfcc428db2e8eabb758fd33c27b582df587479f360e6b88e82aae1fd82ba62834d175bdde00131c3228a435a1c773a4649f369c67

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.8
+  - 2.3.1
+  - 2.3.5
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

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 dev@shayon.me. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq_process_killer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shayon Mukherjee
+
+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,79 @@
+# SidekiqProcessKiller
+
+[![Build Status](https://travis-ci.org/shayonj/sidekiq_process_killer.svg?branch=master)](https://travis-ci.org/shayonj/sidekiq_process_killer)
+
+When you have memory leaks or "bloats" in your ruby application, identifying and fixing them can at times be a nightmare. Instead, an _"acceptable"_ mitigation is to re-spin the workers. Its a common technique that can be found in [Puma Worker Killer](https://github.com/schneems/puma_worker_killer) or [Unicorn Worker Killer](https://github.com/kzk/unicorn-worker-killer). Though, its neater and good practice to find and fix your leaks.
+
+SidekiqProcessKiller plugs into Sidekiq's middleware and kills a process if its processing beyond the supplied [RSS](https://en.wikipedia.org/wiki/Resident_set_size) threshold. Since this plugs into the middleware, the check is performed after each job.
+
+## Installation
+
+**While in testing period, this is not published to a public server, yet. Until then:**
+
+Add the following to your Gemfile
+
+```ruby
+  gem "sidekiq_process_killer", git: "git://github.com/shayonj/sidekiq_process_killer.git"
+```
+
+## Usage
+
+### Configuration
+
+The default configurations are:
+
+```ruby
+memory_threshold: 250.0 # mb
+shutdown_wait_timeout: 25 # seconds
+shutdown_signal: "SIGKILL"
+silent_mode: false
+statsd_klass: nil
+```
+
+- `silent_mode`: When set to `true`, it will mean that no signals for terminate or otherwise will be sent. This is helpful if you are planning to launch this, but want to first do a dry run.
+- `memory_threshold`: This is the threshold, which, when, breached, the respective Sidekiq worker will be instructed for termination (via `TERM` signal, which sidekiq gracefully exits).
+- `shutdown_signal`: Signal for force shutdown/kill/quit.
+- `shutdown_wait_timeout`: If, for some reason, the process takes more than the timeout defined in `shutdown_wait_timeout`, to die, the process will be forced terminated using the signal set in `shutdown_signal`.
+- `statsd_klass`: This is your custom statsd class object which responds to an `increment` function. If present, then it will send custom metrics about the worker process that is being terminated and its respective RSS.
+  - The `increment` is called with a single argument of type `Hash` which contains, `metric_name`, `worker_name` and `current_memory_usage`. The implementation of this may not be very flexible, its expected that your custom class reads the passed in information and appropriately send to your statsd agent. PRs/patches welcome to extend this functionality :).
+
+### Updating default configuration:
+
+```ruby
+class CustomMetric
+  ...
+
+  def increment(params)
+    StatsD.count(
+      params[:metric_name],
+      tags: {
+        worker_name: params[:worker_name]
+      }
+    )
+  end
+
+  ...
+end
+
+SidekiqProcessKiller.config do |con|
+  con.memory_threshold = 1024.0
+  con.shutdown_wait_timeout = 60
+  con.shutdown_signal = "SIGUSR2"
+  con.silent_mode = false
+  con.statsd_klass = CustomMetric.new # your custom statsd class object
+end
+```
+
+### Turn on SidekiqProcessKiller
+
+Just plugin the Middleware
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add SidekiqProcessKiller::Middleware
+  end
+end
+```
+
+The class tries to log as much as possible, as best as possible.

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq_process_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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/sidekiq_process_killer/middleware.rb

@@ -0,0 +1,87 @@
+module SidekiqProcessKiller
+  class Middleware
+    LOG_PREFIX = self.name
+    METRIC_PREFIX = "sidekiq_process_killer".freeze
+
+    attr_accessor :pid, :worker, :jid, :queue, :memory
+
+    def call(worker, job, queue)
+      @pid        = ::Process.pid
+      @worker     = worker.class
+      @queue      = queue
+      @memory     = process_memory.mb
+      @jid        = job['jid']
+
+      yield
+
+      memory_threshold = SidekiqProcessKiller.memory_threshold
+      return if memory_threshold > memory
+
+      log_warn("Breached RSS threshold at #{memory_threshold}. Sending TERM Signal.")
+
+      send_signal("SIGTERM", pid)
+      sleep(SidekiqProcessKiller.shutdown_wait_timeout)
+
+      shutdown_signal = SidekiqProcessKiller.shutdown_signal
+
+      begin
+        ::Process.getpgid(pid)
+        log_warn("Forcefully killing process with #{shutdown_signal}.")
+
+        increment_statsd({
+          metric_name: "process.killed.forcefully",
+          worker_name: worker.class,
+          current_memory_usage: memory
+        })
+
+        send_signal(shutdown_signal, pid)
+      rescue Errno::ESRCH
+        log_warn("Process killed successfully.")
+
+        increment_statsd({
+          metric_name: "process.killed.successfully",
+          worker_name: worker.class,
+          current_memory_usage: memory
+        })
+      end
+    end
+
+    private def process_memory
+      @memory ||= GetProcessMem.new
+    end
+
+    private def humanized_attributes
+      instance_variables.map do |var|
+        key = var.to_s.gsub("@", "").capitalize
+        value = instance_variable_get(var)
+        "#{key}: #{value}"
+      end.join(", ")
+    end
+
+    private def silent_mode_msg
+      SidekiqProcessKiller.silent_mode ? " [SILENT]" : ""
+    end
+
+    private def log_warn(msg)
+      Sidekiq.logger.warn("[#{LOG_PREFIX}]#{silent_mode_msg} #{msg} #{humanized_attributes}")
+    end
+
+    private def log_info(msg)
+      Sidekiq.logger.info("[#{LOG_PREFIX}]#{silent_mode_msg} #{msg} #{humanized_attributes}")
+    end
+
+    private def send_signal(name, pid)
+      return if SidekiqProcessKiller.silent_mode
+
+      ::Process.kill(name, pid)
+    end
+
+    private def increment_statsd(params)
+      statsd_klass = SidekiqProcessKiller.statsd_klass
+      return unless statsd_klass.respond_to?(:increment)
+
+      params[:metric_name] = "#{METRIC_PREFIX}.#{params[:metric_name]}"
+      statsd_klass.increment(params)
+    end
+  end
+end

data/lib/sidekiq_process_killer/version.rb

@@ -0,0 +1,3 @@
+module SidekiqProcessKiller
+  VERSION = "0.3.0"
+end

data/lib/sidekiq_process_killer.rb

@@ -0,0 +1,20 @@
+module SidekiqProcessKiller
+  extend self
+
+  attr_accessor :memory_threshold, :shutdown_wait_timeout, :shutdown_signal, :silent_mode, :statsd_klass
+
+  self.memory_threshold = 250.0 # mb
+  self.shutdown_wait_timeout = 25 # seconds
+  self.shutdown_signal = "SIGKILL"
+  self.silent_mode = false
+  self.statsd_klass = nil
+
+  def config
+    yield self
+  end
+end
+
+require "get_process_mem"
+require "sidekiq"
+require "sidekiq_process_killer/version"
+require "sidekiq_process_killer/middleware"

data/sidekiq_process_killer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq_process_killer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_process_killer"
+  spec.version       = SidekiqProcessKiller::VERSION
+  spec.authors       = ["Shayon Mukherjee"]
+  spec.email         = ["dev@shayon.me"]
+
+  spec.summary       = "Simple process killer for sidekiq to avoid memory leaks and/or bloats"
+  spec.description   = "SidekiqProcessKiller plugs into Sidekiq's middleware and kills a process if its processing beyond the supplied RSS threshold. Since, this plugs into the middleware the check is performed after each job."
+  spec.homepage      = "https://github.com/shayonj/sidekiq_process_killer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "get_process_mem"
+  spec.add_dependency "sidekiq"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_process_killer
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Shayon Mukherjee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-30 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: 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'
+- !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: SidekiqProcessKiller plugs into Sidekiq's middleware and kills a process
+  if its processing beyond the supplied RSS threshold. Since, this plugs into the
+  middleware the check is performed after each job.
+email:
+- dev@shayon.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq_process_killer.rb
+- lib/sidekiq_process_killer/middleware.rb
+- lib/sidekiq_process_killer/version.rb
+- sidekiq_process_killer.gemspec
+homepage: https://github.com/shayonj/sidekiq_process_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.14
+signing_key: 
+specification_version: 4
+summary: Simple process killer for sidekiq to avoid memory leaks and/or bloats
+test_files: []