leak_profiler 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89876429b4752e3c46009f0c6237a6868c6ef0416e58c504680a4bf7e75773f7
-  data.tar.gz: 6496e8a68442eefdf37b82f1e83e5040b259633e065420fc2d8f20e22596794a
+  metadata.gz: c65071dbbe8a5516095022d27fc86043512d1f2a1c12c8fcf24d9c3aea7e0a71
+  data.tar.gz: e2ba069b4a7b4ed7c369b72756ec8f97f2f32736ea212ae7092802d0e4aecf94
 SHA512:
-  metadata.gz: 27aebb5b8a2e891b19ecf7d5f498efbfc309472f2bd33a40fdafdfec10fb7f5a87c1ee081c03fe5a4dcfc47c972e0c9c288a5ab2b2f554b68f3f32191c229068
-  data.tar.gz: 22e1155055df5e750b1f0ac94a6ae0fdf5939402c14caa2ba0bfb43ff2bd10119025c28ccba3862817ad79a8e951cd55d9ad09a1fd54a6748da039a91217c2f6
+  metadata.gz: e3b875bd325d8ab5c36004b0c413ff7eeb742211e058669a5fd328dfe1ff654672b69a84cb4d627663085e37c0a540a881d36e40eb65c9a48e2b85fb23a99304
+  data.tar.gz: 6f26582f06e662a12ed60282fc41b78303de00ccd1350469e99565ec54ba142f1c68b966fea60e5294927aa724132165f9d49cdcdadba7ed2d30d478501c915f

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,6 +84,7 @@ 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.
@@ -103,6 +105,7 @@ elapsed [sec],ObjectSpace.memsize_of_all values [MB]
 
 * Arguments:
   * `interval` (default `1`): The interval in seconds for report.
+  * `filename` (defalut `nil`): Specify the filename if you want to use custom filename.
 
 ## Contributing
 

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

@@ -9,26 +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)
-    LeakProfiler::MemoryMemsize.new(output_dir: @output_dir, interval: interval).report
+  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

@@ -4,23 +4,24 @@ require 'objspace'
 
 class LeakProfiler
   class MemoryMemsize
-    def initialize(output_dir:, interval:)
+    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
-      pid = Process.pid
-
-      Thread.new do
+      @thread = Thread.start do
         i = 0
-        File.open(File.expand_path(File.join(@output_dir, "memory-memsize-#{pid}.csv")), 'w') do |f|
+        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}")
+            f.fsync
             i += @interval
             sleep(@interval)
           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,14 +15,15 @@ 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
             rss = Integer(`ps -o rss= -p #{pid}`) / 1024.0
             f.puts("#{i},#{rss}")
+            f.fsync
             i += @interval
             sleep(@interval)
           end

data/sig/leak_profiler.rbs

@@ -2,9 +2,9 @@ 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) -> self
+  def report: (?interval: Integer, ?max_allocations: Integer, ?max_referrers: Integer, ?logger: Object, ?filename: String) -> self
 
-  def report_rss: (?interval: Integer) -> self
+  def report_rss: (?interval: Integer, ?filename: String) -> self
 
-  def report_memsize: (?interval: Integer) -> 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leak_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Watson
@@ -41,6 +41,7 @@ files:
 - 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
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A simple profiler for Ruby to detect memory leak.
 test_files: []