unicorn_wrangler 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f027def0eaa75e21daf9efc322a1be988248b5cd117d12eb2ddfadc10494e4d7
-  data.tar.gz: a765f7d06d90f8ef448ae1ac87eeb0fc01dddac587dce8d1c69f00acbf6c0164
+  metadata.gz: 5bc72c4eced8c3d3036e8b63f27b6ac010a02685c3d9490f5756753d1a4d0e3c
+  data.tar.gz: e7dad93958d88498ecbd4b97bb2c575a20758f16acd4d6e53ebf4644b3da09ba
 SHA512:
-  metadata.gz: 91787cc20b2bafa1334af58dc5bc29985c3f7d165451cfd36fb45e5d63069ce36525f4d63f2a27fb09fdc29215aab0dcb62ad8cacf0e1cae067b5a20e4740188
-  data.tar.gz: 7b6ca2549873589cd9c837affafcc9a9fc07878476c7554f785b20c30b132a1d9e1f9ad12c24af9c16b27d40dae70cd47a7581f28642ea643e055bf9ff95d2ca
+  metadata.gz: 1014ebefa5bdc8de9e9b90ff8471972d165ef2f2d1fa5bd966ecf29522ee38c1b014f110aef1f9ffe81908a0c734e1c14a76f4e6292cb5f2a0d4601b29b5e204
+  data.tar.gz: 59a04f50a950e8556a7ff6337d6fa8252b14394beb3cb448228df024051ec21110201af1271a7f56a2615671ade2965d91c4eaf7c942135e248b4955898172c5

data/lib/unicorn_wrangler/rss_reader.rb

@@ -0,0 +1,50 @@
+# Read RSS based on the OS we are in. When in linux, we can read the proc status file and parse out
+# the RSS which is much faster than forking+execing ps.
+module UnicornWrangler
+  class RssReader
+    LINUX = RbConfig::CONFIG['host_os'].start_with?('linux')
+    PS_CMD = 'ps -o rss= -p %d'.freeze
+    VM_RSS = /^VmRSS:\s+(\d+)\s+(\w+)/
+    UNITS  = {
+      b:  1024**0,
+      kb: 1024**1,
+      mb: 1024**2,
+      gb: 1024**3,
+      tb: 1024**4,
+    }.freeze
+
+    def initialize(logger:)
+      @logger = logger
+    end
+
+    # Returns RSS in megabytes; should work on Linux and Mac OS X
+    def rss(pid: Process.pid)
+      LINUX ? rss_linux(pid) : rss_posix(pid)
+    end
+
+    private
+
+    # Fork/exec ps and parse result.
+    # Should work on any system with POSIX ps.
+    # ~4ms
+    # returns kb but we want mb
+    def rss_posix(pid)
+      `#{PS_CMD % [pid]}`.to_i / 1024
+    end
+
+    # Read from /proc/$pid/status.  Linux only.
+    # ~100x faster and doesn't incur significant memory cost.
+    # file returns variable units, we want mb
+    def rss_linux(pid)
+      File.read("/proc/#{pid}/status").match(VM_RSS) do |match|
+        value, magnitude = match[1].to_i, UNITS.fetch(match[2].downcase.to_sym)
+
+        value * magnitude / UNITS.fetch(:mb)
+      end
+    rescue
+      # If the given pid is dead, file will not be found
+      @logger.warn 'Failed to read RSS from /proc, falling back to exec+ps' if @logger
+      rss_posix(pid)
+    end
+  end
+end

data/lib/unicorn_wrangler/version.rb

@@ -1,3 +1,3 @@
 module UnicornWrangler
-  VERSION = "0.5.2"
+  VERSION = "0.7.0"
 end

data/lib/unicorn_wrangler.rb

@@ -3,12 +3,13 @@
 # - runs GC out of band (does not block requests)
 
 require 'benchmark'
+require 'unicorn_wrangler/rss_reader'
 
 module UnicornWrangler
   STATS_NAMESPACE = 'unicorn'
 
   class << self
-    attr_reader :handlers
+    attr_reader :handlers, :requests, :request_time
     attr_accessor :sending_myself_term
 
     # called from unicorn config (usually config/unicorn.rb)
@@ -25,7 +26,7 @@ module UnicornWrangler
       logger.info "Sending stats to under #{stats.namespace}.#{STATS_NAMESPACE}" if stats
       @handlers = []
       @handlers << RequestKiller.new(logger, stats, kill_after_requests) if kill_after_requests
-      @handlers << OutOfMemoryKiller.new(logger, stats, kill_on_too_much_memory) if kill_on_too_much_memory
+      @handlers << OutOfMemoryKiller.new(logger, stats, **kill_on_too_much_memory) if kill_on_too_much_memory
       @handlers << OutOfBandGC.new(logger, stats, gc_after_request_time) if gc_after_request_time
 
       @hooks = {}
@@ -109,6 +110,7 @@ module UnicornWrangler
     def initialize(logger, stats)
       @logger = logger
       @stats = stats
+      @rss_reader = RssReader.new(logger: logger)
     end
 
     private
@@ -130,9 +132,9 @@ module UnicornWrangler
       UnicornWrangler.kill_worker
     end
 
-    # expensive, do not run on every request
+    # RSS memory in MB. Can be expensive, do not run on every request
     def used_memory
-      `ps -o rss= -p #{Process.pid}`.to_i / 1024
+      @rss_reader.rss
     end
 
     def report_status(status, reason, memory, requests, request_time, log_level = :debug)

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: unicorn_wrangler
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Michael Grosser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email: michael@grosser.it
 executables: []
 extensions: []
@@ -18,12 +18,13 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - lib/unicorn_wrangler.rb
+- lib/unicorn_wrangler/rss_reader.rb
 - lib/unicorn_wrangler/version.rb
 homepage: https://github.com/grosser/unicorn_wrangler
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -31,15 +32,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: 'Unicorn: out of band GC / restart on max memory bloat / restart after X
   requests'