5 # This helper offers a method to measure the execution time of a block
8 # Allows you to measure the execution time of a block
9 # in a template and records the result to the log. Wrap this block around
10 # expensive operations or possible bottlenecks to get a time reading
11 # for the operation. For example, let's say you thought your file
12 # processing method was taking too long; you could wrap it in a benchmark block.
14 # <% benchmark "Process data files" do %>
15 # <%= expensive_files_operation %>
18 # That would add something like "Process data files (345.2ms)" to the log,
19 # which you can then use to compare timings when optimizing your code.
21 # You may give an optional logger level as the :level option.
22 # (:debug, :info, :warn, :error); the default value is :info.
24 # <% benchmark "Low-level files", :level => :debug do %>
25 # <%= lowlevel_files_operation %>
28 # Finally, you can pass true as the third argument to silence all log activity
29 # inside the block. This is great for boiling down a noisy block to just a single statement:
31 # <% benchmark "Process data files", :level => :info, :silence => true do %>
32 # <%= expensive_and_chatty_files_operation %>
34 def benchmark(message
= "Benchmarking", options
= {})
36 if options
.is_a
?(Symbol
)
37 ActiveSupport
::Deprecation.warn("use benchmark('#{message}', :level => :#{options}) instead", caller
)
38 options
= { :level => options
, :silence => false }
40 options
.assert_valid_keys(:level, :silence)
41 options
[:level] ||= :info
45 ms
= Benchmark
.ms
{ result
= options
[:silence] ? controller
.logger
.silence
{ yield } : yield }
46 controller
.logger
.send(options
[:level], '%s (%.1fms)' % [ message
, ms
])