process-metrics 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb30f9e1ffed610ad4a6735a8875f6438eae603ce53e6cb67274e7f893f1c4d5
-  data.tar.gz: 0474ced532e19377ee8b4b7003c21d1a098afc8df5fb3f9865ea163aa756eced
+  metadata.gz: 213edfd5fbe960b9a75ac7574f17828f6b9f24ec5328ebf8c6ee85dcafeae0c2
+  data.tar.gz: 8daf591b9691f058dbe87dd861c0d8ff2e2669edff94b098ad0de36440963b14
 SHA512:
-  metadata.gz: 898911e287967bb88596747da31bc6e956bdf4aa8bdea23b461df7998922155d72bd577ca0092320514aa41738547576abd379779a89cf66a22d5a63f0e279f8
-  data.tar.gz: 0f78a3b25a090f9823feae392358281e10f1828a0cb4d324ad880a0a877e0ae34d8cd9d4fbedf7018fe847b5dff1b2f2c6a27702eebb61d714afb46faf4eda7a
+  metadata.gz: 7cfafb180bf9286f5eb35dd2d5393b77ca88fc86f8b93509aed2f30870255dbba5e617ceceb69c17607bc3e620b7599e8c11ab960323033a97087a2acc45340c
+  data.tar.gz: 78427458c5dd06674690a1fe3ffab4d1c85a6ce265defce5dc2191be874ee995c87299c86de9b83e88e84318425ca2b16361e69df4b9d26d4badca1dbb8078e7

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

@@ -8,12 +8,12 @@ module Process
 		# Per-host (system-wide) memory metrics. Use Host::Memory for total/used/free and swap; use Process::Metrics::Memory for per-process metrics.
 		module Host
 			# Struct for host memory snapshot. All sizes in bytes.
-			# @attribute total [Integer] Total memory (cgroup limit when in a container, else physical RAM).
-			# @attribute used [Integer] Memory in use (total - free).
-			# @attribute free [Integer] Available memory (MemAvailable-style: free + reclaimable).
-			# @attribute swap_total [Integer, nil] Total swap, or nil if not available.
-			# @attribute swap_used [Integer, nil] Swap in use, or nil if not available.
-			Memory = Struct.new(:total, :used, :free, :swap_total, :swap_used) do
+			# @attribute total_size [Integer] Total memory (cgroup limit when in a container, else physical RAM).
+			# @attribute used_size [Integer] Memory in use (total_size - free_size).
+			# @attribute free_size [Integer] Available memory (MemAvailable-style: free + reclaimable).
+			# @attribute swap_total_size [Integer, nil] Total swap, or nil if not available.
+			# @attribute swap_used_size [Integer, nil] Swap in use, or nil if not available.
+			Memory = Struct.new(:total_size, :used_size, :free_size, :swap_total_size, :swap_used_size) do
 				alias as_json to_h
 				
 				def to_json(*arguments)

data/lib/process/metrics/memory.rb

@@ -23,11 +23,30 @@ module Process
 				self.resident_size + self.swap_size
 			end
 			
-			# The unique set size, the size of completely private (unshared) data.
-			def unique_size
+			# The private set size, the size of completely private (unshared) data.
+			# This is the sum of Private_Clean and Private_Dirty pages.
+			# @returns [Integer] Total private memory in bytes.
+			def private_size
 				self.private_clean_size + self.private_dirty_size
 			end
 			
+			# The private set size is also known as the unique set size.
+			alias unique_size private_size
+			
+			# The total size of shared (potentially shared with other processes) memory.
+			# This is the sum of Shared_Clean and Shared_Dirty pages.
+			#
+			# When tracking Copy-on-Write (CoW) activity in forked processes:
+			# - Initially, most memory is shared between parent and child.
+			# - As the child writes to memory, CoW triggers and shared pages become private.
+			# - Tracking shared_size decrease vs unique_size increase can indicate CoW activity.
+			# - If shared_size decreases by X and unique_size increases by ~X, it's likely CoW.
+			#
+			# @returns [Integer] Total shared memory in bytes.
+			def shared_size
+				self.shared_clean_size + self.shared_dirty_size
+			end
+			
 			# Create a zero-initialized Memory instance.
 			# @returns [Memory] A new Memory object with all fields set to zero.
 			def self.zero
@@ -37,7 +56,7 @@ module Process
 			# Total system/host memory in bytes. Delegates to Host::Memory.capture.
 			# @returns [Integer | Nil]
 			def self.total_size
-				Host::Memory.capture&.total
+				Host::Memory.capture&.total_size
 			end
 			
 			# Whether the memory usage can be captured on this system.

data/lib/process/metrics/version.rb

@@ -7,6 +7,6 @@
 module Process
 	# @namespace
 	module Metrics
-		VERSION = "0.10.0"
+		VERSION = "0.10.2"
 	end
 end

data/readme.md

@@ -16,9 +16,17 @@ 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.
 
+### v0.10.2
+
+  - Add `Process::Metrics::Memory#private_size` for the sum of private (unshared) pages (Private\_Clean + Private\_Dirty); `#unique_size` is now an alias for `#private_size`.
+
+### v0.10.1
+
+  - Consistent use of `_size` suffix.
+
 ### v0.10.0
 
-  - **Host::Memory**: New per-host struct `Process::Metrics::Host::Memory` with `total`, `used`, `free`, `swap_total`, `swap_used` (all bytes). Use `Host::Memory.capture` to get a snapshot; `.supported?` indicates platform support.
+  - **Host::Memory**: New per-host struct `Process::Metrics::Host::Memory` with `total_size`, `used_size`, `free_size`, `swap_total_size`, `swap_used_size` (all bytes). Use `Host::Memory.capture` to get a snapshot; `.supported?` indicates platform support.
 
 ### v0.9.0
 
@@ -54,23 +62,6 @@ Please see the [project releases](https://socketry.github.io/process-metrics/rel
   - Improved support for proportional memory usage (PSS).
   - Exposed total system memory information.
 
-### v0.4.0
-
-  - Fixed command formatting in output display.
-  - Modernized codebase to use current Ruby conventions.
-  - Improved Darwin (macOS) support with better platform-specific handling.
-
-### v0.3.0
-
-  - Added support for `smaps_rollup` on Linux for more efficient memory statistics collection.
-  - Fixed `smaps_rollup` detection (corrected file path).
-  - Removed `sz` metric (not supported on Darwin).
-  - Expanded test coverage.
-  - Improved documentation with better syntax highlighting and fixed links.
-  - Avoided abbreviations in naming conventions for better code clarity.
-  - Added missing dependencies: `bake-test-external` and `json` gem.
-  - Added summary lines for PSS (Proportional Set Size) and USS (Unique Set Size).
-
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -1,8 +1,16 @@
 # Releases
 
+## v0.10.2
+
+  - Add `Process::Metrics::Memory#private_size` for the sum of private (unshared) pages (Private\_Clean + Private\_Dirty); `#unique_size` is now an alias for `#private_size`.
+
+## v0.10.1
+
+  - Consistent use of `_size` suffix.
+
 ## v0.10.0
 
-  - **Host::Memory**: New per-host struct `Process::Metrics::Host::Memory` with `total`, `used`, `free`, `swap_total`, `swap_used` (all bytes). Use `Host::Memory.capture` to get a snapshot; `.supported?` indicates platform support.
+  - **Host::Memory**: New per-host struct `Process::Metrics::Host::Memory` with `total_size`, `used_size`, `free_size`, `swap_total_size`, `swap_used_size` (all bytes). Use `Host::Memory.capture` to get a snapshot; `.supported?` indicates platform support.
 
 ## v0.9.0
 

metadata

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