heap_periscope_agent 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c859a494c5e24980e456f5de068960eb7f7d823ea3c7e5f0dc11008962d564e
+  data.tar.gz: 05d5c1bf1886fec7c7eff1f73de7210c6580ce7be679bd9173d46fda1c99a632
+SHA512:
+  metadata.gz: 24d398857915e014a307cb9580a4e4464827ec8f10180d3f826a486a6bf3d3f29667e1c80b2bee9383cddfcb1eccb1d1436d0f5bc71488a13f144e16ebe1e0b8
+  data.tar.gz: e94d5b7f0b7fe0ed16b0b92a83be81c34a94e27d4fbddb46f66c7e51880fdca72a523ae7223b3666e991eb1928b56bdd422ae6b9b900401ce3cfe006088ee830

data/lib/heap_periscope_agent/collector.rb

@@ -0,0 +1,34 @@
+require 'time'
+require 'json'
+require 'socket'
+require 'objspace'
+require 'concurrent/atomic/atomic_boolean'
+require 'thread'
+
+module HeapPeriscopeAgent
+  class Collector
+    def self.collect_snapshot(detailed_mode = false)
+      data = {
+        gc_stats: GC.stat,
+        object_space_summary: ObjectSpace.count_objects
+      }
+
+      if detailed_mode
+        data[:living_objects_by_class] = collect_detailed_living_objects(HeadPeriscopeAgent.configuration.detailed_objects_limit)
+      end
+
+      data
+    end
+
+    private
+
+    def self.collect_detailed_living_objects(limit)
+      counts = Hash.new(0)
+      ObjectSpace.each_object do |obj|
+        class_name = obj.class.name rescue 'Anonymous/Singleton Class'
+        counts[class_name] += 1
+      end
+      counts.sort_by { |_, count| -count }.first(limit).to_h
+    end
+  end
+end

data/lib/heap_periscope_agent/configuration.rb

@@ -0,0 +1,14 @@
+module HeapPeriscopeAgent
+  class Configuration
+    attr_accessor :interval, :host, :port, :verbose, :enable_detailed_objects, :detailed_objects_limit
+
+    def initialize
+      @interval = 10 # seconds
+      @host = '127.0.0.1'
+      @port = 9000
+      @verbose = true
+      @enable_detailed_objects = false
+      @detailed_objects_limit = 20
+    end
+  end
+end

data/lib/heap_periscope_agent/reporter.rb

@@ -0,0 +1,122 @@
+require 'time'
+require 'json'
+require 'socket'
+require 'objspace'
+require 'concurrent/atomic/atomic_boolean'
+require 'thread'
+
+module HeapPeriscopeAgent
+  class Reporter
+    def self.start
+      @config = HeapPeriscopeAgent.configuration
+      @running = Concurrent::AtomicBoolean.new(false)
+
+      return if @running.true?
+      @running.make_true
+
+      log("Reporter starting with interval: #{@config.interval}s.")
+
+      # Enable the standard GC Profiler
+      GC::Profiler.enable
+      # Store the initial total time to calculate deltas later
+      @last_gc_total_time = GC::Profiler.total_time
+
+      @thread = Thread.new do
+        @socket = UDPSocket.new
+        last_snapshot_time = Time.now
+
+        while @running.true?
+          # Periodically send a full snapshot
+          if Time.now - last_snapshot_time >= @config.interval
+            send_snapshot_report
+            last_snapshot_time = Time.now
+          end
+
+          # Check for new GC activity since the last check
+          send_gc_profiler_report
+
+          sleep(1) # Main loop delay
+        end
+
+        log("Reporter loop finished.")
+        GC::Profiler.disable # Clean up the profiler
+        @socket.close
+      end
+
+      @thread.report_on_exception = true
+      log("Reporter thread initiated.")
+    end
+
+    def self.stop
+      return unless @running&.true?
+
+      log("Stopping reporter...")
+      @running.make_false
+      if @thread&.join(5)
+        log("Reporter thread stopped gracefully.")
+      else
+        log("Reporter thread did not stop in time, killing.", level: :warn)
+        @thread&.kill
+      end
+      @thread = nil
+      log("Reporter stop process complete.")
+    end
+
+    def self.report_once!
+      @config = HeapPeriscopeAgent.configuration
+      @socket = UDPSocket.new
+      send_snapshot_report
+      @socket.close
+    end
+
+    private
+
+    def self.send_snapshot_report
+      log("Collecting periodic snapshot...")
+      stats = HeapPeriscopeAgent.Collector.collect_snapshot(@config.enable_detailed_objects)
+      send_payload(stats, "snapshot")
+    end
+
+    def self.send_gc_profiler_report
+      current_gc_total_time = GC::Profiler.total_time
+      # Calculate time spent in GC since our last check
+      gc_time_delta = current_gc_total_time - @last_gc_total_time
+
+      # If there was GC activity, report it
+      if gc_time_delta > 0
+        log("Detected GC activity. Sending GC profiler report.")
+        payload = {
+          # Convert from seconds to milliseconds
+          gc_duration_since_last_check_ms: (gc_time_delta * 1000).round(2),
+          gc_invocation_count: GC.count, # Total number of GCs so far
+          latest_gc_info: GC.latest_gc_info,
+        }
+        send_payload(payload, "gc_profiler_report")
+        
+        # Update the last known time
+        @last_gc_total_time = current_gc_total_time
+      end
+    end
+
+    def self.send_payload(data, type)
+      payload = {
+        type: type,
+        process_id: Process.pid,
+        reported_at: Time.now.utc.iso8601,
+        payload: data
+      }.to_json
+
+      @socket.send(payload, 0, @config.host, @config.port)
+      log("Sent #{type} payload.")
+    rescue => e
+      log("Failed to send payload: #{e.message}", level: :error)
+    end
+
+    def self.log(message, level: :info)
+      return unless @config&.verbose
+      timestamp = Time.now.strftime('%Y-%m-%d %H:%M:%S')
+      output = "[HeapPeriscopeAgent][#{level.to_s.upcase}] #{timestamp}: #{message}"
+      level == :error ? warn(output) : puts(output)
+    end
+  end
+end

data/lib/heap_periscope_agent.rb

@@ -0,0 +1,13 @@
+require_relative './heap_periscope_agent/configuration.rb'
+require_relative './heap_periscope_agent/collector.rb'
+require_relative './heap_periscope_agent/reporter.rb'
+
+module HeapPeriscopeAgent
+  def self.configuration
+    @configuration ||= HeapPeriscopeAgent::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: heap_periscope_agent
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Jonathan Natanael Siahaan
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Real-time Garbage Collection & Object Allocation Metrics
+email: js.jonathan.n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/heap_periscope_agent.rb
+- lib/heap_periscope_agent/collector.rb
+- lib/heap_periscope_agent/configuration.rb
+- lib/heap_periscope_agent/reporter.rb
+homepage: https://rubygems.org/gems/heap_periscope_agent
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Real-time Garbage Collection & Object Allocation Metrics
+test_files: []