async-container-supervisor 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb05adfa242cb60f47bd8dbe08da5e8c7d0250c450c7e9eee8b08b8a61f1670d
-  data.tar.gz: 0ffabcd3c5423f52c0912dc68af62b6cd2a7d1de0c74ff6fd5cc1175413f100e
+  metadata.gz: b3e00594c33bb419f5ff6e62ee5fc995db3254c4c924c96fa442039bfd8bb8e2
+  data.tar.gz: 44878ab7e6dfb5051650957366b7af8ba12c7e3368cb18b40a7bb8b55ac2f758
 SHA512:
-  metadata.gz: b3b3aba809104243badeeb0a18a9bccea0b6e49e34f1ce71b2f35c0d4f1f41718287858e6d400a869dd7ea4db9378448184084d81f4dec8363cdcc9cafce07d2
-  data.tar.gz: 2719f1d43025b031b577289460272d7c340ca297cf49b4325e2e095e361db926fba7a85cf6b80ff6c973f5ee464b69545c1c4d43a45f48b517c8801eb46a3c54
+  metadata.gz: '078b5c42c1bf947f8da0129e7478be89df2ad109d20f408fb34368e00bd87335524713749e6e734f49459f5ce991700b09f0404ce6512191a883941d9c9e5944'
+  data.tar.gz: c471f47eab98de78180149969a052382f76f5ec10126352198aa62808e201a81b5d22beeeb1b3fe88a1b1ab84b6703f123e5d4addda2c3bfd55f52ee14f24893

data/lib/async/container/supervisor/memory_monitor.rb

@@ -10,25 +10,43 @@ module Async
 	module Container
 		module Supervisor
 			class MemoryMonitor
-				def initialize(interval: 10, limit: nil, &block)
+				# Create a new memory monitor.
+				#
+				# @parameter interval [Integer] The interval at which to check for memory leaks.
+				# @parameter total_size_limit [Integer] The total size limit of all processes, or nil for no limit.
+				def initialize(interval: 10, total_size_limit: nil, **options)
 					@interval = interval
-					@cluster = Memory::Leak::Cluster.new(limit: limit)
+					@cluster = Memory::Leak::Cluster.new(total_size_limit: total_size_limit)
+					
+					# We use these options when adding processes to the cluster:
+					@options = options
+					
 					@processes = Hash.new{|hash, key| hash[key] = Set.new.compare_by_identity}
 				end
 				
+				# Add a process to the memory monitor. You may override this to control how processes are added to the cluster.
+				#
+				# @parameter process_id [Integer] The process ID to add.
+				def add(process_id)
+					@cluster.add(process_id, **@options)
+				end
+				
+				# Register the connection (worker) with the memory monitor.
 				def register(connection)
+					Console.info(self, "Registering connection:", connection: connection, state: connection.state)
 					if process_id = connection.state[:process_id]
 						connections = @processes[process_id]
 						
 						if connections.empty?
 							Console.info(self, "Registering process:", process_id: process_id)
-							@cluster.add(process_id)
+							self.add(process_id)
 						end
 						
 						connections.add(connection)
 					end
 				end
 				
+				# Remove the connection (worker) from the memory monitor.
 				def remove(connection)
 					if process_id = connection.state[:process_id]
 						connections = @processes[process_id]
@@ -42,28 +60,35 @@ module Async
 					end
 				end
 				
+				# Dump the current status of the memory monitor.
+				#
+				# @parameter call [Connection::Call] The call to respond to.
 				def status(call)
 					call.push(memory_monitor: @cluster)
 				end
 				
+				# Invoked when a memory leak is detected.
+				#
+				# @parameter process_id [Integer] The process ID of the process that has a memory leak.
+				# @parameter monitor [Memory::Leak::Monitor] The monitor that detected the memory leak.
+				# @returns [Boolean] True if the process was killed.
+				def memory_leak_detected(process_id, monitor)
+					Console.info(self, "Killing process:", process_id: process_id)
+					Process.kill(:INT, process_id)
+					
+					true
+				end
+				
+				# Run the memory monitor.
+				#
+				# @returns [Async::Task] The task that is running the memory monitor.
 				def run
 					Async do
 						while true
+							# This block must return true if the process was killed.
 							@cluster.check! do |process_id, monitor|
 								Console.error(self, "Memory leak detected in process:", process_id: process_id, monitor: monitor)
-								connections = @processes[process_id]
-								
-								connections.each do |connection|
-									path = "/tmp/memory_dump_#{process_id}.json"
-									
-									response = connection.call(do: :memory_dump, path: path, timeout: 30)
-									Console.info(self, "Memory dump saved to:", path, response: response)
-									@block.call(response) if @block
-								end
-								
-								# Kill the process:
-								Console.info(self, "Killing process:", process_id: process_id)
-								Process.kill(:INT, process_id)
+								memory_leak_detected(process_id, monitor)
 							end
 							
 							sleep(@interval)

data/lib/async/container/supervisor/version.rb

@@ -6,7 +6,7 @@
 module Async
 	module Container
 		module Supervisor
-			VERSION = "0.4.1"
+			VERSION = "0.5.0"
 		end
 	end
 end

data/lib/async/container/supervisor.rb

@@ -13,3 +13,13 @@ require_relative "supervisor/memory_monitor"
 
 require_relative "supervisor/environment"
 require_relative "supervisor/supervised"
+
+# @namespace
+module Async
+	# @namespace
+	module Container
+		# @namespace
+		module Supervisor
+		end
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-container-supervisor
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-02-27 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-container
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 executables: []
 extensions: []
 extra_rdoc_files: []