puma-status 0.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a19b27c114c23f83f652c395c9157d2581a0c688a42c2784c3660bef0f3277
-  data.tar.gz: 94a7a2cbee9aa0a082ddc38b61a32a4d2db3c3f8ad44a70b546a67b4a884dde8
+  metadata.gz: ded7bd0b4bca01b8b07ca16c7380453cf96f49d0c00667d024a6317d7307cea0
+  data.tar.gz: a391f836ca1c5d1a40acbab75178fd4c569d25005fac3c83bfd981051e1a7d66
 SHA512:
-  metadata.gz: f3b70ede2ef3c33c2436efe7da75faa5e858c5042572d07d26204487ea61a60d31cd2f9497502a5f8ae00bf00ecbdae0ac5ea6bceba1bfeec28036e9e18dc39c
-  data.tar.gz: f930e67b9deff2945d5f3a02c5635caf808b17a927527e533a3b7894e7b91ac59670c114c6fbb066a3be325fc9a78dc62cbfad12d26020a8e588b2a152d5e436
+  metadata.gz: c3968446849e0078c9cb557c721a1f5a2226a5ca1533016b319d15ec4c2e769a88062c8f354de28451fad533ba6502707a79660bf9a0469c677482f270ab1c65
+  data.tar.gz: e186aefc643f0ce7bfaf9515d5a36fc71558c0a871d792914e55e5867d5d0d9e4e32d04a71f27429ab1ae19f43054d06ae00c47911f209bcf423c197e4c586b6

data/lib/core.rb

@@ -1,13 +1,28 @@
 require 'yaml'
 require 'json'
 require 'net_x/http_unix'
+require 'openssl'
 require 'time'
 require_relative 'stats'
 
 def get_stats(state_file_path)
   puma_state = YAML.load_file(state_file_path)
 
-  client = NetX::HTTPUnix.new(puma_state["control_url"])
+  uri = URI.parse(puma_state["control_url"])
+
+  address = if uri.scheme =~ /unix/i
+              [uri.scheme, '://', uri.host, uri.path].join
+            else
+              [uri.host, uri.path].join
+            end
+
+  client = NetX::HTTPUnix.new(address, uri.port)
+
+  if uri.scheme =~ /ssl/i
+    client.use_ssl = true
+    client.verify_mode = OpenSSL::SSL::VERIFY_NONE if ENV['SSL_NO_VERIFY'] == '1'
+  end
+
   req = Net::HTTP::Get.new("/stats?token=#{puma_state["control_auth_token"]}")
   resp = client.request(req)
   raw_stats = JSON.parse(resp.body)
@@ -17,10 +32,27 @@ def get_stats(state_file_path)
   hydrate_stats(stats, puma_state, state_file_path)
 end
 
+def get_memory_from_top(raw_memory)
+  raw_memory.tr!(',', '.') # because of LC_NUMERIC separator can be ,
+
+  case raw_memory[-1].downcase
+  when 'g'
+    (raw_memory[0...-1].to_f*1024).to_i
+  when 'm'
+    raw_memory[0...-1].to_i
+  else
+    raw_memory.to_i/1024
+  end
+end
+
+PID_COLUMN = 0
+MEM_COLUMN = 5
+CPU_COLUMN = 8
+
 def get_top_stats(pids)
   pids.each_slice(19).inject({}) do |res, pids19|
     top_result = `top -b -n 1 -p #{pids19.join(',')} | tail -n #{pids19.length}`
-    top_result.split("\n").map { |row| r = row.split(' '); [r[0].to_i, r[5].to_i/1024, r[8].to_f] }
+    top_result.split("\n").map { |row| r = row.split(' '); [r[PID_COLUMN].to_i, get_memory_from_top(r[MEM_COLUMN]), r[CPU_COLUMN].to_f] }
       .inject(res) { |hash, row| hash[row[0]] = { mem: row[1], pcpu: row[2] }; hash }
     res
   end
@@ -36,22 +68,39 @@ def hydrate_stats(stats, puma_state, state_file_path)
 
   stats.tap do |s|
     stats.workers.map do |wstats|
-      wstats.mem = top_stats[wstats.pid][:mem]
-      wstats.pcpu = top_stats[wstats.pid][:pcpu]
+      wstats.mem = top_stats.dig(wstats.pid, :mem) || 0
+      wstats.pcpu = top_stats.dig(wstats.pid, :pcpu) || 0
+      wstats.killed = !top_stats.key?(wstats.pid) || (wstats.mem <=0 && wstats.pcpu <= 0)
     end
   end
 end
 
 def format_stats(stats)
-  master_line = "#{stats.pid} (#{stats.state_file_path}) Uptime: #{seconds_to_human(stats.uptime)} "
-  master_line += "| Phase: #{stats.phase} " if stats.phase
-  master_line += "| Load: #{color(75, 50, stats.load, asciiThreadLoad(stats.running_threads, stats.max_threads))}"
+  master_line = "#{stats.pid} (#{stats.state_file_path}) Uptime: #{seconds_to_human(stats.uptime)}"
+  master_line += " | Phase: #{stats.phase}" if stats.phase
+
+  if stats.booting?
+    master_line += " #{warn("booting")}"
+  else
+    master_line += " | Load: #{color(75, 50, stats.load, asciiThreadLoad(stats.running_threads, stats.spawned_threads, stats.max_threads))}"
+    master_line += " | Req: #{stats.requests_count}" if stats.requests_count
+  end
 
   output = [master_line] + stats.workers.map do |wstats|
-    worker_line = " └ #{wstats.pid.to_s.rjust(5, ' ')} CPU: #{color(75, 50, wstats.pcpu, wstats.pcpu.to_s.rjust(5, ' '))}% Mem: #{color(1000, 750, wstats.mem, wstats.mem.to_s.rjust(4, ' '))} MB Uptime: #{seconds_to_human(wstats.uptime)} | Load: #{color(75, 50, wstats.load, asciiThreadLoad(wstats.running_threads, wstats.max_threads))}"
-    worker_line += " #{("Queue: " + wstats.backlog.to_s).colorize(:red)}" if wstats.backlog > 0
-    worker_line += " Last checkin: #{wstats.last_checkin}" if wstats.last_checkin >= 10
-    worker_line += " Phase: #{wstats.phase}" if wstats.phase != stats.phase
+    worker_line = " └ #{wstats.pid.to_s.rjust(5, ' ')} CPU: #{color(75, 50, wstats.pcpu, wstats.pcpu.to_s.rjust(5, ' '))}% Mem: #{color(1000, 750, wstats.mem, wstats.mem.to_s.rjust(4, ' '))} MB Uptime: #{seconds_to_human(wstats.uptime)}"
+
+    if wstats.booting?
+      worker_line += " #{warn("booting")}"
+    elsif wstats.killed?
+      worker_line += " #{error("killed")}"
+    else
+      worker_line += " | Load: #{color(75, 50, wstats.load, asciiThreadLoad(wstats.running_threads, wstats.spawned_threads, wstats.max_threads))}"
+      worker_line += " | Phase: #{error(wstats.phase)}" if wstats.phase != stats.phase
+      worker_line += " | Req: #{wstats.requests_count}" if wstats.requests_count
+      worker_line += " Queue: #{error(wstats.backlog.to_s)}" if wstats.backlog > 0
+      worker_line += " Last checkin: #{error(wstats.last_checkin)}" if wstats.last_checkin >= 10
+    end
+
     worker_line
   end
 

data/lib/helpers.rb

@@ -17,7 +17,8 @@ def colorize(str, color_name)
   str.to_s.colorize(color_name)
 end
 
-def color(critical, warn, value, str)
+def color(critical, warn, value, str = nil)
+  str = value unless str
   color_level = if value >= critical
             :red
           elsif value < critical && value >= warn
@@ -28,11 +29,16 @@ def color(critical, warn, value, str)
   colorize(str, color_level)
 end
 
-def asciiThreadLoad(idx, total)
+def asciiThreadLoad(running, spawned, total)
   full = "█"
-  empty= "░"
+  half= "░"
+  empty = " "
 
-  "#{idx}[#{full*idx}#{empty*(total-idx)}]#{total}"
+  full_count = running
+  half_count = [spawned - running, 0].max
+  empty_count = total - half_count - full_count
+
+  "#{running}[#{full*full_count}#{half*half_count}#{empty*empty_count}]#{total}"
 end
 
 def seconds_to_human(seconds)
@@ -43,8 +49,10 @@ def seconds_to_human(seconds)
   #=> 23h59m
   #=>  1d 0h
   #=>    24d
-  
-  if seconds < 60*60
+
+  if seconds <= 0
+    "--m--s"
+  elsif seconds < 60*60
     "#{(seconds/60).to_s.rjust(2, ' ')}m#{(seconds%60).to_s.rjust(2, ' ')}s"
   elsif seconds >= 60*60*1 && seconds < 60*60*24
     "#{(seconds/(60*60*1)).to_s.rjust(2, ' ')}h#{((seconds%(60*60*1))/60).to_s.rjust(2, ' ')}m"

data/lib/puma-status.rb

@@ -17,11 +17,21 @@ def run
     begin
       debug "State file: #{state_file_path}"
       format_stats(get_stats(state_file_path))
-    rescue Errno::ENOENT
-      errors << "#{warn(state_file_path)} doesn't exists"
+    rescue Errno::ENOENT => e
+      if e.message =~ /#{state_file_path}/
+        errors << "#{warn(state_file_path)} doesn't exists"
+      elsif e.message =~ /connect\(2\) for [^\/]/
+        errors << "#{warn("Relative Unix socket")}: the Unix socket of the control app has a relative path. Please, ensure you are running from the same folder has puma."
+      else
+        errors << "#{error(state_file_path)} an unhandled error occured: #{e.inspect}"
+      end
       nil
-    rescue Errno::EISDIR
-      errors << "#{warn(state_file_path)} isn't a state file"
+    rescue Errno::EISDIR => e
+      if e.message =~ /#{state_file_path}/
+        errors << "#{warn(state_file_path)} isn't a state file"
+      else
+        errors << "#{error(state_file_path)} an unhandled error occured: #{e.inspect}"
+      end
       nil
     rescue => e
       errors << "#{error(state_file_path)} an unhandled error occured: #{e.inspect}"

data/lib/stats.rb

@@ -9,6 +9,14 @@ class Stats
       @wstats['pid']
     end
 
+    def killed=(killed)
+      @wstats['killed'] = killed
+    end
+
+    def killed?
+      !!@wstats['killed']
+    end
+
     def mem=(mem)
       @wstats['mem'] = mem
     end
@@ -25,14 +33,20 @@ class Stats
       @wstats['pcpu']
     end
 
+    def booting?
+      @wstats.key?('last_status') && @wstats['last_status'].empty?
+    end
+
     def running
       @wstats.dig('last_status', 'running') || @wstats['running'] || 0
     end
     alias :total_threads :running
+    alias :spawned_threads :running
 
     def max_threads
       @wstats.dig('last_status', 'max_threads') || @wstats['max_threads'] || 0
     end
+    alias :total_threads :max_threads
 
     def pool_capacity
       @wstats.dig('last_status', 'pool_capacity') || @wstats['pool_capacity'] || 0
@@ -55,6 +69,10 @@ class Stats
       (Time.now - Time.parse(@wstats['started_at'])).to_i
     end
 
+    def requests_count
+      @wstats.dig('last_status', 'requests_count') || @wstats['requests_count']
+    end
+
     def backlog
       @wstats.dig('last_status', 'backlog') || 0
     end
@@ -71,7 +89,7 @@ class Stats
   end
 
   def workers
-    (@stats['worker_status'] || [@stats]).map { |wstats| Worker.new(wstats) }
+    @workers ||= (@stats['worker_status'] || [@stats]).map { |wstats| Worker.new(wstats) }
   end
 
   def pid=(pid)
@@ -95,6 +113,10 @@ class Stats
     (Time.now - Time.parse(@stats['started_at'])).to_i
   end
 
+  def booting?
+    workers.all?(&:booting?)
+  end
+
   def total_threads
     workers.reduce(0) { |total, wstats| total + wstats.max_threads }
   end
@@ -103,10 +125,20 @@ class Stats
     workers.reduce(0) { |total, wstats| total + wstats.running_threads }
   end
 
+  def spawned_threads
+    workers.reduce(0) { |total, wstats| total + wstats.spawned_threads }
+  end
+
   def max_threads
     workers.reduce(0) { |total, wstats| total + wstats.max_threads }
   end
 
+  def requests_count
+    workers_with_requests_count = workers.select(&:requests_count)
+    return if workers_with_requests_count.none?
+    workers_with_requests_count.reduce(0) { |total, wstats| total + wstats.requests_count }
+  end
+
   def running
     @stats['running'] || 0
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma-status
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Yoann Lecuyer
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.0.dev
 signing_key: 
 specification_version: 4
 summary: Command-line tool for puma to display information about running request/process