memory-leak 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c289492ac6aa4dc49416b15d859f629fbf1f0cc234d0f1969c0f0fc9e362607
-  data.tar.gz: 23f0b4b50772e92d5a90d89510a9929eb0889c050b45cf864084061e11307fe8
+  metadata.gz: 426ae960c62375c639420dcf7f498e9e5226b1519614b1fff452b2212f70d7fe
+  data.tar.gz: 6002732a1fb1e17fc105ca6528a510e3d0f564827ff7197682286e68f98a0da9
 SHA512:
-  metadata.gz: 796f477f191c517e8e46cd2889ae04501fe81912c45190ecaa9ea2b0e61f70c621cc84668c3429a32fa221aecb8c64c42ea48d8b0a16c16a9d243f82a02fe4e4
-  data.tar.gz: 40ff9dbe71d8b6a063295a2ce622961d2fb85c2149c51a8ebcf682ef80e276e0edfa148154ea460cc03f82c06c7de1c63d9b5ff1b70f17a65b2f88c99cfa16c2
+  metadata.gz: f36940083fb9907c227bff8242af9ec35a64951f9621b8581adce24cfbb8b2510c7810415d04125e201b36838a06775d9204a6dfc953c780134dec2115924f6d
+  data.tar.gz: 4e727229e8b12a4c73b88066c423f4683a3e9b21fe29c42214eab422c6e310463dc71152c539d5f6cd302e08b9f0ecc3e7166e7620d031c543d90483a3f7e134

data/lib/memory/leak/cluster.rb

@@ -18,42 +18,55 @@ module Memory
 			def initialize(limit: nil)
 				@limit = limit
 				
-				@pids = {}
+				@processes = {}
+			end
+			
+			# @returns [Hash] A serializable representation of the cluster.
+			def as_json(...)
+				{
+					limit: @limit,
+					processes: @processes.transform_values(&:as_json),
+				}
+			end
+			
+			# @returns [String] The JSON representation of the cluster.
+			def to_json(...)
+				as_json.to_json(...)
 			end
 			
 			# @attribute [Numeric | Nil] The memory limit for the cluster.
 			attr_accessor :limit
 			
-			# @attribute [Hash(PID, Monitor)] The process IDs and monitors in the cluster.
-			attr :pids
+			# @attribute [Hash(Integer, Monitor)] The process IDs and monitors in the cluster.
+			attr :processes
 			
 			# Add a new process ID to the cluster.
-			def add(pid, **options)
-				@pids[pid] = Monitor.new(pid, **options)
+			def add(process_id, **options)
+				@processes[process_id] = Monitor.new(process_id, **options)
 			end
 			
 			# Remove a process ID from the cluster.
-			def remove(pid)
-				@pids.delete(pid)
+			def remove(process_id)
+				@processes.delete(process_id)
 			end
 			
-			# Apply the memory limit to the cluster. If the total memory usage exceeds the limit, yields each PID and monitor in order of maximum memory usage, so that they could be terminated and/or removed.
+			# Apply the memory limit to the cluster. If the total memory usage exceeds the limit, yields each process ID and monitor in order of maximum memory usage, so that they could be terminated and/or removed.
 			#
-			# @yields {|pid, monitor| ...} each process ID and monitor in order of maximum memory usage, return true if it was terminated to adjust memory usage.
+			# @yields {|process_id, monitor| ...} each process ID and monitor in order of maximum memory usage, return true if it was terminated to adjust memory usage.
 			def apply_limit!(limit = @limit)
-				total = @pids.values.map(&:current).sum
+				total = @processes.values.map(&:current).sum
 				
 				if total > limit
 					Console.warn(self, "Total memory usage exceeded limit.", total: total, limit: limit)
 				end
 				
-				sorted = @pids.sort_by do |pid, monitor|
+				sorted = @processes.sort_by do |process_id, monitor|
 					-monitor.current
 				end
 				
-				sorted.each do |pid, monitor|
+				sorted.each do |process_id, monitor|
 					if total > limit
-						if yield pid, monitor, total
+						if yield process_id, monitor, total
 							total -= monitor.current
 						end
 					else
@@ -64,17 +77,17 @@ module Memory
 			
 			# Check all processes in the cluster for memory leaks.
 			#
-			# @yields {|pid, monitor| ...} each process ID and monitor that is leaking or exceeds the memory limit.
+			# @yields {|process_id, monitor| ...} each process ID and monitor that is leaking or exceeds the memory limit.
 			def check!(&block)
 				leaking = []
 				
-				@pids.each do |pid, monitor|
+				@processes.each do |process_id, monitor|
 					monitor.sample!
 					
 					if monitor.leaking?
-						Console.debug(self, "Memory Leak Detected!", pid: pid, monitor: monitor)
+						Console.debug(self, "Memory Leak Detected!", process_id: process_id, monitor: monitor)
 						
-						leaking << [pid, monitor]
+						leaking << [process_id, monitor]
 					end
 				end
 				

data/lib/memory/leak/monitor.rb

@@ -13,9 +13,9 @@ module Memory
 		#
 		# We should be careful not to filter historical data, as some memory leaks may only become apparent after a long period of time. Any kind of filtering may prevent us from detecting such a leak.
 		class Monitor
-			# We only track heap size changes greater than this threshold (KB), across the DEFAULT_INTERVAL.
+			# We only track heap size changes greater than this threshold, across the DEFAULT_INTERVAL.
 			# True memory leaks will eventually hit this threshold, while small fluctuations will not.
-			DEFAULT_THRESHOLD = 1024*10
+			DEFAULT_THRESHOLD = 1024*1024*10
 			
 			# We track the last N heap size increases.
 			# If the heap size is not stabilizing within the specified limit, we can assume there is a leak.
@@ -24,12 +24,12 @@ module Memory
 			
 			# Create a new monitor.
 			#
-			# @parameter maximum [Numeric] The initial maximum heap size, from which we willl track increases, in KiB.
-			# @parameter threshold [Numeric] The threshold for heap size increases, in KiB.
+			# @parameter maximum [Numeric] The initial maximum heap size, from which we willl track increases, in bytes.
+			# @parameter threshold [Numeric] The threshold for heap size increases, in bytes.
 			# @parameter limit [Numeric] The limit for the number of heap size increases, before we assume a memory leak.
-			# @pid [Integer] The process ID to monitor.
-			def initialize(pid = Process.pid, maximum: nil, threshold: DEFAULT_THRESHOLD, limit: DEFAULT_LIMIT)
-				@pid = pid
+			# @parameter [Integer] The process ID to monitor.
+			def initialize(process_id = Process.pid, maximum: nil, threshold: DEFAULT_THRESHOLD, limit: DEFAULT_LIMIT)
+				@process_id = process_id
 				
 				@maximum = maximum
 				@threshold = threshold
@@ -40,8 +40,25 @@ module Memory
 				@current = nil
 			end
 			
+			# @returns [Hash] A serializable representation of the cluster.
+			def as_json(...)
+				{
+					process_id: @process_id,
+					current: @current,
+					maximum: @maximum,
+					threshold: @threshold,
+					limit: @limit,
+					count: @count,
+				}
+			end
+			
+			# @returns [String] The JSON representation of the cluster.
+			def to_json(...)
+				as_json.to_json(...)
+			end
+			
 			# @attribute [Integer] The process ID to monitor.
-			attr :pid
+			attr :process_id
 			
 			# @attribute [Numeric] The current maximum heap size.
 			attr :maximum
@@ -59,10 +76,10 @@ module Memory
 			#
 			# Even thought the absolute value of this number may not very useful, the relative change is useful for detecting memory leaks, and it works on most platforms.
 			#
-			# @returns [Numeric] Memory usage size in KiB.
+			# @returns [Numeric] Memory usage size in bytes.
 			private def memory_usage
-				IO.popen(["ps", "-o", "rss=", @pid.to_s]) do |io|
-					return Integer(io.readlines.last)
+				IO.popen(["ps", "-o", "rss=", @process_id.to_s]) do |io|
+					return Integer(io.readlines.last) * 1024
 				end
 			end
 			

data/lib/memory/leak/version.rb

@@ -5,6 +5,6 @@
 
 module Memory
 	module Leak
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memory-leak
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-02-24 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies: []
 executables: []
 extensions: []