gc_reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c222c825b6a36d78de4bb5c0685ac53caaaaef3f55ead344ff1548a60b4cf941
+  data.tar.gz: dcaee860d83bb29c4eaf1a80e575e9de265f16444a2676b57b20c0998be28048
+SHA512:
+  metadata.gz: 443044d4c0ddb10027b0b41941d72acad7e2489a78c652a4194743ff00598376b157263caccef1943cb8ef1704939556264351d99647fd6d4169fb148065e3bf
+  data.tar.gz: c670a8606e92d7bc64d01f93e63e06bd4f42322e65097c0df55b6ed8666e5292a5b7e46af3864b8780995cd1bf951ee9f23ea2cdb4a5cf8b66ffa54052ffc558

data/README.md

@@ -0,0 +1,50 @@
+# GC Reporter
+
+A simple Rails extension to collect and report Garbage Collection (`GC.stat`) and `ObjectSpace` statistics from your Ruby applications to a central monitoring application via Action Cable.
+
+It is designed to be lightweight and work in various Ruby process types:
+* Rails servers (Puma, Unicorn, etc.)
+* Sidekiq workers
+* Rake tasks
+
+## Receiving Application Setup
+
+Before using this gem, you need a Rails application with an Action Cable channel ready to receive the data.
+
+1.  **Generate a channel:**
+    ```bash
+    rails g channel GcStats
+    ```
+
+2.  **Implement the channel:** The channel needs to define a `report` action, which is the remote procedure call (RPC) endpoint this gem uses.
+
+    ```ruby
+    # app/channels/gc_stats_channel.rb
+    class GcStatsChannel < ApplicationCable::Channel
+      def subscribed
+        stream_from "gc_stats_channel"
+      end
+
+      def unsubscribed
+        # Any cleanup needed when a client disconnects
+      end
+
+      # This is the action called by the gem's client.
+      def report(data)
+        # data is the payload sent from the gc_reporter gem.
+        # Process it here: log it, save to a DB, or broadcast to a live dashboard.
+        Rails.logger.info "Received GC Stats from #{data['source']} (PID: #{data['process_id']})"
+        
+        # Example: Broadcast to a UI dashboard
+        ActionCable.server.broadcast("live_dashboard_channel", data)
+      end
+    end
+    ```
+
+## Installation
+
+Add `gc_reporter` to your application's Gemfile.
+
+```ruby
+# Gemfile
+gem 'gc_reporter', git: '[https://github.com/example/gc_reporter](https://github.com/example/gc_reporter)' # Or from RubyGems when published

data/gc_reporter.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/gc_reporter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gc_reporter"
+  spec.version       = GcReporter::VERSION
+  spec.authors       = ["Gemini AI"]
+  spec.email         = ["ai@google.com"]
+
+  spec.summary       = "Reports GC stats over Action Cable."
+  spec.description   = "A Rails extension to collect and report GC.stat and ObjectSpace counts from Rails, Sidekiq, and Rake tasks to a central Action Cable endpoint."
+  spec.homepage      = "https://github.com/codepawpaw/gc_reporter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Find all files tracked by git, excluding the spec/test directory.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Gem Dependencies
+  #spec.add_dependency "actioncable-client-ruby", "~> 0.4"
+  spec.add_dependency 'action_cable_client', '~> 3.1'
+  spec.add_dependency "railties", ">= 5.0.0"
+end

data/lib/gc_reporter/configuration.rb

@@ -0,0 +1,13 @@
+module GcReporter
+  class Configuration
+    attr_accessor :url, :channel, :interval, :source, :verbose
+
+    def initialize
+      @url = nil # Must be configured by the user, e.g., 'ws://localhost:3000/cable'
+      @channel = 'GcStatsChannel'
+      @interval = 30 # seconds
+      @source = "Process-#{Process.pid}" # A default identifier
+      @verbose = false
+    end
+  end
+end

data/lib/gc_reporter/railtie.rb

@@ -0,0 +1,12 @@
+module GcReporter
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      if defined?(Rails::Server)
+        GcReporter.configuration.source ||= "Rails-#{Process.pid}"
+        GcReporter::Reporter.start
+
+        at_exit { GcReporter::Reporter.stop }
+      end
+    end
+  end
+end

data/lib/gc_reporter/reporter.rb

@@ -0,0 +1,86 @@
+require 'action_cable_client'
+require 'time'
+require 'json'
+
+module GcReporter
+  class Reporter
+    def self.start
+      config = GcReporter.configuration
+      return if running?
+      return log("Cannot start: URL not configured.", level: :error) if config.url.nil?
+
+      @running = true
+      @thread = Thread.new do
+        client = ActionCableClient.new(config.url, channel: config.channel)
+        log("Reporter thread started. Sending stats every #{config.interval}s.")
+
+        client.connected { log("Successfully connected to Action Cable at #{config.url}.") }
+        client.disconnected { log("Disconnected from Action Cable. Client will try to reconnect.") }
+
+        loop do
+          break unless @running
+          begin
+            client.perform('report', collect_stats) if client.subscribed?
+          rescue => e
+            log("Error reporting stats: #{e.message}", level: :error)
+          end
+          sleep config.interval
+        end
+      end
+    end
+
+    # Stops the background reporting thread.
+    def self.stop
+      return unless running?
+      @running = false
+      @thread&.kill
+      @thread = nil
+      log("Reporter stopped.")
+    end
+
+    # Sends a single, synchronous report.
+    # Ideal for short-lived scripts like Rake tasks.
+    def self.report_once!
+      config = GcReporter.configuration
+      return log("Cannot report: URL not configured.", level: :error) if config.url.nil?
+
+      log("Performing a one-off report...")
+      # Using a block ensures the client is created and torn down cleanly.
+      ActionCableClient.start(config.url, channel: config.channel) do |client|
+        client.subscribed do
+          log("One-off report client subscribed. Sending data.")
+          client.perform('report', collect_stats)
+          # Disconnect after sending to allow the parent script to exit.
+          client.disconnect!
+        end
+      end
+    end
+
+    private
+
+    def self.running?
+      !!@running
+    end
+
+    def self.collect_stats
+      {
+        source: GcReporter.configuration.source,
+        process_id: Process.pid,
+        reported_at: Time.now.utc.iso8601,
+        payload: {
+          gc_stat: GC.stat,
+          object_counts: ObjectSpace.count_objects
+        }
+      }
+    end
+
+    def self.log(message, level: :info)
+      timestamp = Time.now.strftime('%Y-%m-%d %H:%M:%S')
+      if level == :error
+        warn "[GcReporter ERROR] #{timestamp}: #{message}"
+      elsif GcReporter.configuration.verbose
+        puts "[GcReporter INFO] #{timestamp}: #{message}"
+      end
+    end
+  end
+end

data/lib/gc_reporter/sidekiq.rb

@@ -0,0 +1,12 @@
+# This file must be explicitly required by the user in their Sidekiq initializer.
+if defined?(Sidekiq)
+  Sidekiq.configure_server do |config|
+    config.on(:startup) do
+      GcReporter.configuration.source ||= "Sidekiq-#{Process.pid}"
+      GcReporter::Reporter.start
+    end
+
+    config.on(:quiet) { GcReporter::Reporter.stop }
+    config.on(:shutdown) { GcReporter::Reporter.stop }
+  end
+end

data/lib/gc_reporter/version.rb

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

data/lib/gc_reporter.rb

@@ -0,0 +1,16 @@
+require "gc_reporter/version"
+require "gc_reporter/configuration"
+require "gc_reporter/reporter"
+require "gc_reporter/railtie" if defined?(Rails::Railtie)
+
+module GcReporter
+  class Error < StandardError; end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: gc_reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gemini AI
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: action_cable_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: A Rails extension to collect and report GC.stat and ObjectSpace counts
+  from Rails, Sidekiq, and Rake tasks to a central Action Cable endpoint.
+email:
+- ai@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- gc_reporter.gemspec
+- lib/gc_reporter.rb
+- lib/gc_reporter/configuration.rb
+- lib/gc_reporter/railtie.rb
+- lib/gc_reporter/reporter.rb
+- lib/gc_reporter/sidekiq.rb
+- lib/gc_reporter/version.rb
+homepage: https://github.com/codepawpaw/gc_reporter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/codepawpaw/gc_reporter
+  source_code_uri: https://github.com/codepawpaw/gc_reporter
+  changelog_uri: https://github.com/codepawpaw/gc_reporter/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Reports GC stats over Action Cable.
+test_files: []