process-metrics 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cec50409b679c3cb38ad2951f012f9ec80ebd932af96a27aa8e443724b6f08b
-  data.tar.gz: e93c274723c0a744b9b27d38f20e7ca7c430b33ad804d55f706d3ceda30b95b8
+  metadata.gz: 1dfdad473ae6b2f7680c1c62bf67144c0451014c61e6a4d9c38650d2b51dcc86
+  data.tar.gz: 5938c811e5b7cab7d849b9430236bd60712158fe744ee5b494e3d01f0ed49997
 SHA512:
-  metadata.gz: c81cee9bea7a96472e8e649f6695fafeff89d6c129c0fbc967f4fecac94a5e52818225992d9cce94e75c43abbed8877c1a5da186f14aae3cc56d085c1651c2f2
-  data.tar.gz: 72694d4aa9dd22d9b9f3ec82bd66586119c1fc6be7edb278c5263279004b551c0a1d8b7364ab5877d503828d904aab9f58206d72fbec65b5d59ce518e01a36f3
+  metadata.gz: 2c607a0f1eb78abe097463ebd46784f2212b60b6bc5590dff646aecac131e5da59eb0e3a5ea082943c66d3fc0cb4425d19abb3596ed0350aec51718ac6fb4244
+  data.tar.gz: 420abffc1c85856674376cf95455972e58a18b18591ccc003be3e0d9bad6212d17587d93e10c0ec06691c60c187ba43e80af472c8c74be619f4e06f370780d3d

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+l���Ҫ�+n��VT��*�[��p5�-�Ǭ��췯����
���u�,�﫢�o1L̑��lH	��U�i�rE+�56��V���8�4*haM�[��6]���G
�	3L.N>�ڌ����|c<�LN�{S����ֻ:(�$�h�vN{���4�� ����KkA�����[wӢ�9�u9JE�m1�t�������v\_Li�`�ШY�;;�Q�8�ѿ[|����C�X�[~dz��?�5t-�S#0��K_�lL����B51V�`9��6�3,� p��w%1�?�-���4<ziY��Du�!"@ /e/J��(����U��[|��\��V���?QC��D�u�~D�q�(�!�]�������oj"$
+0T0��y4��z���

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

@@ -1,22 +1,7 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require 'samovar'
 
@@ -77,7 +62,7 @@ module Process
 					return terminal
 				end
 				
-				def format_pcpu(value, terminal)
+				def format_processor_utilization(value, terminal)
 					if value > 80.0
 						intensity = :high
 					elsif value > 50.0
@@ -124,18 +109,21 @@ module Process
 					summary = Process::Metrics::General.capture(pid: @options[:pid], ppid: @options[:ppid])
 					
 					format_memory_usage = self.method(:format_memory_usage).curry
-					memory_usage = 0
+					shared_memory_usage = 0
+					private_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)
+						format_processor_utilization(general.processor_utilization, terminal)
 						terminal.print_line
 						
 						if memory = general.memory
-							memory_usage += memory.proportional_size
+							shared_memory_usage += memory.proportional_size
+							private_memory_usage += memory.unique_size
 							
 							terminal.print_line(
 								:key, "Memory (PSS): ".rjust(20), :reset,
@@ -147,12 +135,12 @@ module Process
 								format_memory_usage[memory.unique_size]
 							)
 						else
-							memory_usage += general.rsz
+							shared_memory_usage += general.rss
 							proportional = false
 							
 							terminal.print_line(
 								:key, "Memory (RSS): ".rjust(20), :reset,
-								format_memory_usage[general.rsz]
+								format_memory_usage[general.rss]
 							)
 						end
 					end
@@ -162,7 +150,12 @@ module Process
 					if proportional
 						terminal.print_line(
 							:key, "Memory (PSS): ".rjust(20), :reset,
-							format_memory_usage[memory_usage]
+							format_memory_usage[shared_memory_usage]
+						)
+						
+						terminal.print_line(
+							:key, "Memory (USS): ".rjust(20), :reset,
+							format_memory_usage[private_memory_usage]
 						)
 					else
 						terminal.print_line(
@@ -170,6 +163,11 @@ module Process
 							format_memory_usage[memory_usage]
 						)
 					end
+					
+					terminal.print_line(
+						:key, "Memory (Total): ".rjust(20), :reset,
+						format_memory_usage[shared_memory_usage + private_memory_usage]
+					)
 				end
 			end
 		end

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

@@ -1,22 +1,7 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require 'samovar'
 

data/lib/process/metrics/command.rb

@@ -1,22 +1,7 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require_relative 'command/top'
 

data/lib/process/metrics/general.rb

@@ -1,32 +1,17 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <https://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.
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'memory'
 require 'set'
+require 'json'
 
 module Process
 	module Metrics
 		PS = "ps"
 		
+		# Parse a duration string into seconds.
 		# According to the linux manual page specifications.
 		def self.duration(value)
 			if /((?<days>\d\d)\-)?((?<hours>\d\d):)?(?<minutes>\d\d):(?<seconds>\d\d)?/ =~ value
@@ -34,54 +19,54 @@ module Process
 			end
 		end
 		
-		# pid: Process Identifier
-		# pmem: Percentage Memory used.
-		# pcpu: Percentage Processor used.
-		# time: The process time used (executing on CPU).
-		# vsz: Virtual Size in kilobytes
-		# rss: Resident Set Size in kilobytes
-		# etime: The process elapsed time.
-		# command: The name of the process.
+		# The fields that will be extracted from the `ps` command.
 		FIELDS = {
-			pid: ->(value){value.to_i},
-			ppid: ->(value){value.to_i},
-			pgid: ->(value){value.to_i},
-			pcpu: ->(value){value.to_f},
-			time: self.method(:duration),
-			vsz: ->(value){value.to_i},
-			rsz: ->(value){value.to_i},
-			etime: self.method(:duration),
-			command: ->(value){value},
+			pid: ->(value){value.to_i}, # Process ID
+			ppid: ->(value){value.to_i}, # Parent Process ID
+			pgid: ->(value){value.to_i}, # Process Group ID
+			pcpu: ->(value){value.to_f}, # Percentage CPU
+			time: self.method(:duration), # CPU Time
+			vsz: ->(value){value.to_i}, #	Virtual Size
+			rss: ->(value){value.to_i}, # Resident Size
+			etime: self.method(:duration), # Elapsed Time
+			command: ->(value){value}, # Command (name of the process)
 		}
 		
-		class General < Struct.new(:pid, :ppid, :pgid, :pcpu, :vsz, :rsz, :time, :etime, :command, :memory)
+		# General process information.
+		class General < Struct.new(:process_id, :parent_process_id, :process_group_id, :processor_utilization, :virtual_size, :resident_size, :processor_time, :elapsed_time, :command, :memory)
+			# Convert the object to a JSON serializable hash.
 			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,
+					process_id: self.process_id,
+					parent_process_id: self.parent_process_id,
+					process_group_id: self.process_group_id,
+					processor_utilization: self.processor_utilization,
+					total_size: self.total_size,
+					virtual_size: self.virtual_size,
+					resident_size: self.resident_size,
+					processor_time: self.processor_time,
+					elapsed_time: self.elapsed_time,
 					command: self.command,
 					memory: self.memory&.as_json,
 				}
 			end
 			
+			# Convert the object to a JSON string.
 			def to_json(*arguments)
 				as_json.to_json(*arguments)
 			end
 			
-			def memory_usage
-				if self.memory
-					self.memory.proportional_size
+			# The general memory usage of the process using the best available information.
+			def total_size
+				if memory = self.memory
+					memory.proportional_size
 				else
-					self.rsz
+					self.resident_size
 				end
 			end
 			
+			alias memory_usage total_size
+			
 			def self.expand_children(children, hierarchy, pids)
 				children.each do |pid|
 					self.expand(pid, hierarchy, pids)
@@ -102,8 +87,8 @@ module Process
 				hierarchy = Hash.new{|h,k| h[k] = []}
 				
 				processes.each_value do |process|
-					if ppid = process.ppid
-						hierarchy[ppid] << process.pid
+					if parent_process_id = process.parent_process_id
+						hierarchy[parent_process_id] << process.process_id
 					end
 				end
 				
@@ -116,7 +101,11 @@ module Process
 				end
 			end
 			
-			def self.capture(pid: nil, ppid: nil, ps: PS, fields: FIELDS)
+			# Capture process information. If given a `pid`, it will capture the details of that process. If given a `ppid`, it will capture the details of all child processes. Specify both `pid` and `ppid` if you want to capture a process and all its children.
+			#
+			# @parameter pid [Integer] The process ID to capture.
+			# @parameter ppid [Integer] The parent process ID to capture.
+			def self.capture(pid: nil, ppid: nil, ps: PS)
 				input, output = IO.pipe
 				
 				arguments = [ps]
@@ -127,7 +116,7 @@ module Process
 					arguments.push("ax")
 				end
 				
-				arguments.push("-o", fields.keys.join(','))
+				arguments.push("-o", FIELDS.keys.join(','))
 				
 				ps_pid = Process.spawn(*arguments, out: output, pgroup: true)
 				
@@ -138,13 +127,13 @@ module Process
 				processes = {}
 				
 				lines.map do |line|
-					record = fields.
-						zip(line.split(/\s+/, fields.size)).
+					record = FIELDS.
+						zip(line.split(/\s+/, FIELDS.size)).
 						map{|(key, type), value| type.call(value)}
 					
 					instance = self.new(*record)
 					
-					processes[instance.pid] = instance
+					processes[instance.process_id] = instance
 				end
 				
 				if ppid

data/lib/process/metrics/memory.rb

@@ -1,87 +1,108 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <https://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.
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+
+require 'json'
 
 module Process
 	module Metrics
-		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)
+		class Memory < Struct.new(:map_count, :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
 			
+			# Convert the object to a JSON string.
 			def to_json(*arguments)
 				as_json.to_json(*arguments)
 			end
 			
+			# The total size of the process in memory.
+			def total_size
+				self.resident_size + self.swap_size
+			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')
+			# The fields that will be extracted from the `smaps` data.
+			MAP = {
+				"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,
+			}
+			
+			if File.readable?('/proc/self/smaps_rollup')
+				# Whether the memory usage can be captured on this system.
 				def self.supported?
 					true
 				end
 				
-				MAP = {
-					"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,
-				}
+				# Capture memory usage for the given process IDs.
+				def self.capture(pids)
+					usage = self.new(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
+					
+					pids.each do |pid|
+						File.foreach("/proc/#{pid}/smaps_rollup") do |line|
+							if /(?<name>.*?):\s+(?<value>\d+) kB/ =~ line
+								if key = MAP[name]
+									usage[key] += value.to_i
+								end
+							end
+						end
+						
+						usage.map_count += File.readlines("/proc/#{pid}/maps").size
+					rescue Errno::ENOENT => error
+						# Ignore.
+					end
+					
+					return usage
+				end
+			elsif File.readable?('/proc/self/smaps')
+				# Whether the memory usage can be captured on this system.
+				def self.supported?
+					true
+				end
 				
+				# Capture memory usage for the given process IDs.
 				def self.capture(pids)
 					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")
-							lines.each do |line|
-								# The format of this is fixed according to:
-								# https://github.com/torvalds/linux/blob/351c8a09b00b5c51c8f58b016fffe51f87e2d820/fs/proc/task_mmu.c#L804-L814
-								if /(?<name>.*?):\s+(?<value>\d+) kB/ =~ line
-									if key = MAP[name]
-										usage[key] += value.to_i
-									end
-								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.map_count += 1
+						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
+							if /(?<name>.*?):\s+(?<value>\d+) kB/ =~ line
+								if key = MAP[name]
+									usage[key] += value.to_i
 								end
+							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.map_count += 1
 							end
 						end
+					rescue Errno::ENOENT => error
+						# Ignore.
 					end
 					
 					return usage
 				end
 			else
+				# Whether the memory usage can be captured on this system.
 				def self.supported?
 					false
 				end
 				
+				# Capture memory usage for the given process IDs.
 				def self.capture(pids)
 					return self.new
 				end

data/lib/process/metrics/version.rb

@@ -1,27 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, by Samuel G. D. Williams. <https://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.
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Process
 	module Metrics
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

data/lib/process/metrics.rb

@@ -1,22 +1,7 @@
-# Copyright, 2019, by Samuel G. D. Williams. <https://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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative "metrics/version"
 require_relative "metrics/general"

data/license.md

@@ -0,0 +1,22 @@
+# MIT License
+
+Copyright, 2019-2024, by Samuel Williams.  
+Copyright, 2024, by Adam Daniels.  
+
+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/readme.md

@@ -0,0 +1,31 @@
+# Process::Metrics
+
+Extract performance and memory metrics from running processes.
+
+![Command Line Example](command-line.png)
+
+[![Development Status](https://github.com/socketry/process-metrics/workflows/Test/badge.svg)](https://github.com/socketry/process-metrics/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/process-metrics/) for more details.
+
+  - [Getting Started](https://socketry.github.io/process-metrics/guides/getting-started/index) - This guide explains how to use the `process-metrics` gem to collect and analyze process metrics including processor and memory utilization.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,14 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: process-metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+- Adam Daniels
+autorequire:
 bindir: bin
-cert_chain: []
-date: 2020-02-01 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -25,75 +55,40 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: samovar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
+        version: '2.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
+        version: '2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-description: 
+        version: '2'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables:
 - process-metrics
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
 - bin/process-metrics
 - lib/process/metrics.rb
 - lib/process/metrics/command.rb
@@ -102,13 +97,16 @@ files:
 - lib/process/metrics/general.rb
 - lib/process/metrics/memory.rb
 - lib/process/metrics/version.rb
-- process-metrics.gemspec
+- license.md
+- readme.md
 homepage: https://github.com/socketry/process-metrics
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://socketry.github.io/process-metrics/
   funding_uri: https://github.com/sponsors/ioquatix
-post_install_message: 
+  source_code_uri: https://github.com/socketry/process-metrics.git
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,15 +114,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Provide detailed OS-specific process metrics.
 test_files: []

metadata.gz.sig

@@ -0,0 +1,3 @@
+h�n1��aZ��e0w�v��Ѷ����)A�QjlX#���5�Q��_F���|��b�ӎt�
Q�&깆r���f�y-���cy�F�/J3��F��c�
�&e�:L�],p,��{o�h��#w$��3����7�1eǒ�����Yo�
+�7A�
+&&�
{	_��Wl����J҂�5H��жѨ�v��~\G�Y͇���',<�⻺X��Z���S��I��Y|�Ѳ

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/.travis.yml

@@ -1,22 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.6
-      env: COVERAGE=PartialSummary,Coveralls
-    - rvm: 2.7
-    - rvm: truffleruby
-    - rvm: jruby-head
-    - rvm: ruby-head
-    - rvm: 2.7
-      os: osx
-  allow_failures:
-    - rvm: truffleruby
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in process-metrics.gemspec
-gemspec

data/README.md

@@ -1,178 +0,0 @@
-# Process::Metrics
-
-Extract performance and memory metrics from running processes.
-
-[![Build Status](https://travis-ci.com/socketry/process-metrics.svg)](https://travis-ci.com/socketry/process-metrics)
-
-## Installation
-
-To add it to your current project:
-
-	bundle add process-metrics
-
-## Usage
-
-Memory is measured in kilobytes and time is measured in seconds.
-
-### Capturing for Specific Process
-
-You can capture the metrics for a single process:
-
-```ruby
-#!/usr/bin/env ruby
-
-require 'process/metrics'
-
-metrics = Process::Metrics.capture(pid: Process.pid)
-
-pp metrics
-# [{:pid=>282195,
-#   :ppid=>230572,
-#   :pgid=>282195,
-#   :pcpu=>0.0,
-#   :time=>0,
-#   :vsz=>78800,
-#   :rss=>14360,
-#   :etime=>0,
-#   :command=>"ruby /tmp/6b35f421-4595-45d6-b444-754a50636daf",
-#   :memory=>
-#    {:total=>78804,
-#     :rss=>14600,
-#     :pss=>9208,
-#     :shared_clean=>5728,
-#     :shared_dirty=>0,
-#     :private_clean=>16,
-#     :private_dirty=>8856,
-#     :referenced=>14600,
-#     :anonymous=>8856,
-#     :swap=>0,
-#     :swap_pss=>0,
-#     :maps=>150}}]
-```
-
-### Capturing for Process Hierarchy
-
-You can capture the metrics for a process and all it's children:
-
-```ruby
-#!/usr/bin/env ruby
-
-require 'process/metrics'
-
-ppid = ENV["PPID"].to_i
-metrics = Process::Metrics.capture(pid: ppid, ppid: ppid)
-
-pp metrics
-# [{:pid=>68536,
-#   :ppid=>46295,
-#   :pgid=>68536,
-#   :pcpu=>0.0,
-#   :time=>0,
-#   :vsz=>94516,
-#   :rss=>29688,
-#   :etime=>41057,
-#   :command=>
-#    "/home/samuel/.rbenv/versions/2.7.0/bin/ruby /home/samuel/.rbenv/versions/2.7.0/bin/falcon-host ./falcon.rb",
-#   :memory=>
-#    {:total=>94520,
-#     :rss=>29696,
-#     :pss=>8912,
-#     :shared_clean=>9528,
-#     :shared_dirty=>14588,
-#     :private_clean=>924,
-#     :private_dirty=>4656,
-#     :referenced=>29696,
-#     :anonymous=>19244,
-#     :swap=>0,
-#     :swap_pss=>0,
-#     :maps=>294}},
-#  {:pid=>68558,
-#   :ppid=>68536,
-#   :pgid=>68558,
-#   :pcpu=>0.0,
-#   :time=>0,
-#   :vsz=>94516,
-#   :rss=>23612,
-#   :etime=>41057,
-#   :command=>"supervisor",
-#   :memory=>
-#    {:total=>94520,
-#     :rss=>23612,
-#     :pss=>7551,
-#     :shared_clean=>4416,
-#     :shared_dirty=>14448,
-#     :private_clean=>0,
-#     :private_dirty=>4748,
-#     :referenced=>11184,
-#     :anonymous=>19196,
-#     :swap=>0,
-#     :swap_pss=>0,
-#     :maps=>294}},
-#  {:pid=>68559,
-#   :ppid=>68536,
-#   :pgid=>68558,
-#   :pcpu=>0.0,
-#   :time=>0,
-#   :vsz=>95000,
-#   :rss=>25136,
-#   :etime=>41057,
-#   :command=>"Falcon Host for hello.localhost",
-#   :memory=>
-#    {:total=>95004,
-#     :rss=>25136,
-#     :pss=>9308,
-#     :shared_clean=>5504,
-#     :shared_dirty=>11784,
-#     :private_clean=>0,
-#     :private_dirty=>7848,
-#     :referenced=>17596,
-#     :anonymous=>19632,
-#     :swap=>0,
-#     :swap_pss=>0,
-#     :maps=>295}},
-# ... 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
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2019, by [Samuel G. D. Williams](https://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.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/process-metrics.gemspec

@@ -1,32 +0,0 @@
-require_relative 'lib/process/metrics/version'
-
-Gem::Specification.new do |spec|
-	spec.name = "process-metrics"
-	spec.version = Process::Metrics::VERSION
-	spec.authors = ["Samuel Williams"]
-	spec.email = ["samuel.williams@oriontransfer.co.nz"]
-	
-	spec.summary = "Provide detailed OS-specific process metrics."
-	spec.homepage = "https://github.com/socketry/process-metrics"
-	spec.license = "MIT"
-	
-	spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-	
-	spec.metadata["funding_uri"] = "https://github.com/sponsors/ioquatix"
-	
-	# Specify which files should be added to the gem when it is released.
-	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-	spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-	end
-	
-	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"
-	spec.add_development_dependency "rspec", "~> 3.8"
-end