leak_profiler 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f38e71ee118af9012f16f7094a529faab161886bcf96ce02aedeafc6f513f4c6
-  data.tar.gz: 52b68f566fcaf407bb5ae1bd7434f1316ea341be6d0c274c5a0b3faf36b679bf
+  metadata.gz: 89876429b4752e3c46009f0c6237a6868c6ef0416e58c504680a4bf7e75773f7
+  data.tar.gz: 6496e8a68442eefdf37b82f1e83e5040b259633e065420fc2d8f20e22596794a
 SHA512:
-  metadata.gz: 37b790174706f1b8bee068581a5ecf26662a52abdd16892c1108ca8972f0bb137d94267af50362d955a066c7909dd6acb88e0d8d5435ea446f6b47fed9d0fceb
-  data.tar.gz: 1104d9a5a231bca9404fa8753fe93ebcb4a606f6b10823a15ec678613fe448aaa814ac6376aab382e16c327246915c01aac448bda1cf059528f15a27173a568f
+  metadata.gz: 27aebb5b8a2e891b19ecf7d5f498efbfc309472f2bd33a40fdafdfec10fb7f5a87c1ee081c03fe5a4dcfc47c972e0c9c288a5ab2b2f554b68f3f32191c229068
+  data.tar.gz: 22e1155055df5e750b1f0ac94a6ae0fdf5939402c14caa2ba0bfb43ff2bd10119025c28ccba3862817ad79a8e951cd55d9ad09a1fd54a6748da039a91217c2f6

data/.rubocop.yml

@@ -14,6 +14,9 @@ Metrics:
 Style/Copyright:
   Enabled: false
 
+Style/ImplicitRuntimeError:
+  Enabled: false
+
 Style/MissingElse:
   Enabled: false
 

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

@@ -66,6 +66,10 @@ Referrers ----------------------------------------------------------------------
   * `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.
 
+> [!WARNING]
+> This uses `ObjectSpace.allocation_sourcefile` method to measurement.
+> It can't get an object allocated information in Ruby core API / C extension library API.
+
 ### `LeakProfiler#report_rss`
 This method outputs the RSS (Resident Set Size) of the process with CSV format, like:
 
@@ -77,6 +81,26 @@ elapsed [sec],memory usage (rss) [MB]
 3,55.90234375
 ```
 
+* Arguments:
+  * `interval` (default `1`): The interval in seconds for report.
+
+> [!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.
 

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'
@@ -24,4 +25,10 @@ class LeakProfiler
 
     self
   end
+
+  def report_memsize(interval: 1)
+    LeakProfiler::MemoryMemsize.new(output_dir: @output_dir, interval: interval).report
+
+    self
+  end
 end

data/lib/leak_profiler/memory_memsize.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'objspace'
+
+class LeakProfiler
+  class MemoryMemsize
+    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-memsize-#{pid}.csv")), '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

@@ -8,6 +8,8 @@ class LeakProfiler
     end
 
     def report
+      raise('Not supported Windows platform because this uses `ps` command for measurement.') if /mingw/.match?(RUBY_PLATFORM)
+
       pid = Process.pid
 
       Thread.new 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) -> self
+
+  def report_rss: (?interval: Integer) -> self
+
+  def report_memsize: (?interval: Integer) -> self
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: leak_profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Watson
 bindir: bin
 cert_chain: []
-date: 2025-04-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -38,7 +38,9 @@ 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
 homepage: https://github.com/Watson1978/leak_profiler
 licenses:
 - MIT
@@ -60,7 +62,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: []