Class: MemoryProfiler::Results

Inherits:
Object
  • Object
show all
Defined in:
lib/memory_profiler/results.rb

Constant Summary collapse

UNIT_PREFIXES =
{
  0 => 'B',
  3 => 'kB',
  6 => 'MB',
  9 => 'GB',
  12 => 'TB',
  15 => 'PB',
  18 => 'EB',
  21 => 'ZB',
  24 => 'YB'
}.freeze
TYPES =
["allocated", "retained"].freeze
METRICS =
["memory", "objects"].freeze
NAMES =
["gem", "file", "location", "class"].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#strings_allocatedObject

Returns the value of attribute strings_allocated


37
38
39
# File 'lib/memory_profiler/results.rb', line 37

def strings_allocated
  @strings_allocated
end

#strings_retainedObject

Returns the value of attribute strings_retained


37
38
39
# File 'lib/memory_profiler/results.rb', line 37

def strings_retained
  @strings_retained
end

#total_allocatedObject

Returns the value of attribute total_allocated


38
39
40
# File 'lib/memory_profiler/results.rb', line 38

def total_allocated
  @total_allocated
end

#total_allocated_memsizeObject

Returns the value of attribute total_allocated_memsize


39
40
41
# File 'lib/memory_profiler/results.rb', line 39

def total_allocated_memsize
  @total_allocated_memsize
end

#total_retainedObject

Returns the value of attribute total_retained


38
39
40
# File 'lib/memory_profiler/results.rb', line 38

def total_retained
  @total_retained
end

#total_retained_memsizeObject

Returns the value of attribute total_retained_memsize


39
40
41
# File 'lib/memory_profiler/results.rb', line 39

def total_retained_memsize
  @total_retained_memsize
end

Class Method Details

.register_type(name, stat_attribute) ⇒ Object


21
22
23
24
25
26
27
28
29
30
# File 'lib/memory_profiler/results.rb', line 21

def self.register_type(name, stat_attribute)
  @@lookups ||= []
  @@lookups << [name, stat_attribute]

  TYPES.each do |type|
    METRICS.each do |metric|
      attr_accessor "#{type}_#{metric}_by_#{name}"
    end
  end
end

Instance Method Details

#normalize_path(path) ⇒ Object


160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/memory_profiler/results.rb', line 160

def normalize_path(path)
  @normalize_path ||= {}
  @normalize_path[path] ||= begin
    if %r!(/gems/.*)*/gems/(?<gemname>[^/]+)(?<rest>.*)! =~ path
      "#{gemname}#{rest}"
    elsif %r!ruby/2\.[^/]+/(?<stdlib>[^/.]+)(?<rest>.*)! =~ path
      "ruby/lib/#{stdlib}#{rest}"
    elsif %r!(?<app>[^/]+/(bin|app|lib))(?<rest>.*)! =~ path
      "#{app}#{rest}"
    else
      path
    end
  end
end

#pretty_print(io = $stdout, **options) ⇒ Object

Output the results of the report

Parameters:

  • options (Hash)

    the options for output

  • opts (Hash)

    a customizable set of options


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/memory_profiler/results.rb', line 113

def pretty_print(io = $stdout, **options)
  # Handle the special case that Ruby PrettyPrint expects `pretty_print`
  # to be a customized pretty printing function for a class
  return io.pp_object(self) if defined?(PP) && io.is_a?(PP)

  io = File.open(options[:to_file], "w") if options[:to_file]

  color_output = options.fetch(:color_output) { io.respond_to?(:isatty) && io.isatty }
  @colorize = color_output ? Polychrome.new : Monochrome.new

  if options[:scale_bytes]
    total_allocated_output = scale_bytes(total_allocated_memsize)
    total_retained_output  = scale_bytes(total_retained_memsize)
  else
    total_allocated_output = "#{total_allocated_memsize} bytes"
    total_retained_output  = "#{total_retained_memsize} bytes"
  end

  io.puts "Total allocated: #{total_allocated_output} (#{total_allocated} objects)"
  io.puts "Total retained:  #{total_retained_output} (#{total_retained} objects)"

  unless options[:detailed_report] == false
    TYPES.each do |type|
      METRICS.each do |metric|
        NAMES.each do |name|
          dump_data(io, type, metric, name, options)
        end
      end
    end
  end

  io.puts
  print_string_reports(io, options)

  io.close if io.is_a? File
end

150
151
152
153
154
155
156
157
158
# File 'lib/memory_profiler/results.rb', line 150

def print_string_reports(io, options)
  TYPES.each do |type|
    dump_opts = {
      normalize_paths: options[:normalize_paths],
      limit: options["#{type}_strings".to_sym]
    }
    dump_strings(io, type, dump_opts)
  end
end

#register_results(allocated, retained, top) ⇒ Object


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/memory_profiler/results.rb', line 41

def register_results(allocated, retained, top)

  @@lookups.each do |name, stat_attribute|

    memsize_results, count_results = allocated.top_n(top, stat_attribute)

    self.send("allocated_memory_by_#{name}=", memsize_results)
    self.send("allocated_objects_by_#{name}=", count_results)

    memsize_results, count_results = retained.top_n(top, stat_attribute)

    self.send("retained_memory_by_#{name}=", memsize_results)
    self.send("retained_objects_by_#{name}=", count_results)
  end

  self.strings_allocated = string_report(allocated, top)
  self.strings_retained = string_report(retained, top)

  self.total_allocated = allocated.size
  self.total_allocated_memsize = total_memsize(allocated)
  self.total_retained = retained.size
  self.total_retained_memsize = total_memsize(retained)

  self
end

#scale_bytes(bytes) ⇒ Object


67
68
69
70
71
72
73
# File 'lib/memory_profiler/results.rb', line 67

def scale_bytes(bytes)
  return "0 B" if bytes.zero?

  scale = Math.log10(bytes).div(3) * 3
  scale = 24 if scale > 24
  "%.2f #{UNIT_PREFIXES[scale]}" % (bytes / 10.0**scale)
end

#string_report(data, top) ⇒ Object


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/memory_profiler/results.rb', line 75

def string_report(data, top)
  grouped_strings = Hash.new { |hash, key| hash[key] = [] }
  data.each_value do |stat|
    if stat.string_value
      grouped_strings[stat.string_value.object_id] << stat
    end
  end

  grouped_strings = grouped_strings.values

  if grouped_strings.size > top
    grouped_strings.sort_by!(&:size)
    grouped_strings = grouped_strings.drop(grouped_strings.size - top)
  end

  grouped_strings
    .sort! { |a, b| a.size == b.size ? a[0].string_value <=> b[0].string_value : b.size <=> a.size }
    .map! do |list|
      # Return array of [string, [[location, count], [location, count], ...]
      [
        list[0].string_value,
        list.group_by { |stat| stat.location }
          .map { |location, stat_list| [location, stat_list.size] }
          .sort_by!(&:last)
          .reverse!
      ]
    end
end