process-metrics 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42d11b0f2e725706c447c1b4cfa3f15a961f759fb8cacf0ef0d238338c3be6ab
-  data.tar.gz: 80468efcb1b3eab151f8fcf0d054d93d11dcd90127ec70a6ad63e5fc10b68f89
+  metadata.gz: cbfff6ee5c7b2f09e1872bfaf86b520d999c94295de8d2328140ffeb84baa228
+  data.tar.gz: 2318ca3ac6a699863015b0f4ac32d22ee8845466f7046feee0155e89b9c5c5a8
 SHA512:
-  metadata.gz: 5c765d57991e1a15e8c966ea1497234dae6e8e98cdd8e2463cefe1caf046770b1930b01b68b202b7ace9d802ad6d0577dfbb3cfef48a1d23abc3013ea5a48580
-  data.tar.gz: 8c2bf4692a659037dc8167ad7f3349beb300e4bf021ee97b8ed3bf645cc83eaeefa19ae6ef5aee62855d781f7782ab9750d3999ca21982b865c24afbb65a0be5
+  metadata.gz: b4a69c2cc8a4055fcb9cd3612459b4e1a1164b8a4ac4095dafc8e7b51126915c79673b6023bc09f87357d69ac0aaf71e0caae9c2d3dd6a4fd3a7f8482d368b00
+  data.tar.gz: 17363223b2c6858e5f2e0241267e6dbaf6e97f58631483ef95af6fd7ad349d59915a8e486a27011a259c64f290f4da8ced1ea96e47bb3d0eb193c877ffdf2591

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

@@ -44,6 +44,8 @@ module Process
 				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 "--total-memory <integer>", "Set the total memory relative to the usage (MiB).", type: Integer
 				end
 				
 				def terminal
@@ -87,7 +89,7 @@ module Process
 					return "#{value.round(unit)}#{units[unit]}"
 				end
 				
-				def format_memory_usage(value, total, terminal)
+				def format_memory(value, total, terminal)
 					if value > (total * 0.8)
 						intensity = :high
 					elsif value > (total * 0.5)
@@ -101,23 +103,23 @@ module Process
 					terminal.print(formatted, intensity, "[", Bar.format(value / total.to_f, 60), "]", :reset)
 				end
 				
+				def total_memory
+					if total_memory = @options[:total_memory]
+						return total_memory * 1024
+					else
+						return Process::Metrics::Memory.total_size
+					end
+				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
-					shared_memory_usage = 0
-					private_memory_usage = 0
-					total_memory_usage = 0
-					
-					summary.each do |pid, general|
-						if memory = general.memory
-							total_memory_usage += memory.proportional_size + memory.unique_size
-						else
-							total_memory_usage += general.resident_size
-						end
-					end
+					format_memory = self.method(:format_memory).curry
+					shared_memory = 0
+					private_memory = 0
+					total_memory = self.total_memory
 					
 					proportional = true
 					
@@ -129,25 +131,25 @@ module Process
 						terminal.print_line
 						
 						if memory = general.memory
-							shared_memory_usage += memory.proportional_size
-							private_memory_usage += memory.unique_size
+							shared_memory += memory.proportional_size
+							private_memory += memory.unique_size
 							
 							terminal.print_line(
-								:key, "Shared Memory: ".rjust(20), :reset,
-								format_memory_usage[memory.proportional_size, total_memory_usage]
+								:key, "Memory: ".rjust(20), :reset,
+								format_memory[memory.proportional_size, total_memory]
 							)
 							
 							terminal.print_line(
 								:key, "Private Memory: ".rjust(20), :reset,
-								format_memory_usage[memory.unique_size, total_memory_usage]
+								format_memory[memory.unique_size, total_memory]
 							)
 						else
-							shared_memory_usage += general.resident_size
+							shared_memory += general.resident_size
 							proportional = false
 							
 							terminal.print_line(
 								:key, "Memory: ".rjust(20), :reset,
-								format_memory_usage[general.resident_size, total_memory_usage]
+								format_memory[general.resident_size, total_memory]
 							)
 						end
 					end
@@ -156,24 +158,24 @@ module Process
 					
 					if proportional
 						terminal.print_line(
-							:key, "Shared Memory: ".rjust(20), :reset,
-							format_memory_usage[shared_memory_usage, total_memory_usage]
+							:key, "Memory: ".rjust(20), :reset,
+							format_memory[shared_memory, total_memory]
 						)
 						
 						terminal.print_line(
 							:key, "Private Memory: ".rjust(20), :reset,
-							format_memory_usage[private_memory_usage, total_memory_usage]
+							format_memory[private_memory, total_memory]
 						)
 					else
 						terminal.print_line(
 							:key, "Memory: ".rjust(20), :reset,
-							format_memory_usage[memory_usage, total_memory_usage]
+							format_memory[memory, total_memory]
 						)
 					end
 					
 					terminal.print_line(
 						:key, "Memory (Total): ".rjust(20), :reset,
-						format_memory_usage[shared_memory_usage + private_memory_usage, total_memory_usage]
+						format_memory[shared_memory + private_memory, total_memory]
 					)
 				end
 			end

data/lib/process/metrics/general.rb

@@ -113,8 +113,10 @@ module Process
 			end
 			
 			def self.capture_memory(processes)
+				count = processes.size
+				
 				processes.each do |pid, process|
-					process.memory = Memory.capture(Array(pid))
+					process.memory = Memory.capture(pid, count: count)
 				end
 			end
 			

data/lib/process/metrics/memory/darwin.rb

@@ -13,6 +13,18 @@ module Process
 				File.executable?(VMMAP)
 			end
 			
+			# @returns [Numeric] Total memory size in kilobytes.
+			def self.total_size
+				# sysctl hw.memsize
+				IO.popen(["sysctl", "hw.memsize"], "r") do |io|
+					io.each_line do |line|
+						if line =~ /hw.memsize: (\d+)/
+							return $1.to_i / 1024
+						end
+					end
+				end
+			end
+			
 			# Parse a size string into kilobytes.
 			def self.parse_size(string)
 				return 0 unless string
@@ -35,51 +47,45 @@ module Process
 			/x
 			
 			# Capture memory usage for the given process IDs.
-			def self.capture(pids)
+			def self.capture(pid, count: 1, **options)
 				usage = Memory.zero
 				
-				pids.each do |pid|
-					IO.popen(["vmmap", pid.to_s], "r") do |io|
-						io.each_line do |line|
-							if match = LINE.match(line)
-								virtual_size = parse_size(match[:virtual_size])
-								resident_size = parse_size(match[:resident_size])
-								dirty_size = parse_size(match[:dirty_size])
-								swap_size = parse_size(match[:swap_size])
-								
-								# puts [match[:region_name], virtual_size, resident_size, dirty_size, swap_size, match[:permissions], match[:sharing_mode]].join(",")
-								
-								# Update counts
-								usage.map_count += 1
-								usage.resident_size += resident_size
-								usage.swap_size += swap_size
-								
-								# Private vs. Shared memory
-								# COW=copy_on_write PRV=private NUL=empty ALI=aliased 
-								# SHM=shared ZER=zero_filled S/A=shared_alias
-								case match[:sharing_mode]
-								when "PRV"
-									usage.private_clean_size += resident_size - dirty_size
-									usage.private_dirty_size += dirty_size
-								when "COW", "SHM"
-									usage.shared_clean_size += resident_size - dirty_size
-									usage.shared_dirty_size += dirty_size
-								end
-								
-								# Anonymous memory: no region detail path or special names
-								if match[:region_name] =~ /MALLOC|VM_ALLOCATE|Stack|STACK|anonymous/
-									usage.anonymous_size += resident_size
-								end
-								# else
-								# 	puts "Failed to match line: #{line}"
+				IO.popen(["vmmap", pid.to_s], "r") do |io|
+					io.each_line do |line|
+						if match = LINE.match(line)
+							virtual_size = parse_size(match[:virtual_size])
+							resident_size = parse_size(match[:resident_size])
+							dirty_size = parse_size(match[:dirty_size])
+							swap_size = parse_size(match[:swap_size])
+							
+							# Update counts
+							usage.map_count += 1
+							usage.resident_size += resident_size
+							usage.swap_size += swap_size
+							
+							# Private vs. Shared memory
+							# COW=copy_on_write PRV=private NUL=empty ALI=aliased 
+							# SHM=shared ZER=zero_filled S/A=shared_alias
+							case match[:sharing_mode]
+							when "PRV"
+								usage.private_clean_size += resident_size - dirty_size
+								usage.private_dirty_size += dirty_size
+							when "COW", "SHM"
+								usage.shared_clean_size += resident_size - dirty_size
+								usage.shared_dirty_size += dirty_size
+							end
+							
+							# Anonymous memory: no region detail path or special names
+							if match[:region_name] =~ /MALLOC|VM_ALLOCATE|Stack|STACK|anonymous/
+								usage.anonymous_size += resident_size
 							end
 						end
 					end
 				end
 				
-				# On Darwin, we cannot compute the proportional size, so we just set it to the resident size.
-				usage.proportional_size = usage.resident_size
-				usage.proportional_swap_size = usage.swap_size
+				# Darwin does not expose proportional memory usage, so we guess based on the number of processes. Yes, this is a terrible hack, but it's the most reasonable thing to do given the constraints:
+				usage.proportional_size = usage.resident_size / count
+				usage.proportional_swap_size = usage.swap_size / count
 				
 				return usage
 			end
@@ -91,8 +97,12 @@ module Process
 					return true
 				end
 				
-				def capture(pids)
-					return Memory::Darwin.capture(pids)
+				def total_size
+					return Memory::Darwin.total_size
+				end
+				
+				def capture(...)
+					return Memory::Darwin.capture(...)
 				end
 			end
 		end

data/lib/process/metrics/memory/linux.rb

@@ -6,6 +6,15 @@
 module Process
 	module Metrics
 		class Memory::Linux
+			# @returns [Numeric] Total memory size in kilobytes.
+			def self.total_size
+				File.read("/proc/meminfo").each_line do |line|
+					if /MemTotal:\s+(?<total>\d+) kB/ =~ line
+						return total.to_i
+					end
+				end
+			end
+			
 			# The fields that will be extracted from the `smaps` data.
 			SMAP = {
 				"Rss" => :resident_size,
@@ -53,10 +62,10 @@ module Process
 				end
 				
 				# Capture memory usage for the given process IDs.
-				def self.capture(pids)
+				def self.capture(pid, **options)
 					usage = Memory.zero
 					
-					pids.each do |pid|
+					begin
 						File.foreach("/proc/#{pid}/smaps") do |line|
 							# The format of this is fixed according to:
 							# https://github.com/torvalds/linux/blob/351c8a09b00b5c51c8f58b016fffe51f87e2d820/fs/proc/task_mmu.c#L804-L814
@@ -89,8 +98,12 @@ module Process
 					return true
 				end
 				
-				def capture(pids)
-					return Memory::Linux.capture(pids)
+				def total_size
+					return Memory::Linux.total_size
+				end
+				
+				def capture(...)
+					return Memory::Linux.capture(...)
 				end
 			end
 		end

data/lib/process/metrics/memory.rb

@@ -37,7 +37,7 @@ module Process
 			end
 			
 			# Capture memory usage for the given process IDs.
-			def self.capture(pids)
+			def self.capture(pid, **options)
 				return nil
 			end
 		end

data/lib/process/metrics/version.rb

@@ -5,6 +5,6 @@
 
 module Process
 	module Metrics
-		VERSION = "0.4.0"
+		VERSION = "0.5.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process-metrics
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams