leak_profiler 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 062abe3c1684ea42ac45baabb2b11ab19624fd461af76ee89aff981d0dec4cb4
-  data.tar.gz: e048e567ceae885b4ac91ff8b72b611144e131c9462ba1e33589c12e1fd392bc
+  metadata.gz: 6881c79a0e59209edf1ad4152128c9efafa002cff34f7d30708ef3c81507a577
+  data.tar.gz: 94671293bf106f7563b74c2370efc4c254d66c84ed59559d5bba029fcd1613d8
 SHA512:
-  metadata.gz: f023bc3f7a64638d2e63d7a9262a59b61b16459c22dca2d1a1bb5a3c846deb0758ffd525f504863107f0d3a1611f243fea0f55f6e2cdfbb801c8e75b51492b0d
-  data.tar.gz: 47fe07ea97905182c7656f9557efee004906a15ffcd8e56d465ad39eb3fe57cfc7878e3cc094b6779d6fb33dc143dfcc1b420c55cbbeb8fc2cea3f8ed03950c0
+  metadata.gz: e7490843212bda8d157a90bc64f4681cdc9a00f164de5edd9a166579d5d7801ce912fb6b70ed8f01e1a48a9aa3925ccff77ff81bbfcff8e6393c8f444f98dbb8
+  data.tar.gz: fcf967d7ae7a4c3e09832bb7352e738c7e454370a4b504e191036f080fe51129c67b4e4afff22638e38145f5e9e8e4d4aa8ed4c44aee3f373e87f28960f848d9

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-03-31 02:21:42 UTC using RuboCop version 1.75.1.
+# on 2025-04-26 03:09:17 UTC using RuboCop version 1.75.2.
 # 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
+# Offense count: 4
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
@@ -14,9 +14,10 @@ Style/Documentation:
     - 'test/**/*'
     - 'lib/leak_profiler/allocations.rb'
     - 'lib/leak_profiler/leak_profiler.rb'
+    - 'lib/leak_profiler/memory_memsize.rb'
     - 'lib/leak_profiler/memory_usage.rb'
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: AllowedMethods, RequireForNonPublicMethods.
 Style/DocumentationMethod:
   Exclude:
@@ -24,4 +25,5 @@ Style/DocumentationMethod:
     - 'test/**/*'
     - 'lib/leak_profiler/allocations.rb'
     - 'lib/leak_profiler/leak_profiler.rb'
+    - 'lib/leak_profiler/memory_memsize.rb'
     - 'lib/leak_profiler/memory_usage.rb'

data/README.md

@@ -27,7 +27,7 @@ LeakProfiler.new.report.report_rss
 # ... your code that may have memory leaks ...
 ```
 
-### `LeakProfiler#new`
+### `LeakProfiler.new`
 * Arguments:
   * `output_dir` (default `./leak_profiler`): Specify the output directory for report.
 
@@ -64,7 +64,8 @@ Referrers ----------------------------------------------------------------------
   * `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.
+  * `logger` (defalut `nil`): Specify the logger object if you want to use custom logger.
+  * `filename` (defalut `nil`): Specify the filename if you want to use custom filename.
 
 > [!WARNING]
 > This uses `ObjectSpace.allocation_sourcefile` method to measurement.
@@ -83,11 +84,29 @@ elapsed [sec],memory usage (rss) [MB]
 
 * Arguments:
   * `interval` (default `1`): The interval in seconds for report.
+  * `filename` (defalut `nil`): Specify the filename if you want to use custom filename.
 
 > [!WARNING]
 > This uses this uses `ps` command for measurement.
 > So, this is not supported Windows platform.
 
+
+### `LeakProfiler#report_memsize`
+This method outputs `ObjectSpace.memsize_of_all` values with CSV format, like:
+
+```
+elapsed [sec],ObjectSpace.memsize_of_all values [MB]
+0,11.435378074645996
+1,12.78317642211914
+2,11.785511016845703
+3,11.785999298095703
+4,11.786487579345703
+```
+
+* Arguments:
+  * `interval` (default `1`): The interval in seconds for report.
+  * `filename` (defalut `nil`): Specify the filename if you want to use custom filename.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Watson1978/leak_profiler.

data/Rakefile

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
+require 'rake/testtask'
 
-RuboCop::RakeTask.new
+task default: :test
 
-task default: :rubocop
+Rake::TestTask.new do |task|
+  task.pattern = 'test/test_*.rb'
+end

data/lib/leak_profiler/allocations.rb

@@ -4,6 +4,8 @@ require 'objspace'
 
 class LeakProfiler
   class Allocations
+    attr_reader :thread
+
     def initialize(logger:, interval:, max_allocations:, max_referrers:)
       @logger = logger
       @interval = interval
@@ -12,7 +14,7 @@ class LeakProfiler
     end
 
     def report
-      Thread.start do
+      @thread = Thread.start do
         loop do
           allocations = {}
 

data/lib/leak_profiler/leak_profiler.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'allocations'
+require_relative 'memory_memsize'
 require_relative 'memory_usage'
 require 'fileutils'
 require 'logger'
@@ -8,20 +9,39 @@ require 'logger'
 class LeakProfiler
   def initialize(output_dir: './leak_profiler')
     @output_dir = output_dir
+    @threads = []
 
     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
+  def report(interval: 30, max_allocations: 10, max_referrers: 3, logger: nil, filename: nil)
+    filename ||= "leak_profiler-#{Process.pid}.log"
+    logger ||= Logger.new(File.join(@output_dir, filename))
+    profiler = LeakProfiler::Allocations.new(logger: logger, interval: interval, max_allocations: max_allocations, max_referrers: max_referrers)
+    profiler.report
+    @threads << profiler.thread
 
     self
   end
 
-  def report_rss(interval: 1)
-    LeakProfiler::MemoryUsage.new(output_dir: @output_dir, interval: interval).report
+  def report_rss(interval: 1, filename: nil)
+    profiler = LeakProfiler::MemoryUsage.new(output_dir: @output_dir, interval: interval, filename: filename)
+    profiler.report
+    @threads << profiler.thread
 
     self
   end
+
+  def report_memsize(interval: 1, filename: nil)
+    profiler = LeakProfiler::MemoryMemsize.new(output_dir: @output_dir, interval: interval, filename: filename)
+    profiler.report
+    @threads << profiler.thread
+
+    self
+  end
+
+  def shutdown
+    @threads.each(&:kill)
+    @threads.each(&:join)
+  end
 end

data/lib/leak_profiler/memory_memsize.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'objspace'
+
+class LeakProfiler
+  class MemoryMemsize
+    attr_reader :thread
+
+    def initialize(output_dir:, interval:, filename: nil)
+      @output_dir = output_dir
+      @interval = interval
+      @filename = filename || "memory-memsize-#{Process.pid}.csv"
+    end
+
+    def report
+      @thread = Thread.start do
+        i = 0
+        File.open(File.expand_path(File.join(@output_dir, @filename)), 'w') do |f|
+          f.puts('elapsed [sec],ObjectSpace.memsize_of_all values [MB]')
+
+          loop do
+            memsize = Float(ObjectSpace.memsize_of_all) / (1024 * 1024)
+
+            f.puts("#{i},#{memsize}")
+            i += @interval
+            sleep(@interval)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/leak_profiler/memory_usage.rb

@@ -2,9 +2,12 @@
 
 class LeakProfiler
   class MemoryUsage
-    def initialize(output_dir:, interval:)
+    attr_reader :thread
+
+    def initialize(output_dir:, interval:, filename: nil)
       @output_dir = output_dir
       @interval = interval
+      @filename = filename || "memory-usage-#{Process.pid}.csv"
     end
 
     def report
@@ -12,9 +15,9 @@ class LeakProfiler
 
       pid = Process.pid
 
-      Thread.new do
+      @thread = Thread.start do
         i = 0
-        File.open(File.expand_path(File.join(@output_dir, "memory-usage-#{pid}.csv")), 'w') do |f|
+        File.open(File.expand_path(File.join(@output_dir, @filename)), 'w') do |f|
           f.puts('elapsed [sec],memory usage (rss) [MB]')
 
           loop do

data/sig/leak_profiler.rbs

@@ -0,0 +1,10 @@
+class LeakProfiler
+  def initialize: (?output_dir: String) -> void
+
+  # TODO: Use valid type for logger
+  def report: (?interval: Integer, ?max_allocations: Integer, ?max_referrers: Integer, ?logger: Object, ?filename: String) -> self
+
+  def report_rss: (?interval: Integer, ?filename: String) -> self
+
+  def report_memsize: (?interval: Integer, ?filename: String) -> self
+end

data/test/test_leak_profiler.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'leak_profiler'
+require 'minitest/autorun'
+
+class LeakProfilerTest < Minitest::Test
+  def test_report
+    output_dir = './tmp'
+    profiler = LeakProfiler.new(output_dir: output_dir)
+
+    profiler.report(interval: 1, max_allocations: 5, max_referrers: 2, filename: 'test_report.log')
+    sleep(2)
+    profiler.shutdown
+
+    assert(File.exist?(File.join(output_dir, 'test_report.log')))
+  end
+
+  def test_report_rss
+    output_dir = './tmp'
+    profiler = LeakProfiler.new(output_dir: output_dir)
+
+    profiler.report_rss(interval: 1, filename: 'test_report_rss.csv')
+    sleep(2)
+    profiler.shutdown
+
+    assert(File.exist?(File.join(output_dir, 'test_report_rss.csv')))
+  end
+
+  def test_report_memsize
+    output_dir = './tmp'
+    profiler = LeakProfiler.new(output_dir: output_dir)
+
+    profiler.report_memsize(interval: 1, filename: 'test_report_memsize.csv')
+    sleep(2)
+    profiler.shutdown
+
+    assert(File.exist?(File.join(output_dir, 'test_report_memsize.csv')))
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: leak_profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Watson
 bindir: bin
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -38,7 +38,10 @@ files:
 - lib/leak_profiler.rb
 - lib/leak_profiler/allocations.rb
 - lib/leak_profiler/leak_profiler.rb
+- lib/leak_profiler/memory_memsize.rb
 - lib/leak_profiler/memory_usage.rb
+- sig/leak_profiler.rbs
+- test/test_leak_profiler.rb
 homepage: https://github.com/Watson1978/leak_profiler
 licenses:
 - MIT
@@ -60,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A simple profiler for Ruby to detect memory leak.
 test_files: []