puma-status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b7c4c76896b8d5f9b831403b258e7a377826767a18854292064e75a8eaf4974
+  data.tar.gz: 49d28d79e5a509e91bd02e6d2a56ac50cbe33c4379d3ae5be404ff3d0e739293
+SHA512:
+  metadata.gz: eb4396e097e5cdb2d35bc758c0a6de1ae2679e22cff729a5f0e10c6716068427d716640a223addde2ea07cb2df7ef65ad5ea7d88f32d95a3ae95ad6499f605d8
+  data.tar.gz: 3b680055e5c4062f03cd7e8afb4c8c56b1c9afb20e0f070fe92c9ced43f015e61109a8dc49386d286f4bf95d0e96e8166ed70db69cc3a5cd1b7fbf8677168a57

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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/bin/puma-status

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require './lib/puma-status'
+
+run

data/lib/core.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+require 'json'
+require 'net_x/http_unix'
+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"])
+  req = Net::HTTP::Get.new("/stats?token=#{puma_state["control_auth_token"]}")
+  resp = client.request(req)
+  raw_stats = JSON.parse(resp.body)
+  debug raw_stats
+  stats = Stats.new(raw_stats)
+
+  hydrate_stats(stats, puma_state, state_file_path)
+end
+
+def get_top_stats(pids)
+  top_result = `top -b -n 1 -p #{pids.join(',')} | tail -n #{pids.length}`
+  top_stats = top_result.split("\n").map { |row| r = row.split(' '); [r[0].to_i, r[5].to_i/1024, r[8].to_f] }
+    .reduce({}) { |hash, row| hash[row[0]] = { mem: row[1], pcpu: row[2] }; hash }
+end
+
+def hydrate_stats(stats, puma_state, state_file_path)
+  stats.pid = puma_state['pid']
+  stats.state_file_path = state_file_path
+
+  workers_pids = stats.workers.map(&:pid)
+
+  top_stats = get_top_stats(workers_pids)
+
+  stats.tap do |s|
+    stats.workers.map do |wstats|
+      wstats.mem = top_stats[wstats.pid][:mem]
+      wstats.pcpu = top_stats[wstats.pid][:pcpu]
+    end
+  end
+end
+
+def display_stats(stats)
+  puts "#{stats.pid} (#{stats.state_file_path}) Uptime: #{seconds_to_human(stats.uptime)} | Load: #{color(75, 50, stats.load, asciiThreadLoad(stats.running_threads, stats.total_threads))}"
+
+  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.total_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
+
+    puts worker_line
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,45 @@
+require 'colorize'
+
+def debug(str)
+  puts str if ENV.key?('DEBUG')
+end
+
+def color(critical, warn, value, str)
+  return str if ENV.key?('NO_COLOR')
+
+  color = if value >= critical
+            :red
+          elsif value < critical && value >= warn
+            :yellow
+          else
+            :green
+          end
+  str.to_s.colorize(color)
+end
+
+def asciiThreadLoad(idx, total)
+  full = "█"
+  empty= "░"
+
+  "#{idx}[#{full*idx}#{empty*(total-idx)}]#{total}"
+end
+
+def seconds_to_human(seconds)
+
+  #=>  0m 0s
+  #=> 59m59s
+  #=>  1h 0m
+  #=> 23h59m
+  #=>  1d 0h
+  #=>    24d
+  
+  if 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"
+  elsif seconds > 60*60*24 && seconds < 60*60*24*10
+    "#{(seconds/(60*60*24)).to_s.rjust(2, ' ')}d#{((seconds%(60*60*24))/(60*60*1)).to_s.rjust(2, ' ')}h"
+  else
+    "#{seconds/(60*60*24)}d".rjust(6, ' ')
+  end
+end

data/lib/puma-status.rb

@@ -0,0 +1,9 @@
+require_relative './helpers'
+require_relative './core.rb'
+
+def run
+  debug "puma-status"
+  state_file_path = ARGV[0]
+  debug "State file: #{state_file_path}"
+  display_stats(get_stats(state_file_path))
+end

data/lib/stats.rb

@@ -0,0 +1,107 @@
+class Stats
+
+  class Worker
+    def initialize(wstats)
+      @wstats = wstats
+    end
+
+    def pid
+      @wstats['pid']
+    end
+
+    def mem=(mem)
+      @wstats['mem'] = mem
+    end
+
+    def mem
+      @wstats['mem']
+    end
+
+    def pcpu=(pcpu)
+      @wstats['pcpu'] = pcpu
+    end
+
+    def pcpu
+      @wstats['pcpu']
+    end
+
+    def running
+      @wstats.dig('last_status', 'running') || @wstats['running'] || 0
+    end
+    alias :total_threads :running
+
+    def pool_capacity
+      @wstats.dig('last_status', 'pool_capacity') || @wstats['pool_capacity'] || 0
+    end
+
+    def running_threads
+      running - pool_capacity
+    end
+
+    def load
+      running_threads/total_threads.to_f*100
+    end
+
+    def uptime
+      (Time.now - Time.parse(@wstats['started_at'])).to_i
+    end
+
+    def backlog
+      @wstats.dig('last_status', 'backlog') || 0
+    end
+
+    def last_checkin
+      (Time.now - Time.parse(@wstats['last_checkin'])).round
+    rescue
+      0
+    end
+  end
+
+  def initialize(stats)
+    @stats = stats
+  end
+
+  def workers
+    (@stats['worker_status'] || [@stats]).map { |wstats| Worker.new(wstats) }
+  end
+
+  def pid=(pid)
+    @stats['pid'] = pid
+  end
+
+  def pid
+    @stats['pid']
+  end
+
+  def state_file_path=(state_file_path)
+    @stats['state_file_path'] = state_file_path
+  end
+
+  def state_file_path
+    @stats['state_file_path']
+  end
+
+  def uptime
+    (Time.now - Time.parse(@stats['started_at'])).to_i
+  end
+
+  def total_threads
+    workers.reduce(0) { |total, wstats| total + wstats.running }
+  end
+
+  def running_threads
+    workers.reduce(0) { |total, wstats| total + (wstats.running - wstats.pool_capacity) }
+  end
+
+  def running
+    @stats['running'] || 0
+  end
+
+  def pool_capacity
+    @stats['pool_capacity'] || 0
+  end
+
+  def load
+    running_threads/total_threads.to_f*100
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: puma-status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoann Lecuyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: net_http_unix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email: 
+executables:
+- puma-status
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/puma-status
+- lib/core.rb
+- lib/helpers.rb
+- lib/puma-status.rb
+- lib/stats.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Display puma status of running puma server
+test_files: []