capelinhos 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c089836d43a3a2dc882eb95afbbf02a121b6e856c52221b7fcd7d4bc9198f962
-  data.tar.gz: 30c81f93a1d1e4235ec1e0c946ff793d0ebcd91f8389855d3db1156fbd0f92e5
+  metadata.gz: 78e1daf01cf2cdb53f94de1f68f88d014ae4f5d849a1efd13f5db6bec159b0b6
+  data.tar.gz: 44a494709edc3bd69d4a00a76dc2ca3ddb28b9950fe17414c34768d26a0b1e71
 SHA512:
-  metadata.gz: 6b776e7007ecda0f30d8cee0584d4ba79f3b4e8cf464b2487a633110b57e66bd6eed795a4bd9eba84ca45d0911fbd5870a14a5ae899837835e0ed6b3d73c953c
-  data.tar.gz: 69e90fc92715ffe7f2f0c28737c21fa005f170d9885a85d45a2f0cffc5349b3f0c3412f03cf5712d1607d38ac359d181db6c9f7aa8e3b293e69d4fed9d3af784
+  metadata.gz: 7b4fdaecc769d87f5b0649bb9b00f90e8aade2c5c5c0901b5eef16c348b24b75ee4ec190cc9f6b2cf87e8721dd4d8726ba08ec984df0a42c97c5260850cbe397
+  data.tar.gz: fd64de034e829cf6dbe88a7d00bda14a7e536cb3fd09bf56124d2420ff31f1695d9ec7fd0686cca79a17f8ef61dc04eec22f474fd710ae0104f87e2715c16217

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-30
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Adam Hallett
+
+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,36 @@
+# Capelinhos
+
+This gem gracefully stops Passenger Ruby processes that have exceeded a memory threshold. It is meant to be added to cron and run at an interval of your choosing.
+
+If Phusion Passenger is configured with `PassengerMinInstances` and the number of processes is under that number, then a new process should replace the processes that were shutdown.
+
+Note: This doesn't skip active long running sessions. This feature be added as a default in the future.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add capelinhos
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install capelinhos
+
+## Usage
+
+# kill up to 3 processes that use more than 400 megabytes
+$ capelinos --max-memory 400 --max-processes 3
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capelinhos.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/capelinhos.sublime-project

@@ -0,0 +1,15 @@
+{
+  "folders":
+  [
+    {
+      "path": ".",
+      "folder_exclude_patterns": []
+    }
+  ],
+  "settings": {
+  	"ensure_newline_at_eof_on_save": true,
+    "tab_size": 2,
+    "translate_tabs_to_spaces": true,
+    "trim_trailing_white_space_on_save": true
+  }
+}

data/exe/capelinhos

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'optparse'
+require 'capelinhos'
+
+source_root = File.expand_path("..", File.dirname(__FILE__))
+$LOAD_PATH.unshift("#{source_root}/src/ruby_supportlib")
+begin
+  require 'rubygems'
+rescue LoadError
+end
+require 'phusion_passenger'
+
+PhusionPassenger.locate_directories
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'platform_info'
+PhusionPassenger.require_passenger_lib 'admin_tools/instance_registry'
+PhusionPassenger.require_passenger_lib 'platform_info/ruby'
+PhusionPassenger.require_passenger_lib 'admin_tools/memory_stats'
+PhusionPassenger.require_passenger_lib 'admin_tools/instance_registry'
+PhusionPassenger.require_passenger_lib 'config/utils'
+PhusionPassenger.require_passenger_lib 'utils/ansi_colors'
+include PhusionPassenger
+include PhusionPassenger::SharedConstants
+include PhusionPassenger::AdminTools
+include PhusionPassenger::Utils::AnsiColors
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: capelinhos --max-memory 320 --max-processes 3"
+
+  opts.on("--max-memory", "--max-memory MAX_MEMORY", Numeric, "Maximum memory in megabytes to trigger shutdown.") do |n|
+    options[:max_memory] = n
+  end
+
+  opts.on("--max-processes", "--max-processes=NUMBER", Numeric, "Maximum number of processes to gracefully shutdown.") do |n|
+    options[:max_processes] = n
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+if !options[:max_memory]
+  puts "Version: #{Capelinhos::VERSION}"
+  puts "--max-memory is required"
+  exit(0)
+end
+
+if !options[:max_processes]
+  puts "Version: #{Capelinhos::VERSION}"
+  puts "--max-processes is required"
+  exit(0)
+end
+
+
+processor = Capelinhos::Processor.new(memory_threshold: options[:max_memory],
+  process_limit: options[:max_processes])
+processor.kill_memory_hogs!()

data/lib/capelinhos/processor.rb

@@ -0,0 +1,72 @@
+require 'json'
+require 'net/http'
+require 'byebug' if ENV['DEBUG']
+
+module Capelinhos
+  class Processor
+    def initialize(memory_threshold:, process_limit:)
+      @memory_threshold = memory_threshold
+      @process_limit = process_limit
+    end
+
+    def kill_memory_hogs!
+      processes_killed = 0
+      stats = AdminTools::MemoryStats.new
+      processes = stats.passenger_processes
+
+      if !supports_private_dirty_rss?(processes)
+        puts "This system doesn't support private dirty RSS. Falling back to RSS"
+      end
+
+      rss_type = supports_private_dirty_rss?(processes) ? :private_dirty_rss : :rss
+
+      processes.each do |process|
+        if process.name.include?('RubyApp')
+          rss_megabytes = process.send(rss_type) / 1024
+          if rss_megabytes > @memory_threshold
+            shutdown_process(process.pid)
+            processes_killed += 1
+          end
+
+          if processes_killed >= @process_limit
+            break
+          end
+        end
+      end
+    end
+
+    private
+
+    def supports_private_dirty_rss?(processes)
+      processes.any?{|p| !p.private_dirty_rss.nil?}
+    end
+
+    def shutdown_process(pid)
+      _instance = instance
+      request = Net::HTTP::Post.new("/pool/detach_process.json")
+      request.body = JSON.generate({pid: pid})
+      try_performing_ro_admin_basic_auth(request, _instance)
+      response = _instance.http_request("agents.s/core_api", request)
+
+      if response.code.to_i / 100 == 2
+        puts "Successfully detached PID: #{pid}"
+      else
+        puts "Process (#{pid}) could not be shutdown: #{response.body}"
+      end
+    end
+
+    def instance
+      instances = InstanceRegistry.new.list
+      instances.first
+    end
+
+    def try_performing_ro_admin_basic_auth(request, instance)
+      begin
+        password = instance.read_only_admin_password
+      rescue Errno::EACCES
+        return
+      end
+      request.basic_auth("ro_admin", password)
+    end
+  end
+end

data/lib/capelinhos/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Capelinhos
+  VERSION = "0.6.0"
+end

data/lib/capelinhos.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "capelinhos/version"
+require_relative "capelinhos/processor"
+
+module Capelinhos
+  class Error < StandardError; end
+end

data/sig/capelinhos.rbs

@@ -0,0 +1,4 @@
+module Capelinhos
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capelinhos
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Adam Hallett
@@ -55,10 +55,21 @@ dependencies:
 description:
 email:
 - adam.t.hallett@gmail.com
-executables: []
+executables:
+- capelinhos
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- capelinhos.sublime-project
+- exe/capelinhos
+- lib/capelinhos.rb
+- lib/capelinhos/processor.rb
+- lib/capelinhos/version.rb
+- sig/capelinhos.rbs
 homepage: https://github.com/atomical/capelinhos
 licenses:
 - MIT