leak_profiler 0.7.6 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72f8b0c66ed134b82f8c7c4a5c1c19939962a8bd7cd2227df7e6e1fb695eaceb
-  data.tar.gz: 5e0a015723cb449c3cf3154f7d47da2e7ef20e001c8ae3d3b8a2339699cb11c9
+  metadata.gz: 8f865010e37ad98c3d1dfc80fde69b7d3a32ef06a2166dca3c38d0829c7f17fe
+  data.tar.gz: 5939197c9c2824d56b3d520a8106c4070694f8a5ba66575eb021ea8223a2f8f8
 SHA512:
-  metadata.gz: a8f4690f3a25c4169118b32560ab0f7bdc8d4199324bbff2b319582c736d4af2cd60233ce6278b3532f4bc64af348bc42ebe3e079c053a0997f49e60d9f3a9ea
-  data.tar.gz: adbaa8e3ca6968e3fe257d628e4a335b3e65a189f45893c7418bc166c1e01ffa87417c11e2ee30e5e87f89ff1d849f025616856743f32a690665c6cbd1e1b593
+  metadata.gz: c4374a43ebbb3261281172d3ec46ba575c5707c82bca657501c5c3fe72dbae0ff3d384a5ce53179e7dd4d55e2aef256391c88484d7ea947da45477e7a06aa082
+  data.tar.gz: 91e28f5b4284598bb44ee9dde9306fbf2f6d46fe41a3ad3b7cce3c94d32315db249c8a6c427e0a9b01d76c73c196249efdc03aa23eea311811fac304764f2568

data/.rubocop.yml

@@ -36,7 +36,10 @@ Layout/MultilineAssignmentLayout:
   Enabled: false
 
 Layout/LineLength:
-  Max: 180
+  Enabled: false
+
+Lint/IdentityComparison:
+  Enabled: false
 
 Lint/ConstantResolution:
   Enabled: false

data/README.md

@@ -64,6 +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.
+  * `max_sample_objects` (default `100`): Sampling objects to detect referrer.
+  * `run_gc` (default `false`): Whether to invoke `GC.start` before logging to exclude temporary objects from the metrics.
   * `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.
 

data/Rakefile

@@ -14,7 +14,7 @@ Rake::TestTask.new do |task|
   task.pattern = 'test/test_*.rb'
 end
 
-# Update RBS signature
+desc 'Update RBS signature'
 task :'rbs:update' do
   sh 'bundle exec rbs-inline --output lib'
 end

data/lib/leak_profiler/allocations.rb

@@ -3,6 +3,7 @@
 # rbs_inline: enabled
 
 require 'objspace'
+require 'set'
 
 class LeakProfiler
   class Allocations
@@ -15,11 +16,15 @@ class LeakProfiler
     # @rbs interval: Integer
     # @rbs max_allocations: Integer
     # @rbs max_referrers: Integer
-    def initialize(logger:, interval:, max_allocations:, max_referrers:)
+    # @rbs max_sample_objects: Integer
+    # @rbs run_gc: bool
+    def initialize(logger:, interval:, max_allocations:, max_referrers:, max_sample_objects:, run_gc: false)
       @logger = logger
       @interval = interval
       @max_allocations = max_allocations
       @max_referrers = max_referrers
+      @max_sample_objects = max_sample_objects
+      @run_gc = run_gc
     end
 
     def report
@@ -29,6 +34,8 @@ class LeakProfiler
           sleep(@interval)
           ObjectSpace.trace_object_allocations_stop
 
+          GC.start if @run_gc
+
           allocations = Hash.new { |h, k| h[k] = {} }
           allocations_by_class = Hash.new { |h, k| h[k] = 0 }
 
@@ -44,7 +51,12 @@ class LeakProfiler
             allocations[key][:metrics][:count] += 1
             allocations[key][:metrics][:bytes] += ObjectSpace.memsize_of(obj)
 
-            allocations[key][:sample_object] = obj
+            allocations[key][:sample_objects] ||= []
+            allocations[key][:sample_objects] << obj
+          end
+
+          allocations.each_value do |v|
+            v[:sample_objects] = v[:sample_objects].sample(@max_sample_objects)
           end
 
           report_allocations_class(allocations_by_class)
@@ -88,7 +100,7 @@ class LeakProfiler
 
       objs = allocations.reject { |k, _| k == UNKNOWN }
       sort(objs).take(@max_referrers).each do |key, value|
-        referrer_objects = detect_referrer_objects(value[:sample_object])
+        referrer_objects = detect_referrer_objects(value[:sample_objects])
 
         logs = referrer_objects.map do |r|
           klass = obj_class(r[:referrer_object])
@@ -102,12 +114,14 @@ class LeakProfiler
       end
     end
 
-    def detect_referrer_objects(object)
+    def detect_referrer_objects(objects)
       referrer_objects = []
+      objects_ids = objects.to_set(&:object_id)
+
       ObjectSpace.each_object.each do |obj|
         r = ObjectSpace.reachable_objects_from(obj)
         begin
-          if r&.any? { |o| o.equal?(object) }
+          if r&.any? { |o| objects_ids.include?(o.object_id) }
             key = allocated_location(obj)
             referrer_objects << { referrer_object: obj, referrer_object_allocated_line: key }
           end

data/lib/leak_profiler/leak_profiler.rb

@@ -21,13 +21,15 @@ class LeakProfiler
   # @rbs interval: Integer
   # @rbs max_allocations: Integer
   # @rbs max_referrers: Integer
+  # @rbs max_sample_objects: Integer
+  # @rbs run_gc: bool
   # @rbs logger: untyped
   # @rbs filename: String
   # @rbs return: self
-  def report(interval: 30, max_allocations: 10, max_referrers: 3, logger: nil, filename: nil)
+  def report(interval: 30, max_allocations: 10, max_referrers: 3, max_sample_objects: 100, run_gc: false, 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 = LeakProfiler::Allocations.new(logger: logger, interval: interval, max_allocations: max_allocations, max_referrers: max_referrers, max_sample_objects: max_sample_objects, run_gc: run_gc)
     profiler.report
     @threads << profiler.thread
 

data/sig/generated/leak_profiler/allocations.rbs

@@ -10,7 +10,9 @@ class LeakProfiler
     # @rbs interval: Integer
     # @rbs max_allocations: Integer
     # @rbs max_referrers: Integer
-    def initialize: (logger: untyped, interval: Integer, max_allocations: Integer, max_referrers: Integer) -> untyped
+    # @rbs max_sample_objects: Integer
+    # @rbs run_gc: bool
+    def initialize: (logger: untyped, interval: Integer, max_allocations: Integer, max_referrers: Integer, max_sample_objects: Integer, ?run_gc: bool) -> untyped
 
     def report: () -> untyped
 
@@ -22,7 +24,7 @@ class LeakProfiler
 
     def report_referrer_objects: (untyped allocations) -> untyped
 
-    def detect_referrer_objects: (untyped object) -> untyped
+    def detect_referrer_objects: (untyped objects) -> untyped
 
     def allocated_location: (untyped obj) -> untyped
 

data/sig/generated/leak_profiler/leak_profiler.rbs

@@ -8,10 +8,12 @@ class LeakProfiler
   # @rbs interval: Integer
   # @rbs max_allocations: Integer
   # @rbs max_referrers: Integer
+  # @rbs max_sample_objects: Integer
+  # @rbs run_gc: bool
   # @rbs logger: untyped
   # @rbs filename: String
   # @rbs return: self
-  def report: (?interval: Integer, ?max_allocations: Integer, ?max_referrers: Integer, ?logger: untyped, ?filename: String) -> self
+  def report: (?interval: Integer, ?max_allocations: Integer, ?max_referrers: Integer, ?max_sample_objects: Integer, ?run_gc: bool, ?logger: untyped, ?filename: String) -> self
 
   # @rbs interval: Integer
   # @rbs filename: String

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: leak_profiler
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.1
 platform: ruby
 authors:
 - Watson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -58,7 +57,6 @@ metadata:
   homepage_uri: https://github.com/Watson1978/leak_profiler
   source_code_uri: https://github.com/Watson1978/leak_profiler
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,8 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.4
 specification_version: 4
 summary: A simple profiler for Ruby to detect memory leak.
 test_files: []