process-metrics 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6eef8073c3bde206609e197c710ff0a3a7b5bb100b9e7e3081ceb1a3cafad4d
-  data.tar.gz: 8861bf2052c3cd39bc0e1d75682538efdce0c6bc6bbb444a44a4a12a8bbc23bd
+  metadata.gz: 7cec50409b679c3cb38ad2951f012f9ec80ebd932af96a27aa8e443724b6f08b
+  data.tar.gz: e93c274723c0a744b9b27d38f20e7ca7c430b33ad804d55f706d3ceda30b95b8
 SHA512:
-  metadata.gz: 48118f047e6b37cae47ab65b5486c63009efc60379eeaf984bb0076e0a2890ff3be3e4ee6ded12d32dc3e18b805bb04564c590ad6233bef666b8238e88de76d4
-  data.tar.gz: 21c7a27dc3494df5a7ae7fa830af1bfe8d7989b388534e0b7b6bac1bd4416168a927e7efcfe13faba5abb369ec6ae51181d039f294b614166096a46ad88797b0
+  metadata.gz: c81cee9bea7a96472e8e649f6695fafeff89d6c129c0fbc967f4fecac94a5e52818225992d9cce94e75c43abbed8877c1a5da186f14aae3cc56d085c1651c2f2
+  data.tar.gz: 72694d4aa9dd22d9b9f3ec82bd66586119c1fc6be7edb278c5263279004b551c0a1d8b7364ab5877d503828d904aab9f58206d72fbec65b5d59ce518e01a36f3

data/README.md

@@ -133,6 +133,18 @@ pp metrics
 # ... snip ...
 ```
 
+### Metrics
+
+On some platforms (currently only Linux), additional memory metrics are captured.
+
+#### Proportional Set Size
+
+The total private memory usage + shared memory usage divided by the number of processes sharing said data.
+
+#### Unique Set Size
+
+The total private memory usage.
+
 ## Contributing
 
 1. Fork it

data/bin/process-metrics

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative '../lib/process/metrics/command'
+
+begin
+	Process::Metrics::Command.call
+rescue Interrupt
+end

data/lib/process/metrics/command.rb

@@ -0,0 +1,31 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'command/top'
+
+module Process
+	module Metrics
+		module Command
+			def self.call(*arguments)
+				Top.call(*arguments)
+			end
+		end
+	end
+end

data/lib/process/metrics/command/summary.rb

@@ -0,0 +1,177 @@
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'samovar'
+
+require_relative '../general'
+
+require 'console/terminal'
+
+module Process
+	module Metrics
+		module Command
+			module Bar
+				BLOCK = [
+					" ",
+					"▏",
+					"▎",
+					"▍",
+					"▌",
+					"▋",
+					"▊",
+					"▉",
+					"█",
+				]
+				
+				def self.format(value, width)
+					blocks = width * value
+					full_blocks = blocks.floor
+					partial_block = ((blocks - full_blocks) * BLOCK.size).floor
+					
+					if partial_block.zero?
+						BLOCK.last * full_blocks
+					else
+						"#{BLOCK.last * full_blocks}#{BLOCK[partial_block]}"
+					end.ljust(width)
+				end
+			end
+			
+			class Summary < Samovar::Command
+				self.description = "Display a summary of memory usage statistics."
+				
+				options do
+					option '--pid <integer>', "Report on a single process id.", type: Integer, required: true
+					option '-p/--ppid <integer>', "Report on all children of this process id.", type: Integer, required: true
+					
+					option '--memory-scale <integer>', "Scale maximum memory usage to the specified amount (MiB).", type: Integer, default: 512
+				end
+				
+				def terminal
+					terminal = Console::Terminal.for($stdout)
+					
+					# terminal[:pid] = terminal.style(:blue)
+					terminal[:command] = terminal.style(nil, nil, :bold)
+					terminal[:key] = terminal.style(:cyan)
+					
+					terminal[:low] = terminal.style(:green)
+					terminal[:medium] = terminal.style(:yellow)
+					terminal[:high] = terminal.style(:red)
+					
+					return terminal
+				end
+				
+				def format_pcpu(value, terminal)
+					if value > 80.0
+						intensity = :high
+					elsif value > 50.0
+						intensity = :medium
+					else
+						intensity = :low
+					end
+					
+					formatted = "%5.1f%% " % value
+					
+					terminal.print(formatted.rjust(10), intensity, "[", Bar.format(value / 100.0, 60), "]", :reset)
+				end
+				
+				UNITS = ["KiB", "MiB", "GiB"]
+				
+				def format_size(value, units: UNITS)
+					unit = 0
+					
+					while value > 1024.0 && unit < units.size
+						value /= 1024.0
+						unit += 1
+					end
+					
+					return "#{value.round(unit)}#{units[unit]}"
+				end
+				
+				def format_memory_usage(value, terminal, scale: @options[:memory_scale])
+					if value > (1024.0 * scale * 0.8)
+						intensity = :high
+					elsif value > (1024.0 * scale * 0.5)
+						intensity = :medium
+					else
+						intensity = :low
+					end
+					
+					formatted = (format_size(value) + ' ').rjust(10)
+					
+					terminal.print(formatted, intensity, "[", Bar.format(value / (1024.0 * scale), 60), "]", :reset)
+				end
+				
+				def call
+					terminal = self.terminal
+					
+					summary = Process::Metrics::General.capture(pid: @options[:pid], ppid: @options[:ppid])
+					
+					format_memory_usage = self.method(:format_memory_usage).curry
+					memory_usage = 0
+					proportional = true
+					
+					summary.each do |pid, general|
+						terminal.print_line(:pid, pid, :reset, " ", :command, general[:command])
+						
+						terminal.print(:key, "Processor Usage: ".rjust(20), :reset)
+						format_pcpu(general.pcpu, terminal)
+						terminal.print_line
+						
+						if memory = general.memory
+							memory_usage += memory.proportional_size
+							
+							terminal.print_line(
+								:key, "Memory (PSS): ".rjust(20), :reset,
+								format_memory_usage[memory.proportional_size]
+							)
+							
+							terminal.print_line(
+								:key, "Private (USS): ".rjust(20), :reset,
+								format_memory_usage[memory.unique_size]
+							)
+						else
+							memory_usage += general.rsz
+							proportional = false
+							
+							terminal.print_line(
+								:key, "Memory (RSS): ".rjust(20), :reset,
+								format_memory_usage[general.rsz]
+							)
+						end
+					end
+					
+					terminal.print_line("Summary")
+					
+					if proportional
+						terminal.print_line(
+							:key, "Memory (PSS): ".rjust(20), :reset,
+							format_memory_usage[memory_usage]
+						)
+					else
+						terminal.print_line(
+							:key, "Memory (RSS): ".rjust(20), :reset,
+							format_memory_usage[memory_usage]
+						)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/process/metrics/command/top.rb

@@ -0,0 +1,53 @@
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'samovar'
+
+require_relative 'summary'
+require_relative '../version'
+
+module Process
+	module Metrics
+		module Command
+			class Top < Samovar::Command
+				self.description = "Collect memory usage statistics."
+				
+				options do
+					option '-h/--help', "Print out help information."
+					option '-v/--version', "Print out the application version."
+				end
+				
+				nested :command, {
+					'summary' => Summary,
+				}, default: 'summary'
+				
+				def call
+					if @options[:version]
+						puts "#{self.name} v#{VERSION}"
+					elsif @options[:help]
+						self.print_usage
+					else
+						@command.call
+					end
+				end
+			end
+		end
+	end
+end

data/lib/process/metrics/general.rb

@@ -49,86 +49,131 @@ module Process
 			pcpu: ->(value){value.to_f},
 			time: self.method(:duration),
 			vsz: ->(value){value.to_i},
-			rss: ->(value){value.to_i},
+			rsz: ->(value){value.to_i},
 			etime: self.method(:duration),
 			command: ->(value){value},
 		}
 		
-		def self.set(ids)
-			Set.new(Array(ids))
-		end
-		
-		def self.expand_children(children, hierarchy, pids)
-			children.each do |pid|
-				self.expand(pid, hierarchy, pids)
+		class General < Struct.new(:pid, :ppid, :pgid, :pcpu, :vsz, :rsz, :time, :etime, :command, :memory)
+			def as_json
+				{
+					pid: self.pid,
+					ppid: self.ppid,
+					pgid: self.pgid,
+					pcpu: self.pcpu,
+					vsz: self.vsz,
+					rsz: self.rsz,
+					time: self.time,
+					etime: self.etime,
+					command: self.command,
+					memory: self.memory&.as_json,
+				}
 			end
-		end
-		
-		def self.expand(pid, hierarchy, pids)
-			unless pids.include?(pid)
-				pids << pid
-				
-				if children = hierarchy.fetch(pid, nil)
-					self.expand_children(children, hierarchy, pids)
-				end
-			end
-		end
-		
-		def self.capture(pid: nil, ppid: nil, ps: PS, fields: FIELDS)
-			input, output = IO.pipe
 			
-			arguments = [ps]
-			
-			if pid && ppid.nil?
-				arguments.push("-p", Array(pid).join(','))
-			else
-				arguments.push("ax")
+			def to_json(*arguments)
+				as_json.to_json(*arguments)
 			end
 			
-			arguments.push("-o", fields.keys.join(','))
-			
-			ps_pid = Process.spawn(*arguments, out: output, pgroup: true)
-			
-			output.close
+			def memory_usage
+				if self.memory
+					self.memory.proportional_size
+				else
+					self.rsz
+				end
+			end
 			
-			header, *lines = input.readlines.map(&:strip)
+			def self.expand_children(children, hierarchy, pids)
+				children.each do |pid|
+					self.expand(pid, hierarchy, pids)
+				end
+			end
 			
-			processes = lines.map do |line|
-				fields.
-					zip(line.split(/\s+/, fields.size)).
-					map{|(key, type), value| [key, type.call(value)]}.
-					to_h
+			def self.expand(pid, hierarchy, pids)
+				unless pids.include?(pid)
+					pids << pid
+					
+					if children = hierarchy.fetch(pid, nil)
+						self.expand_children(children, hierarchy, pids)
+					end
+				end
 			end
 			
-			if ppid
-				pids = Set.new
+			def self.build_tree(processes)
 				hierarchy = Hash.new{|h,k| h[k] = []}
 				
-				processes.each do |process|
-					unless process[:pid] == ps_pid
-						hierarchy[process[:ppid]] << process[:pid]
+				processes.each_value do |process|
+					if ppid = process.ppid
+						hierarchy[ppid] << process.pid
 					end
 				end
 				
-				self.expand_children(Array(pid), hierarchy, pids)
-				self.expand_children(Array(ppid), hierarchy, pids)
-				
-				processes.select! do |process|
-					pids.include?(process[:pid])
+				return hierarchy
+			end
+			
+			def self.capture_memory(processes)
+				processes.each do |pid, process|
+					process.memory = Memory.capture(Array(pid))
 				end
 			end
 			
-			if Memory.supported?
-				processes.each do |process|
-					if pid = process[:pid]
-						process[:memory] = Memory.capture(Array(process[:pid]))
+			def self.capture(pid: nil, ppid: nil, ps: PS, fields: FIELDS)
+				input, output = IO.pipe
+				
+				arguments = [ps]
+				
+				if pid && ppid.nil?
+					arguments.push("-p", Array(pid).join(','))
+				else
+					arguments.push("ax")
+				end
+				
+				arguments.push("-o", fields.keys.join(','))
+				
+				ps_pid = Process.spawn(*arguments, out: output, pgroup: true)
+				
+				output.close
+				
+				header, *lines = input.readlines.map(&:strip)
+				
+				processes = {}
+				
+				lines.map do |line|
+					record = fields.
+						zip(line.split(/\s+/, fields.size)).
+						map{|(key, type), value| type.call(value)}
+					
+					instance = self.new(*record)
+					
+					processes[instance.pid] = instance
+				end
+				
+				if ppid
+					pids = Set.new
+					
+					hierarchy = self.build_tree(processes)
+					
+					self.expand_children(Array(pid), hierarchy, pids)
+					self.expand_children(Array(ppid), hierarchy, pids)
+					
+					processes.select! do |pid, process|
+						if pid != ps_pid
+							pids.include?(pid)
+						end
 					end
 				end
+				
+				if Memory.supported?
+					self.capture_memory(processes)
+					
+					# if pid
+					# 	self.compute_summary(pid, processes)
+					# end
+				end
+				
+				return processes
+			ensure
+				Process.wait(ps_pid) if ps_pid
 			end
-			
-			return processes
-		ensure
-			Process.wait(ps_pid) if ps_pid
 		end
 	end
 end

data/lib/process/metrics/memory.rb

@@ -22,28 +22,40 @@
 
 module Process
 	module Metrics
-		module Memory
+		class Memory < Struct.new(:map_count, :total_size, :resident_size, :proportional_size, :shared_clean_size, :shared_dirty_size, :private_clean_size, :private_dirty_size, :referenced_size, :anonymous_size, :swap_size, :proportional_swap_size)
+			
+			alias as_json to_h
+			
+			def to_json(*arguments)
+				as_json.to_json(*arguments)
+			end
+			
+			# The unique set size, the size of completely private (unshared) data.
+			def unique_size
+				self.private_clean_size + self.private_dirty_size
+			end
+			
 			if File.readable?('/proc/self/smaps')
 				def self.supported?
 					true
 				end
 				
 				MAP = {
-					"Size" => :total,
-					"Rss" => :rss,
-					"Pss" => :pss,
-					"Shared_Clean" => :shared_clean,
-					"Shared_Dirty" => :shared_dirty,
-					"Private_Clean" => :private_clean,
-					"Private_Dirty" => :private_dirty,
-					"Referenced" => :referenced,
-					"Anonymous" => :anonymous,
-					"Swap" => :swap,
-					"SwapPss" => :swap_pss,
+					"Size" => :total_size,
+					"Rss" => :resident_size,
+					"Pss" => :proportional_size,
+					"Shared_Clean" => :shared_clean_size,
+					"Shared_Dirty" => :shared_dirty_size,
+					"Private_Clean" => :private_clean_size,
+					"Private_Dirty" => :private_dirty_size,
+					"Referenced" => :referenced_size,
+					"Anonymous" => :anonymous_size,
+					"Swap" => :swap_size,
+					"SwapPss" => :proportional_swap_size,
 				}
 				
 				def self.capture(pids)
-					usage = Hash.new{|h,k| h[k] = 0}
+					usage = self.new(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
 					
 					pids.each do |pid|
 						if lines = File.readlines("/proc/#{pid}/smaps")
@@ -57,13 +69,13 @@ module Process
 								elsif /VmFlags:\s+(?<flags>.*)/ =~ line
 									# It should be possible to extract the number of fibers and each fiber's memory usage.
 									# flags = flags.split(/\s+/)
-									usage[:maps] += 1
+									usage.map_count += 1
 								end
 							end
 						end
 					end
 					
-					return usage.freeze
+					return usage
 				end
 			else
 				def self.supported?
@@ -71,6 +83,7 @@ module Process
 				end
 				
 				def self.capture(pids)
+					return self.new
 				end
 			end
 		end

data/lib/process/metrics/version.rb

@@ -22,6 +22,6 @@
 
 module Process
 	module Metrics
-		VERSION = "0.1.1"
+		VERSION = "0.2.0"
 	end
 end

data/process-metrics.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
 	spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
+	spec.add_dependency "console", "~> 1.8"
+	
 	spec.add_development_dependency "covered"
 	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rake", "~> 12.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: process-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2020-02-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: covered
   requirement: !ruby/object:Gem::Requirement
@@ -70,8 +84,7 @@ description:
 email:
 - samuel.williams@oriontransfer.co.nz
 executables:
-- console
-- setup
+- process-metrics
 extensions: []
 extra_rdoc_files: []
 files:
@@ -81,9 +94,11 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/process-metrics
 - lib/process/metrics.rb
+- lib/process/metrics/command.rb
+- lib/process/metrics/command/summary.rb
+- lib/process/metrics/command/top.rb
 - lib/process/metrics/general.rb
 - lib/process/metrics/memory.rb
 - lib/process/metrics/version.rb
@@ -108,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Provide detailed OS-specific process metrics.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "process/metrics"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here