leak_profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 858a9f5099616dfa89103dfdc39b9ea1d3ea1c57f2a0d9cd70f2567e7d67e977
+  data.tar.gz: a53f3aeedb0d9d64929dbfa8dde45768b164f3fbbb0adf4952ca1f75a39e5c4a
+SHA512:
+  metadata.gz: a8940ecc511d02760bb585e6c2bdb82740a97fd47264924e6ad233a0eebcd90b90724e5e11915543c24e1d60dbafd988e38de80d2b775898e74ac1c9e0c786a0
+  data.tar.gz: 778f50f3c181d01dfd90a067f47959feb31a0998df767fee645b60019535cbb0dc0663fc785f2b99adb3039eafd9fddf6d0a1d2291254f0c2f65202aaaf18c97

data/.rubocop.yml

@@ -0,0 +1,36 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  EnabledByDefault: true
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+
+Bundler/GemComment:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+Style/MissingElse:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 180
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Lint/SuppressedException:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,27 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-03-31 02:21:42 UTC using RuboCop version 1.75.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/leak_profiler/allocations.rb'
+    - 'lib/leak_profiler/leak_profiler.rb'
+    - 'lib/leak_profiler/memory_usage.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, RequireForNonPublicMethods.
+Style/DocumentationMethod:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/leak_profiler/allocations.rb'
+    - 'lib/leak_profiler/leak_profiler.rb'
+    - 'lib/leak_profiler/memory_usage.rb'

data/README.md

@@ -0,0 +1,85 @@
+# LeakProfiler
+
+This is a Ruby gem for profiling memory leaks in Ruby applications.
+It provides tools to help identify and analyze memory usage patterns, making it easier to find and fix memory leaks.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add leak_profiler
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install leak_profiler
+```
+
+## Usage
+
+```ruby
+require 'leak_profiler'
+
+LeakProfiler.new.report.report_rss
+
+# ... your code that may have memory leaks ...
+```
+
+### `LeakProfiler#new`
+* Arguments:
+  * `output_dir` (default `./leak_profiler`): Specify the output directory for report.
+
+### `LeakProfiler#report`
+This method outputs where the object was allocated and where it is referenced, like:
+
+```
+Allocations ================================================================================
+/home/watson/src/fluentd/lib/fluent/plugin_helper/thread.rb:70 retains 1098464 bytes, allocations 165 objects
+/home/watson/src/fluentd/lib/fluent/plugin/metrics_local.rb:58 retains 56400 bytes, allocations 50 objects
+/home/watson/.rbenv/versions/3.4.2/lib/ruby/3.4.0/open3.rb:534 retains 50080 bytes, allocations 544 objects
+/home/watson/src/fluentd/lib/fluent/msgpack_factory.rb:105 retains 44400 bytes, allocations 50 objects
+/home/watson/.rbenv/versions/3.4.2/lib/ruby/site_ruby/3.4.0/rubygems/specification.rb:1093 retains 43846 bytes, allocations 409 objects
+/home/watson/src/fluentd/lib/fluent/plugin.rb:181 retains 40960 bytes, allocations 23 objects
+/home/watson/src/fluentd/lib/fluent/msgpack_factory.rb:99 retains 36000 bytes, allocations 200 objects
+/home/watson/.rbenv/versions/3.4.2/lib/ruby/3.4.0/open3.rb:535 retains 29400 bytes, allocations 49 objects
+/home/watson/.rbenv/versions/3.4.2/lib/ruby/gems/3.4.0/gems/csv-3.3.3/lib/csv/writer.rb:154 retains 26820 bytes, allocations 56 objects
+/home/watson/.rbenv/versions/3.4.2/lib/ruby/gems/3.4.0/gems/csv-3.3.3/lib/csv.rb:2983 retains 26560 bytes, allocations 61 objects
+Referrers --------------------------------------------------------------------------------
+/home/watson/src/fluentd/lib/fluent/plugin_helper/thread.rb:70 object is referred at:
+    Fiber (allocated at /home/watson/src/fluentd/lib/fluent/plugin/metrics_local.rb:58)
+    NameError::message (allocated at /home/watson/.rbenv/versions/3.4.2/lib/ruby/3.4.0/open3.rb:534)
+    NoMethodError (allocated at /home/watson/.rbenv/versions/3.4.2/lib/ruby/3.4.0/open3.rb:534)
+    Fluent::PluginHelper::ChildProcess::ProcessInfo (allocated at /home/watson/src/fluentd/lib/fluent/plugin_helper/child_process.rb:355)
+    Hash (allocated at /home/watson/src/fluentd/lib/fluent/plugin/formatter_csv.rb:55)
+...
+```
+
+**Allocations**: This section lists the locations in the code where object was allocated, along with the size of the allocation and the number of objects allocated.
+
+**Referrers**: This section lists the locations in the code where the object is referenced.
+
+* Arguments:
+  * `interval` (default `30`): The interval in seconds for report.
+  * `max_allocations` (default `10`): Outputs the specified number of objects that use a lot of memory.
+  * `max_referrers` (default `3`): Outputs the number of references in order of the amount of memory used.
+  * `report` (defalut `nil`): Specify the logger object if you want to use custom logger.
+
+### `LeakProfiler#report_rss`
+This method outputs the RSS (Resident Set Size) of the process with CSV format, like:
+
+```
+elapsed [sec],memory usage (rss) [MB]
+0,47.20703125
+1,53.40234375
+2,55.02734375
+3,55.90234375
+```
+
+* Arguments:
+  * `interval` (default `1`): The interval in seconds for report.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Watson1978/leak_profiler.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/leak_profiler/allocations.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'objspace'
+
+class LeakProfiler
+  class Allocations
+    def initialize(logger:, interval:, max_allocations:, max_referrers:)
+      @logger = logger
+      @interval = interval
+      @max_allocations = max_allocations
+      @max_referrers = max_referrers
+    end
+
+    def report
+      Thread.start do
+        loop do
+          allocations = {}
+
+          ObjectSpace.trace_object_allocations_start
+          sleep(@interval)
+          ObjectSpace.trace_object_allocations_stop
+
+          ObjectSpace.each_object.each do |obj|
+            key = allocated_location(obj)
+            next unless key
+
+            allocations[key] ||= {}
+            allocations[key][:metrics] ||= Hash.new { |h, k| h[k] = 0 }
+            allocations[key][:metrics][:count] += 1
+            allocations[key][:metrics][:bytes] += ObjectSpace.memsize_of(obj)
+
+            allocations[key][:sample_object] = obj
+          end
+
+          report_allocations(allocations)
+          report_referrer_objects(allocations)
+        end
+      end
+    end
+
+    private
+
+    def report_allocations(allocations)
+      return if @max_allocations <= 0
+
+      @logger.add(Logger::Severity::INFO, "Allocations #{"=" * 80}")
+      sort(allocations).take(@max_allocations).each do |key, value|
+        @logger.add(Logger::Severity::INFO, "#{key} retains #{value[:metrics][:bytes]} bytes, allocations #{value[:metrics][:count]} objects")
+      end
+    end
+
+    def report_referrer_objects(allocations)
+      return if @max_referrers <= 0
+
+      @logger.add(Logger::Severity::INFO, "Referrers #{"-" * 80}")
+      sort(allocations).take(@max_referrers).each do |key, value|
+        referrer_objects = detect_referrer_objects(value[:sample_object])
+
+        logs = referrer_objects.map do |r|
+          "    #{r[:referrer_object].class} (allocated at #{r[:referrer_object_allocated_line]})"
+        end
+
+        @logger.add(Logger::Severity::INFO, "#{key} object is referred at:")
+        logs.uniq.each do |log|
+          @logger.add(Logger::Severity::INFO, log)
+        end
+      end
+    end
+
+    def detect_referrer_objects(object)
+      referrer_objects = []
+      ObjectSpace.each_object.each do |obj|
+        r = ObjectSpace.reachable_objects_from(obj)
+        begin
+          if r&.include?(object)
+            key = allocated_location(obj)
+            next unless key
+
+            referrer_objects << { referrer_object: obj, referrer_object_allocated_line: key }
+          end
+        rescue StandardError
+        end
+      end
+      referrer_objects
+    end
+
+    def allocated_location(obj)
+      return unless ObjectSpace.allocation_sourcefile(obj)
+
+      "#{ObjectSpace.allocation_sourcefile(obj)}:#{ObjectSpace.allocation_sourceline(obj)}"
+    end
+
+    def sort(allocations)
+      allocations.sort_by { |_, v| -v[:metrics][:bytes] }
+    end
+  end
+end

data/lib/leak_profiler/leak_profiler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'allocations'
+require_relative 'memory_usage'
+require 'fileutils'
+
+class LeakProfiler
+  def initialize(output_dir: './leak_profiler')
+    @output_dir = output_dir
+
+    FileUtils.mkdir_p(@output_dir)
+  end
+
+  def report(interval: 30, max_allocations: 10, max_referrers: 3, logger: nil)
+    logger ||= Logger.new(File.join(@output_dir, "leak_profiler-#{Process.pid}.log"))
+    LeakProfiler::Allocations.new(logger: logger, interval: interval, max_allocations: max_allocations, max_referrers: max_referrers).report
+
+    self
+  end
+
+  def report_rss(interval: 1)
+    LeakProfiler::MemoryUsage.new(output_dir: @output_dir, interval: interval).report
+
+    self
+  end
+end

data/lib/leak_profiler/memory_usage.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class LeakProfiler
+  class MemoryUsage
+    def initialize(output_dir:, interval:)
+      @output_dir = output_dir
+      @interval = interval
+    end
+
+    def report
+      pid = Process.pid
+
+      Thread.new do
+        i = 0
+        File.open(File.expand_path(File.join(@output_dir, "memory-usage-#{pid}.csv")), 'w') do |f|
+          f.puts('elapsed [sec],memory usage (rss) [MB]')
+
+          loop do
+            rss = Integer(`ps -o rss= -p #{pid}`) / 1024.0
+            f.puts("#{i},#{rss}")
+            i += @interval
+            sleep(@interval)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/leak_profiler.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'leak_profiler/leak_profiler'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: leak_profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Watson
+bindir: bin
+cert_chain: []
+date: 2025-03-31 00:00:00.000000000 Z
+dependencies: []
+description: A simple profiler for Ruby to detect memory leak.
+email:
+- watson1978@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- README.md
+- Rakefile
+- lib/leak_profiler.rb
+- lib/leak_profiler/allocations.rb
+- lib/leak_profiler/leak_profiler.rb
+- lib/leak_profiler/memory_usage.rb
+homepage: https://github.com/Watson1978/leak_profiler
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Watson1978/leak_profiler
+  source_code_uri: https://github.com/Watson1978/leak_profiler
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A simple profiler for Ruby to detect memory leak.
+test_files: []