puma-status 0.1.5 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64511132fd67f2ec94455b13dd573b45e0bb7983efcd3f6dbcb12cf9dcddc8dd
-  data.tar.gz: e8922a9d6e9ce2e47fc79cb50d835cc503053683f84f64e7c54656d3952b7944
+  metadata.gz: ec73cc842d7b353e3f3994d554c4fdc6b1b7eab51452c578581d855610af613d
+  data.tar.gz: 6d44df05c3a303e3440406146921f4955a85fbded8ae131b29f1fec83f56b8fa
 SHA512:
-  metadata.gz: fc719fab589f2ce0ebb79dfad1b071256fa258b8633d61033f867843169e27c500442c62208bcda7aafe05017f7d95bddf818eb16442101aa90048317abdf867
-  data.tar.gz: c77a65f3a8dd2381cb788b8e695938cc34c0a96b9b3a6829ac382eddf43ca090fe228660ab07b6d9d84a2cdf804eb77fa78e2611d8f7b0af3e048a1eb360c9f4
+  metadata.gz: ab70d17e5b5c35bacce07819392f2818f62020287d7070618af64fa58e1da9f71fe7de126f60d2886a29c2d13d6e31698f071784f6f98c9c5773a7ee934e16b6
+  data.tar.gz: 41a1df505a6bb1299973a8972522b700d16b9d40232f567e237b20ce637de89733a72e7eae4944dcd0950c0c7b13a755353fbca601da55dc4d56167b5b2f8a66

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,25 +68,41 @@ 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 display_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))}"
+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
 
-  puts master_line
+  if stats.booting?
+    master_line += " #{warn("booting")}"
+  else
+    master_line += " | Load: #{color(75, 50, stats.load, asciiThreadLoad(stats.running_threads, stats.max_threads))}"
+    master_line += " | Req: #{stats.requests_count}" if stats.requests_count
+  end
 
-  stats.workers.each 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
+  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)}"
 
-    puts worker_line
+    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.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
+
+  output.join("\n")
 end

data/lib/helpers.rb

@@ -4,17 +4,29 @@ def debug(str)
   puts str if ENV.key?('DEBUG')
 end
 
-def color(critical, warn, value, str)
+def warn(str)
+  colorize(str, :yellow)
+end
+
+def error(str)
+  colorize(str, :red)
+end
+
+def colorize(str, color_name)
   return str if ENV.key?('NO_COLOR')
+  str.to_s.colorize(color_name)
+end
 
-  color = if value >= critical
+def color(critical, warn, value, str = nil)
+  str = value unless str
+  color_level = if value >= critical
             :red
           elsif value < critical && value >= warn
             :yellow
           else
             :green
           end
-  str.to_s.colorize(color)
+  colorize(str, color_level)
 end
 
 def asciiThreadLoad(idx, total)
@@ -32,8 +44,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

@@ -1,5 +1,6 @@
 require_relative './helpers'
 require_relative './core.rb'
+require 'parallel'
 
 def run
   debug "puma-status"
@@ -10,8 +11,38 @@ def run
     exit -1
   end
 
-  ARGV.each do |state_file_path|
-    debug "State file: #{state_file_path}"
-    display_stats(get_stats(state_file_path))
+  errors = []
+  
+  outputs = Parallel.map(ARGV, in_threads: ARGV.count) do |state_file_path|
+    begin
+      debug "State file: #{state_file_path}"
+      format_stats(get_stats(state_file_path))
+    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 => 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}"
+      nil
+    end
+  end
+
+  outputs.compact.each { |output| puts output }
+
+  if errors.any?
+    puts ""
+    errors.each { |error| puts error }
   end
 end

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,6 +33,10 @@ 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
@@ -55,6 +67,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 +87,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 +111,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
@@ -107,6 +127,12 @@ class Stats
     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,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: puma-status
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: '1.2'
 platform: ruby
 authors:
 - Yoann Lecuyer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-07-14 00:00:00.000000000 Z
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
-email: 
+description:
+email:
 executables:
 - puma-status
 extensions: []
@@ -97,7 +111,7 @@ homepage: https://github.com/ylecuyer/puma-status
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,16 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Command-line tool for puma to display information about running request/process
 test_files: []