Class: StackProf::Report
- Inherits:
-
Object
- Object
- StackProf::Report
- Defined in:
- lib/stackprof/report.rb
Instance Attribute Summary collapse
-
#data ⇒ Object
readonly
Returns the value of attribute data.
Instance Method Summary collapse
- #+(other) ⇒ Object
- #add_lines(a, b) ⇒ Object
- #files ⇒ Object
- #flamegraph_row(f, x, y, weight, addr) ⇒ Object
- #frames(sort_by_total = false) ⇒ Object
-
#initialize(data) ⇒ Report
constructor
A new instance of Report.
- #max_samples ⇒ Object
- #modeline ⇒ Object
- #normalized_frames ⇒ Object
- #overall_samples ⇒ Object
- #print_callgrind(f = STDOUT) ⇒ Object
- #print_debug ⇒ Object
- #print_dump(f = STDOUT) ⇒ Object
- #print_file(filter, f = STDOUT) ⇒ Object
- #print_files(sort_by_total = false, limit = nil, f = STDOUT) ⇒ Object
- #print_flamegraph(f = STDOUT, skip_common = true) ⇒ Object
- #print_graphviz(options = {}, f = STDOUT) ⇒ Object
- #print_method(name, f = STDOUT) ⇒ Object
- #print_stackcollapse ⇒ Object
- #print_text(sort_by_total = false, limit = nil, select_files = nil, reject_files = nil, select_names = nil, reject_names = nil, f = STDOUT) ⇒ Object
- #version ⇒ Object
-
#walk_method(name) ⇒ Object
Walk up and down the stack from a given starting point (name).
Constructor Details
#initialize(data) ⇒ Report
Returns a new instance of Report.
6 7 8 |
# File 'lib/stackprof/report.rb', line 6 def initialize(data) @data = data end |
Instance Attribute Details
#data ⇒ Object (readonly)
Returns the value of attribute data.
9 10 11 |
# File 'lib/stackprof/report.rb', line 9 def data @data end |
Instance Method Details
#+(other) ⇒ Object
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'lib/stackprof/report.rb', line 355 def +(other) raise ArgumentError, "cannot combine #{other.class}" unless self.class == other.class raise ArgumentError, "cannot combine #{modeline} with #{other.modeline}" unless modeline == other.modeline raise ArgumentError, "cannot combine v#{version} with v#{other.version}" unless version == other.version f1, f2 = normalized_frames, other.normalized_frames frames = (f1.keys + f2.keys).uniq.inject(Hash.new) do |hash, id| if f1[id].nil? hash[id] = f2[id] elsif f2[id] hash[id] = f1[id] hash[id][:total_samples] += f2[id][:total_samples] hash[id][:samples] += f2[id][:samples] if f2[id][:edges] edges = hash[id][:edges] ||= {} f2[id][:edges].each do |edge, weight| edges[edge] ||= 0 edges[edge] += weight end end if f2[id][:lines] lines = hash[id][:lines] ||= {} f2[id][:lines].each do |line, weight| lines[line] = add_lines(lines[line], weight) end end else hash[id] = f1[id] end hash end d1, d2 = data, other.data data = { version: version, mode: d1[:mode], interval: d1[:interval], samples: d1[:samples] + d2[:samples], gc_samples: d1[:gc_samples] + d2[:gc_samples], missed_samples: d1[:missed_samples] + d2[:missed_samples], frames: frames } self.class.new(data) end |
#add_lines(a, b) ⇒ Object
56 57 58 59 60 61 |
# File 'lib/stackprof/report.rb', line 56 def add_lines(a, b) return b if a.nil? return a+b if a.is_a? Integer return [ a[0], a[1]+b ] if b.is_a? Integer [ a[0]+b[0], a[1]+b[1] ] end |
#files ⇒ Object
44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/stackprof/report.rb', line 44 def files @data[:files] ||= @data[:frames].inject(Hash.new) do |hash, (addr, frame)| if file = frame[:file] and lines = frame[:lines] hash[file] ||= Hash.new lines.each do |line, weight| hash[file][line] = add_lines(hash[file][line], weight) end end hash end end |
#flamegraph_row(f, x, y, weight, addr) ⇒ Object
144 145 146 147 148 149 |
# File 'lib/stackprof/report.rb', line 144 def flamegraph_row(f, x, y, weight, addr) frame = frames[addr] f.print ',' if @rows_started @rows_started = true f.puts %{{"x":#{x},"y":#{y},"width":#{weight},"frame_id":#{addr},"frame":#{frame[:name].dump},"file":#{frame[:file].dump}}} end |
#frames(sort_by_total = false) ⇒ Object
11 12 13 14 |
# File 'lib/stackprof/report.rb', line 11 def frames(sort_by_total=false) @data[:"sorted_frames_#{sort_by_total}"] ||= @data[:frames].sort_by{ |iseq, stats| -stats[sort_by_total ? :total_samples : :samples] }.inject({}){|h, (k, v)| h[k] = v; h} end |
#max_samples ⇒ Object
40 41 42 |
# File 'lib/stackprof/report.rb', line 40 def max_samples @data[:max_samples] ||= frames.max_by{ |addr, frame| frame[:samples] }.last[:samples] end |
#modeline ⇒ Object
32 33 34 |
# File 'lib/stackprof/report.rb', line 32 def modeline "#{@data[:mode]}(#{@data[:interval]})" end |
#normalized_frames ⇒ Object
16 17 18 19 20 21 22 23 24 25 26 |
# File 'lib/stackprof/report.rb', line 16 def normalized_frames id2hash = {} @data[:frames].each do |frame, info| id2hash[frame.to_s] = info[:hash] = Digest::MD5.hexdigest("#{info[:name]}#{info[:file]}#{info[:line]}") end @data[:frames].inject(Hash.new) do |hash, (frame, info)| info = hash[id2hash[frame.to_s]] = info.dup info[:edges] = info[:edges].inject(Hash.new){ |edges, (edge, weight)| edges[id2hash[edge.to_s]] = weight; edges } if info[:edges] hash end end |
#overall_samples ⇒ Object
36 37 38 |
# File 'lib/stackprof/report.rb', line 36 def overall_samples @data[:samples] end |
#print_callgrind(f = STDOUT) ⇒ Object
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/stackprof/report.rb', line 232 def print_callgrind(f = STDOUT) f.puts "version: 1" f.puts "creator: stackprof" f.puts "pid: 0" f.puts "cmd: ruby" f.puts "part: 1" f.puts "desc: mode: #{modeline}" f.puts "desc: missed: #{@data[:missed_samples]})" f.puts "positions: line" f.puts "events: Instructions" f.puts "summary: #{@data[:samples]}" list = frames list.each do |addr, frame| f.puts "fl=#{frame[:file]}" f.puts "fn=#{frame[:name]}" frame[:lines].each do |line, weight| f.puts "#{line} #{weight.is_a?(Array) ? weight[1] : weight}" end if frame[:lines] frame[:edges].each do |edge, weight| oframe = list[edge] f.puts "cfl=#{oframe[:file]}" unless oframe[:file] == frame[:file] f.puts "cfn=#{oframe[:name]}" f.puts "calls=#{weight} #{frame[:line] || 0}\n#{oframe[:line] || 0} #{weight}" end if frame[:edges] f.puts end f.puts "totals: #{@data[:samples]}" end |
#print_debug ⇒ Object
63 64 65 |
# File 'lib/stackprof/report.rb', line 63 def print_debug pp @data end |
#print_dump(f = STDOUT) ⇒ Object
67 68 69 |
# File 'lib/stackprof/report.rb', line 67 def print_dump(f=STDOUT) f.puts Marshal.dump(@data.reject{|k,v| k == :files }) end |
#print_file(filter, f = STDOUT) ⇒ Object
347 348 349 350 351 352 353 |
# File 'lib/stackprof/report.rb', line 347 def print_file(filter, f = STDOUT) filter = /#{Regexp.escape filter}/ unless Regexp === filter list = files.select{ |name, lines| name =~ filter } list.sort_by{ |file, vals| -vals.values.inject(0){ |sum, n| sum + (n.is_a?(Array) ? n[1] : n) } }.each do |file, lines| source_display(f, file, lines) end end |
#print_files(sort_by_total = false, limit = nil, f = STDOUT) ⇒ Object
337 338 339 340 341 342 343 344 345 |
# File 'lib/stackprof/report.rb', line 337 def print_files(sort_by_total=false, limit=nil, f = STDOUT) list = files.map{ |file, vals| [file, vals.values.inject([0,0]){ |sum, n| add_lines(sum, n) }] } list = list.sort_by{ |file, samples| -samples[1] } list = list.first(limit) if limit list.each do |file, vals| total_samples, samples = *vals f.printf "% 5d (%5.1f%%) / % 5d (%5.1f%%) %s\n", total_samples, (100.0*total_samples/overall_samples), samples, (100.0*samples/overall_samples), file end end |
#print_flamegraph(f = STDOUT, skip_common = true) ⇒ Object
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 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 |
# File 'lib/stackprof/report.rb', line 83 def print_flamegraph(f=STDOUT, skip_common=true) raise "profile does not include raw samples (add `raw: true` to collecting StackProf.run)" unless raw = data[:raw] stacks = [] max_x = 0 max_y = 0 while len = raw.shift max_y = len if len > max_y stack = raw.slice!(0, len+1) stacks << stack max_x += stack.last end f.puts 'flamegraph([' max_y.times do |y| row_prev = nil row_width = 0 x = 0 stacks.each do |stack| weight = stack.last cell = stack[y] unless y == stack.length-1 if cell.nil? if row_prev flamegraph_row(f, x - row_width, y, row_width, row_prev) end row_prev = nil x += weight next end if row_prev.nil? # start new row with this cell row_width = weight row_prev = cell x += weight elsif row_prev == cell # grow current row along x-axis row_width += weight x += weight else # end current row and start new row flamegraph_row(f, x - row_width, y, row_width, row_prev) x += weight row_prev = cell row_width = weight end row_prev = cell end if row_prev next if skip_common && row_width == max_x flamegraph_row(f, x - row_width, y, row_width, row_prev) end end f.puts '])' end |
#print_graphviz(options = {}, f = STDOUT) ⇒ Object
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/stackprof/report.rb', line 151 def print_graphviz( = {}, f = STDOUT) if filter = [:filter] mark_stack = [] list = frames(true) list.each{ |addr, frame| mark_stack << addr if frame[:name] =~ filter } while addr = mark_stack.pop frame = list[addr] unless frame[:marked] mark_stack += frame[:edges].map{ |addr, weight| addr if list[addr][:total_samples] <= weight*1.2 }.compact if frame[:edges] frame[:marked] = true end end list = list.select{ |addr, frame| frame[:marked] } list.each{ |addr, frame| frame[:edges] && frame[:edges].delete_if{ |k,v| list[k].nil? } } list else list = frames(true) end limit = [:limit] fraction = [:node_fraction] included_nodes = {} node_minimum = fraction ? (fraction * overall_samples).ceil : 0 f.puts "digraph profile {" f.puts "Legend [shape=box,fontsize=24,shape=plaintext,label=\"" f.print "Total samples: #{overall_samples}\\l" f.print "Showing top #{limit} nodes\\l" if limit f.print "Dropped nodes with < #{node_minimum} samples\\l" if fraction f.puts "\"];" list.each_with_index do |(frame, info), index| call, total = info.values_at(:samples, :total_samples) break if total < node_minimum || (limit && index >= limit) sample = '' sample << "#{call} (%2.1f%%)\\rof " % (call*100.0/overall_samples) if call < total sample << "#{total} (%2.1f%%)\\r" % (total*100.0/overall_samples) fontsize = (1.0 * call / max_samples) * 28 + 10 size = (1.0 * total / overall_samples) * 2.0 + 0.5 f.puts " \"#{frame}\" [size=#{size}] [fontsize=#{fontsize}] [penwidth=\"#{size}\"] [shape=box] [label=\"#{info[:name]}\\n#{sample}\"];" included_nodes[frame] = true end list.each do |frame, info| next unless included_nodes[frame] if edges = info[:edges] edges.each do |edge, weight| next unless included_nodes[edge] size = (1.0 * weight / overall_samples) * 2.0 + 0.5 f.puts " \"#{frame}\" -> \"#{edge}\" [label=\"#{weight}\"] [weight=\"#{weight}\"] [penwidth=\"#{size}\"];" end end end f.puts "}" end |
#print_method(name, f = STDOUT) ⇒ Object
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/stackprof/report.rb', line 263 def print_method(name, f = STDOUT) name = /#{name}/ unless Regexp === name frames.each do |frame, info| next unless info[:name] =~ name file, line = info.values_at(:file, :line) line ||= 1 lines = info[:lines] maxline = lines ? lines.keys.max : line + 5 f.printf "%s (%s:%d)\n", info[:name], file, line f.printf " samples: % 5d self (%2.1f%%) / % 5d total (%2.1f%%)\n", info[:samples], 100.0*info[:samples]/overall_samples, info[:total_samples], 100.0*info[:total_samples]/overall_samples if (callers = callers_for(frame)).any? f.puts " callers:" callers = callers.sort_by(&:last).reverse callers.each do |name, weight| f.printf " % 5d (% 8s) %s\n", weight, "%3.1f%%" % (100.0*weight/info[:total_samples]), name end end if callees = info[:edges] f.printf " callees (%d total):\n", info[:total_samples]-info[:samples] callees = callees.map{ |k, weight| [data[:frames][k][:name], weight] }.sort_by{ |k,v| -v } callees.each do |name, weight| f.printf " % 5d (% 8s) %s\n", weight, "%3.1f%%" % (100.0*weight/(info[:total_samples]-info[:samples])), name end end f.puts " code:" source_display(f, file, lines, line-1..maxline) end end |
#print_stackcollapse ⇒ Object
71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/stackprof/report.rb', line 71 def print_stackcollapse raise "profile does not include raw samples (add `raw: true` to collecting StackProf.run)" unless raw = data[:raw] while len = raw.shift frames = raw.slice!(0, len) weight = raw.shift print frames.map{ |a| data[:frames][a][:name] }.join(';') puts " #{weight}" end end |
#print_text(sort_by_total = false, limit = nil, select_files = nil, reject_files = nil, select_names = nil, reject_names = nil, f = STDOUT) ⇒ Object
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/stackprof/report.rb', line 213 def print_text(sort_by_total=false, limit=nil, select_files= nil, reject_files=nil, select_names=nil, reject_names=nil, f = STDOUT) f.puts "==================================" f.printf " Mode: #{modeline}\n" f.printf " Samples: #{@data[:samples]} (%.2f%% miss rate)\n", 100.0*@data[:missed_samples]/(@data[:missed_samples]+@data[:samples]) f.printf " GC: #{@data[:gc_samples]} (%.2f%%)\n", 100.0*@data[:gc_samples]/@data[:samples] f.puts "==================================" f.printf "% 10s (pct) % 10s (pct) FRAME\n" % ["TOTAL", "SAMPLES"] list = frames(sort_by_total) list.select!{|_, info| select_files.any?{|path| info[:file].start_with?(path)}} if select_files list.select!{|_, info| select_names.any?{|reg| info[:name] =~ reg}} if select_names list.reject!{|_, info| reject_files.any?{|path| info[:file].start_with?(path)}} if reject_files list.reject!{|_, info| reject_names.any?{|reg| info[:name] =~ reg}} if reject_names list = list.first(limit) if limit list.each do |frame, info| call, total = info.values_at(:samples, :total_samples) f.printf "% 10d % 8s % 10d % 8s %s\n", total, "(%2.1f%%)" % (total*100.0/overall_samples), call, "(%2.1f%%)" % (call*100.0/overall_samples), info[:name] end end |
#version ⇒ Object
28 29 30 |
# File 'lib/stackprof/report.rb', line 28 def version @data[:version] end |
#walk_method(name) ⇒ Object
Walk up and down the stack from a given starting point (name). Loops until ‘:exit` is selected
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/stackprof/report.rb', line 298 def walk_method(name) method_choice = /#{Regexp.escape name}/ invalid_choice = false # Continue walking up and down the stack until the users selects "exit" while method_choice != :exit print_method method_choice unless invalid_choice STDOUT.puts "\n\n" # Determine callers and callees for the current frame new_frames = frames.select {|_, info| info[:name] =~ method_choice } new_choices = new_frames.map {|frame, info| [ callers_for(frame).sort_by(&:last).reverse.map(&:first), (info[:edges] || []).map{ |k, w| [data[:frames][k][:name], w] }.sort_by{ |k,v| -v }.map(&:first) ]}.flatten + [:exit] # Print callers and callees for selection STDOUT.puts "Select next method:" new_choices.each_with_index do |method, index| STDOUT.printf "%2d) %s\n", index + 1, method.to_s end # Pick selection STDOUT.printf "> " selection = STDIN.gets.chomp.to_i - 1 STDOUT.puts "\n\n\n" # Determine if it was a valid choice # (if not, don't re-run .print_method) if new_choice = new_choices[selection] invalid_choice = false method_choice = new_choice == :exit ? :exit : %r/^#{Regexp.escape new_choice}$/ else invalid_choice = true STDOUT.puts "Invalid choice. Please select again..." end end end |