RubyGems - heap_periscope_ui - Versions diffs - 0.1.0 - Mend

heap_periscope_ui 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +28 -0
data/Rakefile +8 -0
data/app/assets/config/heap_periscope_ui_manifest.js +3 -0
data/app/assets/stylesheets/heap_periscope_ui/application.css +15 -0
data/app/assets/stylesheets/heap_periscope_ui/visualizer.css +11 -0
data/app/channels/heap_periscope_ui/application_cable/channel.rb +7 -0
data/app/channels/heap_periscope_ui/application_cable/connection.rb +12 -0
data/app/channels/heap_periscope_ui/runtime_stats_channel.rb +14 -0
data/app/controllers/heap_periscope_ui/application_controller.rb +4 -0
data/app/controllers/heap_periscope_ui/dashboard_controller.rb +11 -0
data/app/helpers/heap_periscope_ui/application_helper.rb +4 -0
data/app/jobs/heap_periscope_ui/application_job.rb +4 -0
data/app/mailers/heap_periscope_ui/application_mailer.rb +6 -0
data/app/models/heap_periscope_ui/application_record.rb +5 -0
data/app/models/heap_periscope_ui/object_count.rb +13 -0
data/app/models/heap_periscope_ui/profiler_report.rb +15 -0
data/app/views/heap_periscope_ui/dashboard/index.html +1132 -0
data/app/views/heap_periscope_ui/dashboard/index.html.bak +862 -0
data/app/views/layouts/heap_periscope_ui/application.html.erb +14 -0
data/config/initializers/heap_periscope_ui_start_udp_listener.rb +15 -0
data/config/routes.rb +8 -0
data/db/migrate/20250617144101_create_heap_periscope_ui_profiler_reports.rb +17 -0
data/db/migrate/20250617144853_create_heap_periscope_ui_object_counts.rb +14 -0
data/lib/generators/heap_periscope_ui/install/install_generator.rb +26 -0
data/lib/generators/heap_periscope_ui/install/templates/README_SETUP +17 -0
data/lib/generators/heap_periscope_ui/install/templates/initializer.rb +4 -0
data/lib/heap_periscope_ui/engine.rb +13 -0
data/lib/heap_periscope_ui/udp_listener.rb +131 -0
data/lib/heap_periscope_ui/version.rb +3 -0
data/lib/heap_periscope_ui.rb +16 -0
data/lib/tasks/heap_periscope_ui_tasks.rake +4 -0
metadata +100 -0

data/app/views/layouts/heap_periscope_ui/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Heap Periscope UI</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%# Add stylesheet_link_tag if you have engine-specific CSS %>
+  <%#= stylesheet_link_tag "heap_periscope_ui/application" %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/initializers/heap_periscope_ui_start_udp_listener.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require_relative "../../lib/heap_periscope_ui/udp_listener"
+Thread.new do
+  puts "[HeapPeriscopeUi] UDP listener thread starting..."
+  host = ENV['UDP_HOST'] || '127.0.0.1'
+  port = ENV['UDP_PORT'] ? ENV['UDP_PORT'].to_i : 9000
+  begin
+    server = HeapPeriscopeUi::UdpListener.new(host: host, port: port)
+    server.run
+  rescue => e
+    puts "[HeapPeriscopeUi] ERROR in UDP listener thread: #{e.message}" # Changed to puts
+    puts e.backtrace.join("\n") # Changed to puts
+  end
+end

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+HeapPeriscopeUi::Engine.routes.draw do
+  resources :reports, only: [:index, :show]
+  get 'dashboard', to: 'dashboard#index', as: :dashboard
+  root to: "dashboard#index"
+end

data/db/migrate/20250617144101_create_heap_periscope_ui_profiler_reports.rb ADDED Viewed

@@ -0,0 +1,17 @@
+class CreateHeapPeriscopeUiProfilerReports < ActiveRecord::Migration[7.0] # Or your target Rails version
+  def change
+    create_table :heap_periscope_ui_profiler_reports do |t|
+      t.integer :process_id, null: false
+      t.string :report_type, null: false
+      t.datetime :reported_at, null: false
+      t.float :gc_duration_ms
+      t.integer :gc_invocation_count
+      t.text :raw_snapshot_stats
+      t.timestamps null: false # This adds created_at and updated_at, both null: false
+      t.index :process_id
+      t.index :report_type
+      t.index :reported_at
+    end
+  end
+end

data/db/migrate/20250617144853_create_heap_periscope_ui_object_counts.rb ADDED Viewed

@@ -0,0 +1,14 @@
+class CreateHeapPeriscopeUiObjectCounts < ActiveRecord::Migration[7.0] # Or your target Rails version
+  def change
+    create_table :heap_periscope_ui_object_counts do |t|
+      t.references :profiler_report, null: false, foreign_key: { to_table: :heap_periscope_ui_profiler_reports }, index: true
+      t.string :class_name, null: false
+      t.integer :count, null: false
+      t.boolean :is_platform_class, null: false
+      t.timestamps null: false # This adds created_at and updated_at, both null: false
+      t.index :class_name
+      # The profiler_report_id index is already created by t.references
+    end
+  end
+end

data/lib/generators/heap_periscope_ui/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module HeapPeriscopeUi
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+        def add_routes
+          route_info = "mount HeapPeriscopeUi::Engine => '/heap_periscope', as: 'heap_periscope_ui'"
+          action_cable_route_info = "mount ActionCable.server => '/cable'"
+          route_file_path = File.join(destination_root, 'config', 'routes.rb')
+          if File.exist?(route_file_path)
+            insert_into_file route_file_path, "\n  #{route_info}\n", after: "Rails.application.routes.draw do"
+            insert_into_file route_file_path, "\n  #{action_cable_route_info}\n", after: "Rails.application.routes.draw do"
+          else
+            say "Please add the following to your config/routes.rb file:"
+            say "  #{route_info}"
+          end
+        end
+        def show_readme
+          readme "README_SETUP" if behavior == :invoke
+        end
+      end
+    end
+end

data/lib/generators/heap_periscope_ui/install/templates/README_SETUP ADDED Viewed

@@ -0,0 +1,17 @@
+HeapPeriscopeUi has been installed. Please follow these steps:
+1. Run database migrations:
+   bundle exec rails db:migrate
+2. The engine has been mounted at `/heap_periscope` in your `config/routes.rb`.
+   You can change this path if needed.
+3. Configure your `heap_periscope_agent` gem to send data to the
+   ingestion endpoint provided by this UI engine.
+   The default ingestion endpoint will be at: `/heap_periscope/api/v1/ingest`
+   (Adjust the path if you changed the mount point in your routes).
+   Refer to the `heap_periscope_agent` documentation for how to configure
+   its data reporting endpoint.
+See the HeapPeriscopeUi gem's main README for more details on usage and customization.

data/lib/generators/heap_periscope_ui/install/templates/initializer.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# HeapPeriscopeUi.setup do |config|
+#   # Example configuration:
+#   # config.default_items_per_page = 50
+# end

data/lib/heap_periscope_ui/engine.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module HeapPeriscopeUi
+  class Engine < ::Rails::Engine
+    isolate_namespace HeapPeriscopeUi
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/heap_periscope_ui/udp_listener.rb ADDED Viewed

@@ -0,0 +1,131 @@
+require 'socket'
+require 'json'
+require 'thread'
+module HeapPeriscopeUi
+    class UdpListener
+        BATCH_WRITE_INTERVAL = 5 # seconds
+        BATCH_MAX_SIZE = 1000 # records
+        def initialize(host: HeapPeriscopeUi.udp_host, port: HeapPeriscopeUi.udp_port)
+          @host = host
+          @port = port
+          @socket = UDPSocket.new
+          @gc_report_batch = Queue.new
+          @running = false
+        end
+        def run
+          @running = true
+          puts "[HeapPeriscopeUi::UdpListener] Attempting to bind UDP server to #{@host}:#{@port}..." # Changed to puts
+          @socket.bind(@host, @port)
+          puts "[HeapPeriscopeUi::UdpListener] Successfully listening on UDP #{@host}:#{@port}" # Changed to puts
+          writer_thread = start_writer_thread
+          while @running
+            begin
+              data, addr = @socket.recvfrom(65536)
+              Thread.new { process_packet(data, addr) }
+            rescue IO::WaitReadable, Errno::EINTR
+              # These errors are expected during non-blocking I/O or when the socket is interrupted.
+              # Retry if the server is still supposed to be running.
+              retry if @running
+            rescue => e
+              # Using puts for consistency if Rails.logger is problematic in this thread
+              puts "[HeapPeriscopeUi::UdpListener] ERROR in receive loop: #{e.message}\n#{e.backtrace.join("\n")}"
+            end
+          end
+        rescue Interrupt
+          puts "[UDPServer] Shutting down..."
+        ensure
+          @running = false
+          writer_thread&.join(BATCH_WRITE_INTERVAL + 2)
+          write_gc_batch
+          @socket.close if @socket
+          puts "[UDPServer] UDP server stopped."
+        end
+        private
+        def process_packet(data, addr)
+          sender_ip = addr[3]
+          puts "[UDPServer] Received data from #{sender_ip}"
+          payload = JSON.parse(data)
+          # Broadcast to the stream name defined in the channel
+          ActionCable.server.broadcast("heap_periscope_runtime_stats", payload)
+          case payload['type']
+          when 'gc_profiler_report'
+            translate_gc_report(payload)
+          when 'snapshot'
+            translate_snapshot_report(payload)
+          else
+            puts "[UDPServer] Received unknown payload type: #{payload['type']}"
+          end
+        rescue JSON::ParserError => e
+          puts "[UDPServer] Error parsing JSON: #{e.message}"
+        rescue => e
+          puts "[UDPServer] An unexpected error occurred: #{e.message}\n#{e.backtrace.join("\n")}"
+        end
+        def translate_gc_report(payload)
+          report_data = {
+            process_id: payload['process_id'],
+            report_type: 'gc_profiler_report',
+            reported_at: payload['reported_at'],
+            gc_duration_ms: payload['payload']['gc_duration_since_last_check_ms'],
+            gc_invocation_count: payload['payload']['gc_invocation_count'],
+            created_at: Time.current,
+            updated_at: Time.current
+          }
+          @gc_report_batch << report_data
+        end
+        def translate_snapshot_report(payload)
+          snapshot_payload = payload['payload']
+          ActiveRecord::Base.transaction do
+            if snapshot_payload['living_objects_by_class']
+              object_counts_data = snapshot_payload['living_objects_by_class'].map do |class_name, count_details|
+                {
+                  profiler_report_id: SecureRandom.uuid,
+                  class_name: class_name,
+                  count: count_details['count'],
+                  is_platform_class: count_details['is_platform_class'],
+                  created_at: Time.current,
+                  updated_at: Time.current
+                }
+              end
+            end
+          end
+          puts "[UDPServer] Stored snapshot report for process #{payload['process_id']}."
+        end
+        def start_writer_thread
+          Thread.new do
+            while @running
+              sleep(BATCH_WRITE_INTERVAL)
+              write_gc_batch if @running # Only write if still supposed to be running
+            end
+          end
+        end
+        def write_gc_batch
+          return if @gc_report_batch.empty?
+          items_to_insert = []
+          items_to_insert << @gc_report_batch.pop until @gc_report_batch.empty? || items_to_insert.size >= BATCH_MAX_SIZE
+          return unless items_to_insert.any?
+          puts "[UDPServer] Writing batch of #{items_to_insert.size} GC reports to database..."
+        rescue => e
+          puts "[UDPServer] ERROR during batch insert: #{e.message}"
+        end
+    end
+end

data/lib/heap_periscope_ui/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module HeapPeriscopeUi
+  VERSION = "0.1.0"
+end

data/lib/heap_periscope_ui.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require "heap_periscope_ui/version"
+require "heap_periscope_ui/engine"
+module HeapPeriscopeUi; end
+# frozen_string_literal: true
+module HeapPeriscopeUi
+  mattr_accessor :udp_host, :udp_port, :default_items_per_page
+  self.udp_host = '0.0.0.0' # Listen on all available interfaces by default
+  self.udp_port = 52525     # Default port used by heap_periscope_agent
+  self.default_items_per_page = 25
+  def self.setup
+    yield self
+  end
+end

data/lib/tasks/heap_periscope_ui_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :heap_periscope_ui do
+#   # Task goes here
+# end

metadata ADDED Viewed

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: heap_periscope_ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Natanael Siahaan
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+description: 'HeapPeriscopeUi is a Rails engine designed to help developers monitor,
+  visualize, and diagnose memory-related issues within their Ruby applications. It
+  functions by listening for UDP packets containing GC profiler reports and heap snapshots,
+  typically transmitted by a companion agent (like `heap_periscope_agent`). The engine
+  efficiently processes this data: GC reports are batched for optimized database insertion,
+  while comprehensive heap snapshots, including detailed object counts by class, are
+  stored transactionally. Furthermore, HeapPeriscopeUi can broadcast incoming metrics
+  via ActionCable for real-time dashboard updates. Its integrated web interface allows
+  users to browse, filter, and analyze the collected profiler reports, facilitating
+  the identification of memory leaks, excessive object allocations, and opportunities
+  for performance optimization.'
+email:
+- js.jonathan.n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/heap_periscope_ui_manifest.js
+- app/assets/stylesheets/heap_periscope_ui/application.css
+- app/assets/stylesheets/heap_periscope_ui/visualizer.css
+- app/channels/heap_periscope_ui/application_cable/channel.rb
+- app/channels/heap_periscope_ui/application_cable/connection.rb
+- app/channels/heap_periscope_ui/runtime_stats_channel.rb
+- app/controllers/heap_periscope_ui/application_controller.rb
+- app/controllers/heap_periscope_ui/dashboard_controller.rb
+- app/helpers/heap_periscope_ui/application_helper.rb
+- app/jobs/heap_periscope_ui/application_job.rb
+- app/mailers/heap_periscope_ui/application_mailer.rb
+- app/models/heap_periscope_ui/application_record.rb
+- app/models/heap_periscope_ui/object_count.rb
+- app/models/heap_periscope_ui/profiler_report.rb
+- app/views/heap_periscope_ui/dashboard/index.html
+- app/views/heap_periscope_ui/dashboard/index.html.bak
+- app/views/layouts/heap_periscope_ui/application.html.erb
+- config/initializers/heap_periscope_ui_start_udp_listener.rb
+- config/routes.rb
+- db/migrate/20250617144101_create_heap_periscope_ui_profiler_reports.rb
+- db/migrate/20250617144853_create_heap_periscope_ui_object_counts.rb
+- lib/generators/heap_periscope_ui/install/install_generator.rb
+- lib/generators/heap_periscope_ui/install/templates/README_SETUP
+- lib/generators/heap_periscope_ui/install/templates/initializer.rb
+- lib/heap_periscope_ui.rb
+- lib/heap_periscope_ui/engine.rb
+- lib/heap_periscope_ui/udp_listener.rb
+- lib/heap_periscope_ui/version.rb
+- lib/tasks/heap_periscope_ui_tasks.rake
+homepage: https://github.com/codepawpaw/heap_periscope_ui
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/codepawpaw/heap_periscope_ui
+  source_code_uri: https://github.com/codepawpaw/heap_periscope_ui
+  changelog_uri: https://github.com/codepawpaw/heap_periscope_ui/releases
+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: A Rails engine providing a UI to visualize heap memory and GC metrics from
+  Ruby applications.
+test_files: []