puma_doctor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71aabad56a6b33023c08b80b5a51e3abd7019aac
+  data.tar.gz: 0dbe0a44f19e7dbbdf7d587c8b6ec2562a9da3f0
+SHA512:
+  metadata.gz: 7a575219806300a993916df39ae762cbfd35a013cf93fc2dcf452169a28e09f77e6201d35ebd652e91a2d327f44d0477d7a693c5cd7924a37ae776cbbc95bada
+  data.tar.gz: acb853b60daaedcff2f915e013879b5d8815c7ab1e7742977289e1266f8c0d6cc250d384eb664c2ca833d54a1f505d2f2c353b6bad7b36a3f5e3f95fb5bd79dc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alex Krasynskyi
+
+MIT License
+
+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,93 @@
+# PumaDoctor
+
+Inspired by ( https://github.com/schneems/puma_worker_killer ). Idea is to run
+separate process as a daemon to measure puma memory and restart worker when memory
+threshold reached.
+
+## Usage
+
+### Running from ruby code.
+To run from your code:
+
+    PumaDoctor.start(frequency: 60, memory_threshold: 2000, puma_pid: 99999)
+
+This is not very useful in production since it blocks execution, but you can play
+around with options locally. Available options with defaults are:
+
+    frequency:          60 # Interval in seconds
+    puma_pid_file:      'puma.pid' # Location of puma pid file
+    memory_threshold:   4000 # Amount in MB
+    log_file:           'puma_doctor.log' # Name and location of log file
+
+### Running as a daemon.
+
+To run as daemon you can create file with content below(Ex.: doctor.rb)
+
+    require 'puma_doctor'
+    require 'daemons'
+
+    pid_dir = '../' # Path to directory to store pid.
+    Daemons.run_proc('puma_doctor', { dir: pid_dir }) do
+      PumaDoctor.start(frequency: 60, memory_threshold: 1000)
+    end
+
+Then control it with(for more details visit https://github.com/thuehlinger/daemons):
+
+    bundle exec ruby doctor.rb start
+    bundle exec ruby doctor.rb stop
+    bundle exec ruby doctor.rb restart
+
+### Using with capistrano.
+
+Probably the easiest way to run `puma_doctor` in production is to use `capistrano`. Require script in `Capfile`:
+
+    require 'puma_doctor/capistrano'
+
+This will add hook to start/restart daemon on `after deploy:finished`. If you want to start/stop from capistrano manually - this tasks are available:
+
+    cap puma_doctor:check              # Check if config file exixts on server
+    cap puma_doctor:config             # Config daemon
+    cap puma_doctor:restart            # Restart daemon
+    cap puma_doctor:start              # Start daemon
+    cap puma_doctor:stop               # Stop daemon
+
+Available options with defaults:
+
+    set :puma_doctor_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma_doctor.pid') }
+    set :puma_doctor_frequency, 30 #seconds
+    set :puma_doctor_memory_threshold, 4000 #mb
+    set :puma_doctor_daemon_file, -> { File.join(shared_path, 'puma_doctor_daemon.rb') }
+    set :puma_doctor_log_file, -> { File.join(shared_path, 'log', 'puma_doctor.log') }
+    set :puma_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma.pid') }
+
+
+### Logging
+
+You can always see what `puma_doctor` is doing by reading logs.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'puma_doctor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puma_doctor
+
+## TODO
+
+Test
+
+## Contributing
+
+1. Fork it ( http://github.com/spilin/puma_doctor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/puma_doctor/capistrano.rb

@@ -0,0 +1,62 @@
+namespace :load do
+  task :defaults do
+    set :puma_doctor_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma_doctor.pid') }
+    set :puma_doctor_frequency, 30 #seconds
+    set :puma_doctor_memory_threshold, 4000 #mb
+    set :puma_doctor_daemon_file, -> { File.join(shared_path, 'puma_doctor_daemon.rb') }
+    set :puma_doctor_log_file, -> { File.join(shared_path, 'log', 'puma_doctor.log') }
+    set :puma_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma.pid') }
+  end
+end
+
+namespace :puma_doctor do
+  desc 'Config daemon. Generate and send puma_doctor.rb'
+  task :config do
+    on roles(:app), in: :sequence, wait: 5 do
+      path = File.expand_path("../daemon_template.rb.erb", __FILE__)
+      if File.file?(path)
+        erb = File.read(path)
+        upload! StringIO.new(ERB.new(erb).result(binding)), fetch(:puma_doctor_daemon_file)
+      end
+    end
+  end
+
+  desc 'Start daemon'
+  task :start do
+    on roles(:app), in: :sequence, wait: 5 do
+      within release_path do
+        invoke 'puma_doctor:check'
+        execute :bundle, :exec, :ruby, fetch(:puma_doctor_daemon_file), 'start'
+      end
+    end
+  end
+
+  desc 'Stop daemon'
+  task :stop do
+    on roles(:app), in: :sequence, wait: 5 do
+      within release_path do
+        invoke 'puma_doctor:check'
+        execute :bundle, :exec, :ruby, fetch(:puma_doctor_daemon_file), 'stop'
+      end
+    end
+  end
+
+  desc 'Restart daemon'
+  task :restart do
+    on roles(:app), in: :sequence, wait: 5 do
+      within release_path do
+        invoke 'puma_doctor:check'
+        execute :bundle, :exec, :ruby, fetch(:puma_doctor_daemon_file), 'restart'
+      end
+    end
+  end
+
+  desc 'Check if config file exixts on server. If not - create and upload one.'
+  task :check do
+    on roles(:app), in: :sequence, wait: 5 do
+      invoke 'puma_doctor:config' unless test "[ -f #{fetch(:puma_doctor_daemon_file)} ]"
+    end
+  end
+
+  after 'deploy:finished', 'puma_doctor:restart'
+end

data/lib/puma_doctor/daemon_template.rb.erb

@@ -0,0 +1,12 @@
+require 'puma_doctor'
+require 'daemons'
+
+Daemons.run_proc('puma_doctor', { dir: '<%= File.dirname(fetch(:puma_doctor_pid)) %>' }) do
+  options = {
+      frequency: <%= fetch(:puma_doctor_frequency) %>,
+      memory_threshold: <%= fetch(:puma_doctor_memory_threshold) %>,
+      puma_pid_file: '<%= fetch(:puma_pid) %>',
+      log_file: '<%= fetch(:puma_doctor_log_file) %>'
+    }
+  PumaDoctor.start(options)
+end

data/lib/puma_doctor/doctor.rb

@@ -0,0 +1,67 @@
+module PumaDoctor
+  class Doctor
+    def initialize(options = {})
+      @memory_threshold = options[:memory_threshold]
+      @puma_pid_file = options[:puma_pid_file]
+      @puma_pid = options[:puma_pid] && options[:puma_pid].to_i
+      @logger = options[:logger]
+    end
+
+    def examine
+      @master_pid = get_master_pid(@master_pid)
+      return if @master_pid.nil?
+      workers = get_workers(@master_pid) # worker pids with size, last one is the largest one
+      used_memory = workers.inject(0) {|memo, v| memo += v.last } + GetProcessMem.new(@master_pid).mb
+      logger.info "[Puma Doctor] Total memory used: #{used_memory} mb. Workers online: #{workers.size}"
+      if used_memory > @memory_threshold
+        kill_largest_worker(workers)
+      end
+    end
+
+    private
+
+    def get_master_pid(current_puma_pid)
+      if current_puma_pid && process_is_running?(current_puma_pid)
+        current_puma_pid
+      elsif current_puma_pid && (@puma_pid_file.nil? || !File.exists?(@puma_pid_file))
+        logger.warn "[Puma Doctor] Master pid is no longer represents running process.
+          Reload failed because pid file is not set or invalid(File: '#{@puma_pid_file}')"
+        nil
+      elsif current_puma_pid && (current_puma_pid = File.read(@puma_pid_file).to_i) && process_is_running?(current_puma_pid)
+        logger.warn "[Puma Doctor] Master pid is no longer represents running process. Successfully Reloaded pid file."
+        current_puma_pid
+      elsif @puma_pid && process_is_running?(@puma_pid)
+        current_puma_pid = @puma_pid
+      elsif @puma_pid_file && File.exists?(@puma_pid_file) && process_is_running?(current_puma_pid = File.read(@puma_pid_file).to_i)
+        current_puma_pid
+      else
+        logger.warn "[Puma Doctor] Puma master pidfile is not found"
+        nil
+      end
+    end
+
+    def get_workers(puma_pid)
+      `pgrep -P #{puma_pid} -d ','`.split(',').compact.map do |pid|
+        [pid.to_i, GetProcessMem.new(pid).mb]
+      end
+    end
+
+    def kill_largest_worker(workers)
+      pid, memory_used = workers.max_by {|a| a[1]}
+      Process.kill('TERM', pid)
+      logger.info "[Puma Doctor] Doctor killed worker(#{pid}).It was using #{memory_used} mb. Workers online: #{workers.size - 1}"
+    end
+
+    def process_is_running?(pid)
+      Process.getpgid(pid)
+      true
+    rescue Errno::ESRCH
+      false
+    end
+
+    def logger
+      @logger
+    end
+
+  end
+end

data/lib/puma_doctor/logger.rb

@@ -0,0 +1,23 @@
+require 'logger'
+
+module PumaDoctor
+  class Logger
+    def initialize(options = {})
+      @logger = ::Logger.new(options[:log_file])
+      @logger.level = options[:log_level] || ::Logger::INFO
+    end
+
+    def info(text)
+      @logger.info(text)
+    end
+
+    def warn(text)
+      @logger.warn(text)
+    end
+
+    def log_start
+      @logger.info "[Puma Doctor] Starting..."
+    end
+
+  end
+end

data/lib/puma_doctor/version.rb

@@ -0,0 +1,3 @@
+module PumaDoctor
+  VERSION = "0.0.1"
+end

data/lib/puma_doctor.rb

@@ -0,0 +1,36 @@
+require "puma_doctor/version"
+require "get_process_mem"
+
+require 'puma_doctor/doctor'
+require 'puma_doctor/logger'
+
+module PumaDoctor
+  extend self
+
+  attr_accessor :frequency, :pid_file, :puma_pid, :puma_pid_file, :memory_threshold, :log_file
+  attr_reader :logger
+  self.frequency                  = 60 # seconds
+  self.pid_file                   = 'puma_doctor.pid'
+  self.puma_pid_file              = 'puma.pid'
+  self.memory_threshold           = 4000 # mb
+  self.log_file                   = 'puma_doctor.log'
+
+  def start(options = {})
+    @logger = ::PumaDoctor::Logger.new(log_file: options[:log_file] || self.log_file, log_level: options[:log_level])
+    @logger.log_start
+    doctor = Doctor.new(default_options.merge(options).merge(logger: @logger))
+    loop do
+      doctor.examine
+      sleep(options[:frequency] || self.frequency)
+    end
+  end
+
+  def default_options
+    {
+      memory_threshold: self.memory_threshold,
+      puma_pid_file: self.puma_pid_file,
+      puma_pid: self.puma_pid
+    }
+  end
+
+end

data/puma_doctor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puma_doctor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puma_doctor"
+  spec.version       = PumaDoctor::VERSION
+  spec.authors       = ["Alex Krasynskyi"]
+  spec.email         = ["lyoshakr@gmail.com"]
+  spec.summary       = %q{Process to keep your puma workers healthy.}
+  spec.description   = %q{Kills largest worker. Runs seperate daemon, managed with sidekiq.}
+  spec.homepage      = "https://github.com/spilin/puma_doctor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "daemons"
+  spec.add_dependency "get_process_mem"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: puma_doctor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Krasynskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: daemons
+  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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Kills largest worker. Runs seperate daemon, managed with sidekiq.
+email:
+- lyoshakr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puma_doctor.rb
+- lib/puma_doctor/capistrano.rb
+- lib/puma_doctor/daemon_template.rb.erb
+- lib/puma_doctor/doctor.rb
+- lib/puma_doctor/logger.rb
+- lib/puma_doctor/version.rb
+- puma_doctor.gemspec
+homepage: https://github.com/spilin/puma_doctor
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Process to keep your puma workers healthy.
+test_files: []