leak_profiler 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fbefd746a7383bc1891bea286e39be5f311b55e9e1bd8a10f9e807939c5686
-  data.tar.gz: 9268c65c42714ec98accf5e4a3f2bf36383a2c539e26850542e27b475fe93f12
+  metadata.gz: 8f865010e37ad98c3d1dfc80fde69b7d3a32ef06a2166dca3c38d0829c7f17fe
+  data.tar.gz: 5939197c9c2824d56b3d520a8106c4070694f8a5ba66575eb021ea8223a2f8f8
 SHA512:
-  metadata.gz: bf86b44edf7077e7d7ac6cc3c1af54379e3a5aaccfebced1a1b81aace9b1d6be2683b99d25cf8bf9e54492c0a14e405a003b93b5c4f522e9eb3839aabf6dbddb
-  data.tar.gz: 2778fbe72cbb71a5c2a4892f88b55dc01249a4f595ad4138eb15b7955c6ea09869ceae6f067d99ea1c5f92c3b7b0c0a5c045ae78c267321adfc66571c0b03c3f
+  metadata.gz: c4374a43ebbb3261281172d3ec46ba575c5707c82bca657501c5c3fe72dbae0ff3d384a5ce53179e7dd4d55e2aef256391c88484d7ea947da45477e7a06aa082
+  data.tar.gz: 91e28f5b4284598bb44ee9dde9306fbf2f6d46fe41a3ad3b7cce3c94d32315db249c8a6c427e0a9b01d76c73c196249efdc03aa23eea311811fac304764f2568

data/.rubocop.yml

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

data/README.md

@@ -65,6 +65,7 @@ Referrers ----------------------------------------------------------------------
   * `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

@@ -16,12 +16,15 @@ class LeakProfiler
     # @rbs interval: Integer
     # @rbs max_allocations: Integer
     # @rbs max_referrers: Integer
-    def initialize(logger:, interval:, max_allocations:, max_referrers:, max_sample_objects:)
+    # @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
@@ -31,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 }
 

data/lib/leak_profiler/leak_profiler.rb

@@ -22,13 +22,14 @@ class LeakProfiler
   # @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, max_sample_objects: 100, 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, max_sample_objects: max_sample_objects)
+    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, max_sample_objects: untyped) -> 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
 

data/sig/generated/leak_profiler/leak_profiler.rbs

@@ -9,10 +9,11 @@ class LeakProfiler
   # @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, ?max_sample_objects: 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leak_profiler
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Watson
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.4
 specification_version: 4
 summary: A simple profiler for Ruby to detect memory leak.
 test_files: []