Disable memory sampler by default.

Author: samuel-williams-shopify

lib/async/container/supervisor/memory_monitor.rb

@@ -15,14 +15,12 @@ module Supervisor
 			#
 			# Uses the `memory` gem to track process memory and detect leaks.
 			class MemoryMonitor
-				MEMORY_SAMPLE = {duration: 30, timeout: 30*4}
-				
 				# 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.
 				# @parameter options [Hash] Options to pass to the cluster when adding processes.
-				def initialize(interval: 10, total_size_limit: nil, memory_sample: MEMORY_SAMPLE, **options)
+				def initialize(interval: 10, total_size_limit: nil, memory_sample: false, **options)
 					@interval = interval
 					@cluster = Memory::Leak::Cluster.new(total_size_limit: total_size_limit)
 

lib/async/container/supervisor/worker.rb

@@ -32,18 +32,25 @@ def initialize(state = nil, endpoint: Supervisor.endpoint)
 
 				include Dispatchable
 
-				private def dump(call)
+				private def dump(call, buffer: true)
 					if path = call[:path]
 						File.open(path, "w") do |file|
 							yield file
 						end
 
 						call.finish(path: path)
-					else
+					elsif buffer
 						buffer = StringIO.new
 						yield buffer
 
-						call.finish(data: buffer.string)
+						if message = call[:log]
+							Console.info(self, message, data: buffer.string)
+							call.finish
+						else
+							call.finish(data: buffer.string)
+						end
+					else
+						call.fail(error: {message: "Buffered output not supported!"})
 					end
 				end
 
@@ -69,7 +76,7 @@ def do_scheduler_dump(call)
 				def do_memory_dump(call)
 					require "objspace"
 
-					dump(call) do |file|
+					dump(call, buffer: false) do |file|
 						ObjectSpace.dump_all(output: file)
 					end
 				end
@@ -109,13 +116,9 @@ def do_memory_sample(call)
 
 					report = sampler.report
 
-					# This is a temporary log to help with debugging:
-					buffer = StringIO.new
-					report.print(buffer)
-					Console.info(self, "Memory sample completed.", report: buffer.string)
-					
-					# Generate a report focused on retained objects (likely leaks):
-					call.finish(report: report)
+					dump(call) do |file|
+						file.puts(report.to_s)
+					end
 				ensure
 					GC.start
 				end

releases.md

@@ -4,6 +4,8 @@
 
   - Better handling of write failures in `Connection::Call.dispatch`, ensuring we don't leak calls.
   - Robust monitor loop handling - restart on failure, and align loop iterations.
+  - Disable memory sampler by default and use text output format.
+    - Introduce support for redirecting dump output to logs.
 
 ## v0.8.0
 

test/async/container/supervisor.rb

@@ -76,8 +76,7 @@ def reader_target.dispatch(call)
 			)
 
 			# Verify we got the forwarded response
-			expect(result).to have_keys(:report)
-			expect(result[:report]).to have_keys(:total_allocated, :total_retained)
+			expect(result).to have_keys(:data)
 		ensure
 			client_conn&.close
 			worker_task&.stop
@@ -117,8 +116,7 @@ def reader_target.dispatch(call); end
 			result = connection.call(do: :memory_sample, duration: 1)
 
 			# The result should contain a report
-			expect(result).to have_keys(:report)
-			expect(result[:report]).to have_keys(:total_allocated, :total_retained)
+			expect(result).to have_keys(:data)
 		ensure
 			worker_task&.stop
 		end