capelinhos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d58321305d7a195ade76ea1869ab3348347d455e131f2c9fd0497b5b53f497c5
+  data.tar.gz: 86535d3c19297bb86d0c2d8ca218b70a77ede25eafe5c5404be938856c0cef26
+SHA512:
+  metadata.gz: d23b6a9c43660a5f3208aa356398905a61198e4e9feb79ac45d7c894013091a8cc02e0fd17228224d40edace7374ce41c70ff029f25e1f8a5194b363aeac7235
+  data.tar.gz: 2a2cba2f982977c3b64afa29bd8ce17473da540bb81a2dba1cacb33390a66d6992e1a661a0b18fab853f0e7602e77785e8f68fe71416835223a2c7d825517b56

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.rb

@@ -0,0 +1,52 @@
+#!/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 'platform_info'
+PhusionPassenger.require_passenger_lib 'platform_info/ruby'
+PhusionPassenger.require_passenger_lib 'admin_tools/memory_stats'
+include PhusionPassenger
+
+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 "--max-memory is required"
+  exit(0)
+end
+
+if !options[:max_processes]
+  puts "--max-processes is required"
+  exit(0)
+end
+
+
+Capelinhos::Processor.kill_memory_hogs!(memory_threshold: options[:max_memory],
+  process_limit: options[:max_processes])

data/lib/capelinhos/processor.rb

@@ -0,0 +1,23 @@
+module Capelinhos
+  class Processor
+    def self.kill_memory_hogs!(memory_threshold:, process_limit:)
+      processes_killed = 0
+      stats = AdminTools::MemoryStats.new
+      processes = stats.passenger_processes
+
+      processes.each do |process|
+        if process.name.include?('RubyApp')
+          rss_megabytes = process.rss / 1024
+          if rss_megabytes > memory_threshold
+            Process.kill('USR1', process.pid)
+            processes_killed += 1
+          end
+
+          if processes_killed >= process_limit
+            break
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capelinhos/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Capelinhos
+  VERSION = "0.1.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

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: capelinhos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Hallett
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: passenger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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:
+email:
+- adam.t.hallett@gmail.com
+executables:
+- capelinhos.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- capelinhos.sublime-project
+- exe/capelinhos.rb
+- lib/capelinhos.rb
+- lib/capelinhos/processor.rb
+- lib/capelinhos/version.rb
+- sig/capelinhos.rbs
+homepage: https://github.com/atomical/capelinhos
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/atomical/capelinhos
+  source_code_uri: https://github.com/atomical/capelinhos
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Gracefully shutdown Phusion Passenger Ruby processes when they exceed specified
+  memory usage.
+test_files: []