leak_profiler 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b9ed880d59ba3afb26bc0c8842545114d800d2e4466bde187118c70ea489ca4
-  data.tar.gz: 9ac75655078d74b67928439f0ffb0493635075fee3226ebb4c37de6236bebd33
+  metadata.gz: 85fbefd746a7383bc1891bea286e39be5f311b55e9e1bd8a10f9e807939c5686
+  data.tar.gz: 9268c65c42714ec98accf5e4a3f2bf36383a2c539e26850542e27b475fe93f12
 SHA512:
-  metadata.gz: 3e2ca40923c1f4baa23266d4f84b811af144e7f5c9feacdc054df13817066bd8c608ba55b99f5f9f50e471d17ce00938a3646e02962ba776b9b02e81ad86c594
-  data.tar.gz: b8290c21265e17360816dd9f332f976a695c53d590b12aaeeb48324516ace274a88c47fc8bd43dff2d91686b263563de5472941183fcfd82aa0ae7c12456c491
+  metadata.gz: bf86b44edf7077e7d7ac6cc3c1af54379e3a5aaccfebced1a1b81aace9b1d6be2683b99d25cf8bf9e54492c0a14e405a003b93b5c4f522e9eb3839aabf6dbddb
+  data.tar.gz: 2778fbe72cbb71a5c2a4892f88b55dc01249a4f595ad4138eb15b7955c6ea09869ceae6f067d99ea1c5f92c3b7b0c0a5c045ae78c267321adfc66571c0b03c3f

data/.rubocop.yml

@@ -38,6 +38,9 @@ Layout/MultilineAssignmentLayout:
 Layout/LineLength:
   Max: 180
 
+Lint/IdentityComparison:
+  Enabled: false
+
 Lint/ConstantResolution:
   Enabled: false
 

data/README.md

@@ -64,6 +64,7 @@ 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.
   * `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/lib/leak_profiler/allocations.rb

@@ -3,20 +3,25 @@
 # rbs_inline: enabled
 
 require 'objspace'
+require 'set'
 
 class LeakProfiler
   class Allocations
+    UNKNOWN = '<unknown>:<unknown>'
+    private_constant :UNKNOWN
+
     attr_reader :thread
 
     # @rbs logger: untyped
     # @rbs interval: Integer
     # @rbs max_allocations: Integer
     # @rbs max_referrers: Integer
-    def initialize(logger:, interval:, max_allocations:, max_referrers:)
+    def initialize(logger:, interval:, max_allocations:, max_referrers:, max_sample_objects:)
       @logger = logger
       @interval = interval
       @max_allocations = max_allocations
       @max_referrers = max_referrers
+      @max_sample_objects = max_sample_objects
     end
 
     def report
@@ -37,13 +42,16 @@ class LeakProfiler
             end
 
             key = allocated_location(obj)
-            next unless key
-
             allocations[key][:metrics] ||= Hash.new { |h, k| h[k] = 0 }
             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)
@@ -84,8 +92,10 @@ class LeakProfiler
       return if @max_referrers <= 0
 
       @logger.add(Logger::Severity::INFO, "Referrers #{"-" * 80}")
-      sort(allocations).take(@max_referrers).each do |key, value|
-        referrer_objects = detect_referrer_objects(value[:sample_object])
+
+      objs = allocations.reject { |k, _| k == UNKNOWN }
+      sort(objs).take(@max_referrers).each do |key, value|
+        referrer_objects = detect_referrer_objects(value[:sample_objects])
 
         logs = referrer_objects.map do |r|
           klass = obj_class(r[:referrer_object])
@@ -99,15 +109,15 @@ 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)
-            next unless key
-
             referrer_objects << { referrer_object: obj, referrer_object_allocated_line: key }
           end
         rescue StandardError
@@ -117,9 +127,12 @@ class LeakProfiler
     end
 
     def allocated_location(obj)
-      return unless ObjectSpace.allocation_sourcefile(obj)
+      file = ObjectSpace.allocation_sourcefile(obj)
+      return UNKNOWN if file.nil? || file.empty?
+
+      line = ObjectSpace.allocation_sourceline(obj)
 
-      "#{ObjectSpace.allocation_sourcefile(obj)}:#{ObjectSpace.allocation_sourceline(obj)}"
+      "#{file}:#{line}"
     end
 
     def sort(allocations)

data/lib/leak_profiler/leak_profiler.rb

@@ -21,13 +21,14 @@ class LeakProfiler
   # @rbs interval: Integer
   # @rbs max_allocations: Integer
   # @rbs max_referrers: Integer
+  # @rbs max_sample_objects: Integer
   # @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, 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)
     profiler.report
     @threads << profiler.thread
 

data/sig/generated/leak_profiler/allocations.rbs

@@ -2,13 +2,15 @@
 
 class LeakProfiler
   class Allocations
+    UNKNOWN: ::String
+
     attr_reader thread: untyped
 
     # @rbs logger: untyped
     # @rbs interval: Integer
     # @rbs max_allocations: Integer
     # @rbs max_referrers: Integer
-    def initialize: (logger: untyped, interval: Integer, max_allocations: Integer, max_referrers: Integer) -> untyped
+    def initialize: (logger: untyped, interval: Integer, max_allocations: Integer, max_referrers: Integer, max_sample_objects: untyped) -> untyped
 
     def report: () -> untyped
 
@@ -20,7 +22,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,11 @@ class LeakProfiler
   # @rbs interval: Integer
   # @rbs max_allocations: Integer
   # @rbs max_referrers: Integer
+  # @rbs max_sample_objects: Integer
   # @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, ?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.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Watson