improve debug logging

Author: senid231

lib/libvirt_async.rb

@@ -35,11 +35,9 @@ def logger
 
   module_function :logger
 
-  def build_logger(io, formatter: nil, progname: nil, level: nil, datetime_format: nil)
+  def build_logger(io, formatter: LogFormatter.new, progname: nil, level: :info, datetime_format: nil)
+    formatter&.datetime_format = datetime_format unless datetime_format.nil?
     logger = Logger.new(io, formatter: formatter, progname: progname, level: level)
-    logger.level = level unless level.nil?
-    logger.formatter = formatter || LogFormatter.new
-    logger.formatter.datetime_format = datetime_format unless datetime_format.nil?
     logger
   end
 
@@ -50,4 +48,30 @@ def use_logger!(io = STDOUT, options = {})
   end
 
   module_function :use_logger!
+
+  def start_debug_logging!(timeout = 2)
+    LibvirtAsync.logger.debug { "scheduling debug logging!" }
+    @debug_task = Util.create_task do
+      LibvirtAsync.logger.debug { "starting debug logging!" }
+      begin
+        while true do
+          raise Error, 'implementations not registered' if @implementations.nil?
+          @implementations.print_debug_info
+          Async::Task.current.reactor.sleep timeout
+        end
+      rescue Error => e
+        LibvirtAsync.logger.debug { "stopping debug logging! #{e.message}" }
+      end
+    end
+    Async::Task.current.reactor << @debug_task.fiber
+  end
+
+  module_function :start_debug_logging!
+
+  def stop_debug_logging!
+    @debug_task&.stop(true)
+    @debug_task = nil
+  end
+
+  module_function :stop_debug_logging!
 end

lib/libvirt_async/handle.rb

@@ -14,6 +14,14 @@ def close
       def readiness
         monitor&.readiness
       end
+
+      def to_s
+        "#<#{self.class}:0x#{object_id.to_s(16)} readable=#{@readable&.object_id&.to_s(16)} writable=#{@writable&.object_id&.to_s(16)} alive=#{@monitor && !@monitor.closed?}>"
+      end
+
+      def inspect
+        to_s
+      end
     end
 
     include WithDbg
@@ -94,6 +102,14 @@ def unregister
       @monitor = nil
     end
 
+    def to_s
+      "#<#{self.class}:0x#{object_id.to_s(16)} handle_id=#{handle_id} fd=#{fd} events=#{events} monitor=#{monitor}>"
+    end
+
+    def inspect
+      to_s
+    end
+
     private
 
     def dispatch(events)

lib/libvirt_async/implementations.rb

@@ -29,6 +29,27 @@ def stop
       default_variables
     end
 
+    def print_debug_info
+      str = [
+          "#{self.class}:0x#{object_id.to_s(16)}",
+          "handles = [",
+          @handles.map(&:to_s).join("\n"),
+          "]",
+          "timers = [",
+          @timers.map(&:to_s).join("\n"),
+          "]"
+      ].join("\n")
+      LibvirtAsync.logger&.debug { str }
+    end
+
+    def to_s
+      "#<#{self.class}:0x#{object_id.to_s(16)} handles=#{@handles} timers=#{@timers}>"
+    end
+
+    def inspect
+      to_s
+    end
+
     private
 
     def default_variables

lib/libvirt_async/timer.rb

@@ -28,6 +28,14 @@ def close
         @fiber.resume(Cancelled.new) if @fiber&.alive?
         @fiber = nil
       end
+
+      def to_s
+        "#<#{self.class}:0x#{object_id.to_s(16)} fiber=#{@fiber.&object_id&.to_s(16)} alive=#{@fiber&.alive?}>"
+      end
+
+      def inspect
+        to_s
+      end
     end
 
     include WithDbg
@@ -91,6 +99,14 @@ def unregister
       @monitor = nil
     end
 
+    def to_s
+      "#<#{self.class}:0x#{object_id.to_s(16)} timer_id=#{timer_id} interval=#{interval} last_fired=#{last_fired} monitor=#{monitor}>"
+    end
+
+    def inspect
+      to_s
+    end
+
     private
 
     def dispatch