Module: TestProf::StackProf

Extended by:
Logging
Defined in:
lib/test_prof/stack_prof.rb,
lib/test_prof/stack_prof/rspec.rb

Overview

StackProf wrapper.

Has 2 modes: global and per-example.

Example:

# To activate global profiling you can use env variable
TEST_STACK_PROF=1 rspec ...

# or in your code
TestProf::StackProf.run

To profile a specific examples add :sprof tag to it:

it "is doing heavy stuff", :sprof do
  ...
end

Defined Under Namespace

Classes: Configuration, Listener

Constant Summary

Constants included from Logging

Logging::COLORS

Class Method Summary collapse

Methods included from Logging

build_log_msg, colorize, log

Class Method Details

.config ⇒ Object 



49
50
51
 
# File 'lib/test_prof/stack_prof.rb', line 49

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ Object

Yields:



53
54
55
 
# File 'lib/test_prof/stack_prof.rb', line 53

def configure
  yield config
end

.dump(name) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/test_prof/stack_prof.rb', line 90

def dump(name)
  ::StackProf.stop

  path = build_path(name)

  ::StackProf.results(path)

  log :info, "StackProf report generated: #{path}"

  return unless config.raw

  html_path = path.gsub(/\.dump$/, '.html')

  log :info, <<~MSG
    Run the following command to generate a flame graph report:

    stackprof --flamegraph #{path} > #{html_path} && stackprof --flamegraph-viewer=#{html_path}
  MSG
end

.profile(name = nil) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/test_prof/stack_prof.rb', line 70

def profile(name = nil)
  return if locked?
  return unless init_stack_prof

  options = {
    mode: config.mode,
    raw: config.raw
  }

  options[:interval] = config.interval if config.interval

  if block_given?
    options[:out] = build_path(name)
    ::StackProf.run(options) { yield }
  else
    ::StackProf.start(options)
  end
  true
end

.run ⇒ Object

Run StackProf and automatically dump a report when the process exits or when the application is booted.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/test_prof/stack_prof.rb', line 59

def run
  return unless profile

  @locked = true

  log :info, "StackProf enabled#{config.raw? ? ' (raw)' : ''}: " \
             "mode – #{config.mode}, target – #{config.target}"

  at_exit { dump("total") } if config.suite?
end