All sizes in bytes.

Author: samuel-williams-shopify

context/getting-started.md

@@ -67,24 +67,24 @@ The {ruby Process::Metrics::General} struct contains the following fields:
 - `parent_process_id` - Parent Process ID, the process ID of the process that started this process.
 - `process_group_id` - Process Group ID, the process group ID of the process, which can be shared by multiple processes.
 - `processor_utilization` - Processor Utilization (%), the percentage of CPU time used by the process (over a system-specific duration).
-- `total_size` - Memory Size (KB), the total size of the process's memory space (usually over-estimated as it doesn't take into account shared memory).
-- `resident_size` - Resident (Set) Size (KB), the amount of physical memory used by the process.
+- `total_size` - Memory Size (bytes), the total size of the process's memory space (usually over-estimated as it doesn't take into account shared memory).
+- `resident_size` - Resident (Set) Size (bytes), the amount of physical memory used by the process.
 - `processor_time` - CPU Time (s), the amount of CPU time used by the process.
 - `elapsed_time` - Elapsed Time (s), the amount of time the process has been running.
 - `command` - Command Name, the name of the command that started the process.
 
 The {ruby Process::Metrics::Memory} struct contains the following fields:
 
 - `map_count` - Number of Memory Mappings, e.g. number of thread stacks, fiber stacks, shared libraries, memory mapped files, etc.
-- `resident_size` - Resident Memory Size (KB), the amount of physical memory used by the process.
-- `proportional_size` - Proportional Memory Size (KB), the amount of memory that the process is using, taking into account shared memory.
-- `shared_clean_size` - Shared Clean Memory Size (KB), the amount of shared memory that is clean (not modified).
-- `shared_dirty_size` - Shared Dirty Memory Size (KB), the amount of shared memory that is dirty (modified).
-- `private_clean_size` - Private Clean Memory Size (KB), the amount of private memory that is clean (not modified).
-- `private_dirty_size` - Private Dirty Memory Size (KB), the amount of private memory that is dirty (modified).
-- `referenced_size` - Referenced Memory Size (KB), active page-cache that isn't going to be reclaimed any time soon.
-- `anonymous_size` - Anonymous Memory Size (KB), mapped memory that isn't backed by a file.
-- `swap_size` - Swap Memory Size (KB), the amount of memory that has been swapped to disk.
-- `proportional_swap_size` - Proportional Swap Memory Size (KB), the amount of memory that has been swapped to disk, excluding shared memory.
+- `resident_size` - Resident Memory Size (bytes), the amount of physical memory used by the process.
+- `proportional_size` - Proportional Memory Size (bytes), the amount of memory that the process is using, taking into account shared memory.
+- `shared_clean_size` - Shared Clean Memory Size (bytes), the amount of shared memory that is clean (not modified).
+- `shared_dirty_size` - Shared Dirty Memory Size (bytes), the amount of shared memory that is dirty (modified).
+- `private_clean_size` - Private Clean Memory Size (bytes), the amount of private memory that is clean (not modified).
+- `private_dirty_size` - Private Dirty Memory Size (bytes), the amount of private memory that is dirty (modified).
+- `referenced_size` - Referenced Memory Size (bytes), active page-cache that isn't going to be reclaimed any time soon.
+- `anonymous_size` - Anonymous Memory Size (bytes), mapped memory that isn't backed by a file.
+- `swap_size` - Swap Memory Size (bytes), the amount of memory that has been swapped to disk.
+- `proportional_swap_size` - Proportional Swap Memory Size (bytes), the amount of memory that has been swapped to disk, excluding shared memory.
 
 In general, the interpretation of these fields is operating system specific. At best, they provide a rough estimate of the process's memory usage, but you should consult the documentation for your operating system for more details on exactly what each field represents.

examples/cow.rb

@@ -52,13 +52,13 @@
 
 	minor = mem.minor_faults.to_i
 	major = mem.major_faults.to_i
-	unique = mem.unique_size.to_i          # kB
+	unique = mem.unique_size.to_i          # bytes
 
 	delta_minor = last_minor ? (minor - last_minor) : 0
 	delta_major = last_major ? (major - last_major) : 0
 	delta_unique = last_unique ? (unique - last_unique) : 0
 
-	puts "[%2ds] minor: %d (+%d), major: %d (+%d), unique_kB: %d (+%d)" % [t, minor, delta_minor, major, delta_major, unique, delta_unique]
+	puts "[%2ds] minor: %d (+%d), major: %d (+%d), unique_bytes: %d (+%d)" % [t, minor, delta_minor, major, delta_major, unique, delta_unique]
 
 	last_minor = minor
 	last_major = major

guides/getting-started/readme.md

@@ -67,24 +67,24 @@ The {ruby Process::Metrics::General} struct contains the following fields:
 - `parent_process_id` - Parent Process ID, the process ID of the process that started this process.
 - `process_group_id` - Process Group ID, the process group ID of the process, which can be shared by multiple processes.
 - `processor_utilization` - Processor Utilization (%), the percentage of CPU time used by the process (over a system-specific duration).
-- `total_size` - Memory Size (KB), the total size of the process's memory space (usually over-estimated as it doesn't take into account shared memory).
-- `resident_size` - Resident (Set) Size (KB), the amount of physical memory used by the process.
+- `total_size` - Memory Size (bytes), the total size of the process's memory space (usually over-estimated as it doesn't take into account shared memory).
+- `resident_size` - Resident (Set) Size (bytes), the amount of physical memory used by the process.
 - `processor_time` - CPU Time (s), the amount of CPU time used by the process.
 - `elapsed_time` - Elapsed Time (s), the amount of time the process has been running.
 - `command` - Command Name, the name of the command that started the process.
 
 The {ruby Process::Metrics::Memory} struct contains the following fields:
 
 - `map_count` - Number of Memory Mappings, e.g. number of thread stacks, fiber stacks, shared libraries, memory mapped files, etc.
-- `resident_size` - Resident Memory Size (KB), the amount of physical memory used by the process.
-- `proportional_size` - Proportional Memory Size (KB), the amount of memory that the process is using, taking into account shared memory.
-- `shared_clean_size` - Shared Clean Memory Size (KB), the amount of shared memory that is clean (not modified).
-- `shared_dirty_size` - Shared Dirty Memory Size (KB), the amount of shared memory that is dirty (modified).
-- `private_clean_size` - Private Clean Memory Size (KB), the amount of private memory that is clean (not modified).
-- `private_dirty_size` - Private Dirty Memory Size (KB), the amount of private memory that is dirty (modified).
-- `referenced_size` - Referenced Memory Size (KB), active page-cache that isn't going to be reclaimed any time soon.
-- `anonymous_size` - Anonymous Memory Size (KB), mapped memory that isn't backed by a file.
-- `swap_size` - Swap Memory Size (KB), the amount of memory that has been swapped to disk.
-- `proportional_swap_size` - Proportional Swap Memory Size (KB), the amount of memory that has been swapped to disk, excluding shared memory.
+- `resident_size` - Resident Memory Size (bytes), the amount of physical memory used by the process.
+- `proportional_size` - Proportional Memory Size (bytes), the amount of memory that the process is using, taking into account shared memory.
+- `shared_clean_size` - Shared Clean Memory Size (bytes), the amount of shared memory that is clean (not modified).
+- `shared_dirty_size` - Shared Dirty Memory Size (bytes), the amount of shared memory that is dirty (modified).
+- `private_clean_size` - Private Clean Memory Size (bytes), the amount of private memory that is clean (not modified).
+- `private_dirty_size` - Private Dirty Memory Size (bytes), the amount of private memory that is dirty (modified).
+- `referenced_size` - Referenced Memory Size (bytes), active page-cache that isn't going to be reclaimed any time soon.
+- `anonymous_size` - Anonymous Memory Size (bytes), mapped memory that isn't backed by a file.
+- `swap_size` - Swap Memory Size (bytes), the amount of memory that has been swapped to disk.
+- `proportional_swap_size` - Proportional Swap Memory Size (bytes), the amount of memory that has been swapped to disk, excluding shared memory.
 
 In general, the interpretation of these fields is operating system specific. At best, they provide a rough estimate of the process's memory usage, but you should consult the documentation for your operating system for more details on exactly what each field represents.

lib/process/metrics/command/summary.rb

@@ -90,23 +90,28 @@ def format_processor_utilization(value, terminal)
 				UNITS = ["KiB", "MiB", "GiB"]
 
 				# Format a memory size value in human-readable units.
-				# @parameter value [Numeric] The size value in kilobytes.
+				# @parameter value [Numeric] The size value in bytes.
 				# @parameter units [Array(String)] The unit labels to use for scaling.
 				# @returns [String] A formatted string with value and unit (e.g., "512KiB", "1.5MiB").
 				def format_size(value, units: UNITS)
-					unit = 0
+					unit = -1
 
-					while value > 1024.0 && unit < units.size
+					while value >= 1024.0 && unit < units.size - 1
 						value /= 1024.0
 						unit += 1
 					end
 
-					return "#{value.round(unit)}#{units[unit]}"
+					if unit < 0
+						# Value is less than 1 KiB, show in bytes
+						return "#{value.round(0)}B"
+					else
+						return "#{value.round(unit)}#{units[unit]}"
+					end
 				end
 
 				# Format a memory value with a horizontal bar showing utilization relative to total.
-				# @parameter value [Numeric] The memory value in kilobytes.
-				# @parameter total [Numeric] The total memory available in kilobytes.
+				# @parameter value [Numeric] The memory value in bytes.
+				# @parameter total [Numeric] The total memory available in bytes.
 				# @parameter terminal [Console::Terminal] The terminal to output styled text.
 				def format_memory(value, total, terminal)
 					if value > (total * 0.8)
@@ -123,10 +128,11 @@ def format_memory(value, total, terminal)
 				end
 
 				# Get the total memory to use for percentage calculations.
-				# @returns [Integer] Total memory in kilobytes.
+				# @returns [Integer] Total memory in bytes.
 				def total_memory
 					if total_memory = @options[:total_memory]
-						return total_memory * 1024
+						# Convert from MiB to bytes
+						return total_memory * 1024 * 1024
 					else
 						return Process::Metrics::Memory.total_size
 					end

lib/process/metrics/general.rb

@@ -42,8 +42,8 @@ def self.duration(value)
 			ppid: ->(value){value.to_i}, # Parent Process ID
 			pgid: ->(value){value.to_i}, # Process Group ID
 			pcpu: ->(value){value.to_f}, # Percentage CPU
-			vsz: ->(value){value.to_i}, # Virtual Size (KiB)
-			rss: ->(value){value.to_i}, # Resident Size (KiB)
+			vsz: ->(value){value.to_i * 1024}, # Virtual Size (convert from KiB to bytes)
+			rss: ->(value){value.to_i * 1024}, # Resident Size (convert from KiB to bytes)
 			time: self.method(:duration), # CPU Time (seconds)
 			etime: self.method(:duration), # Elapsed Time (seconds)
 			command: ->(value){value}, # Command (name of the process)
@@ -73,7 +73,7 @@ def to_json(*arguments)
 				as_json.to_json(*arguments)
 			end
 
-			# The total size of the process in memory, in kilobytes.
+			# The total size of the process in memory, in bytes.
 			def total_size
 				if memory = self.memory
 					memory.proportional_size

lib/process/metrics/memory.rb

@@ -7,7 +7,7 @@
 
 module Process
 	module Metrics
-		# Represents memory usage for a process, sizes are in kilobytes.
+		# Represents memory usage for a process, sizes are in bytes.
 		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, :minor_faults, :major_faults)
 
 			alias as_json to_h

lib/process/metrics/memory/darwin.rb

@@ -14,29 +14,29 @@ def self.supported?
 				File.executable?(VMMAP)
 			end
 
-			# @returns [Numeric] Total memory size in kilobytes.
+			# @returns [Numeric] Total memory size in bytes.
 			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
+							return $1.to_i
 						end
 					end
 				end
 			end
 
-			# Parse a size string from vmmap output into kilobytes.
+			# Parse a size string from vmmap output into bytes.
 			# @parameter string [String | Nil] The size string (e.g., "4K", "1.5M", "2G").
-			# @returns [Integer] The size in kilobytes.
+			# @returns [Integer] The size in bytes.
 			def self.parse_size(string)
 				return 0 unless string
 
 				case string.strip
-				when /([\d\.]+)K/i then ($1.to_f).round
-				when /([\d\.]+)M/i then ($1.to_f * 1024).round
-				when /([\d\.]+)G/i then ($1.to_f * 1024 * 1024).round
-				else (string.to_f / 1024).ceil
+				when /([\d\.]+)K/i then ($1.to_f * 1024).round
+				when /([\d\.]+)M/i then ($1.to_f * 1024 * 1024).round
+				when /([\d\.]+)G/i then ($1.to_f * 1024 * 1024 * 1024).round
+				else (string.to_f).ceil
 				end
 			end
 
@@ -111,7 +111,7 @@ def supported?
 				end
 
 				# Get total system memory size.
-				# @returns [Integer] Total memory in kilobytes.
+				# @returns [Integer] Total memory in bytes.
 				def total_size
 					return Memory::Darwin.total_size
 				end

lib/process/metrics/memory/linux.rb

@@ -37,16 +37,16 @@ def self.capture_faults(pid, usage)
 				# Ignore.
 			end
 
-			# Determine the total memory size in kilobytes. This is the maximum amount of memory that can be used by the current process. If running in a container, this may be limited by the container runtime (e.g. cgroups).
+			# Determine the total memory size in bytes. This is the maximum amount of memory that can be used by the current process. If running in a container, this may be limited by the container runtime (e.g. cgroups).
 			#
-			# @returns [Integer] The total memory size in kilobytes.
+			# @returns [Integer] The total memory size in bytes.
 			def self.total_size
 				# Check for Kubernetes/cgroup memory limit first (cgroups v2):
 				if File.exist?("/sys/fs/cgroup/memory.max")
 					limit = File.read("/sys/fs/cgroup/memory.max").strip
 					# "max" means unlimited, fall through to other methods:
 					if limit != "max"
-						return limit.to_i / 1024
+						return limit.to_i
 					end
 				end
 
@@ -55,15 +55,15 @@ def self.total_size
 					limit = File.read("/sys/fs/cgroup/memory/memory.limit_in_bytes").strip.to_i
 					# A very large number means unlimited, fall through:
 					if limit > 0 && limit < CGROUP_V1_UNLIMITED_THRESHOLD
-						return limit / 1024
+						return limit
 					end
 				end
 
 				# Fall back to Linux system memory detection:
 				if File.exist?("/proc/meminfo")
 					File.foreach("/proc/meminfo") do |line|
 						if /MemTotal:\s*(?<total>\d+)\s*kB/ =~ line
-							return total.to_i
+							return total.to_i * 1024
 						end
 					end
 				end
@@ -100,7 +100,8 @@ def self.capture(pid, faults: true, **options)
 						file.each_line do |line|
 							if /(?<name>.*?):\s+(?<value>\d+) kB/ =~ line
 								if key = SMAP[name]
-									usage[key] += value.to_i
+									# Convert from kilobytes to bytes
+									usage[key] += value.to_i * 1024
 								end
 							end
 						end
@@ -136,7 +137,8 @@ def self.capture(pid, faults: true, **options)
 							# https://github.com/torvalds/linux/blob/351c8a09b00b5c51c8f58b016fffe51f87e2d820/fs/proc/task_mmu.c#L804-L814
 							if /(?<name>.*?):\s+(?<value>\d+) kB/ =~ line
 								if key = SMAP[name]
-									usage[key] += value.to_i
+									# Convert from kilobytes to bytes
+									usage[key] += value.to_i * 1024
 								end
 							elsif /VmFlags:\s+(?<flags>.*)/ =~ line
 								# It should be possible to extract the number of fibers and each fiber's memory usage.
@@ -170,7 +172,7 @@ def supported?
 				end
 
 				# Get total system memory size.
-				# @returns [Integer] Total memory in kilobytes.
+				# @returns [Integer] Total memory in bytes.
 				def total_size
 					return Memory::Linux.total_size
 				end

readme.md

@@ -16,6 +16,12 @@ Please see the [project documentation](https://socketry.github.io/process-metric
 
 Please see the [project releases](https://socketry.github.io/process-metrics/releases/index) for all releases.
 
+### Unreleased
+
+  - `Process::Metrics::Memory.total_size` takes into account cgroup limits.
+  - On Linux, capturing faults is optional, controlled by `capture(faults: true/false)`.
+  - Report all sizes in bytes for consistency.
+
 ### v0.7.0
 
   - Be more proactive about returning nil if memory capture failed.
@@ -67,12 +73,6 @@ Please see the [project releases](https://socketry.github.io/process-metrics/rel
   - Implemented structured data using Ruby structs for better performance and clarity.
   - Added documentation about PSS (Proportional Set Size) and USS (Unique Set Size) metrics.
 
-### v0.1.1
-
-  - Removed `Gemfile.lock` from version control.
-  - Fixed process metrics to exclude the `ps` command itself from measurements.
-  - Fixed documentation formatting issues.
-
 ## Contributing
 
 We welcome contributions to this project.

releases.md

@@ -4,6 +4,7 @@
 
   - `Process::Metrics::Memory.total_size` takes into account cgroup limits.
   - On Linux, capturing faults is optional, controlled by `capture(faults: true/false)`.
+  - Report all sizes in bytes for consistency.
 
 ## v0.7.0