Class: Hitimes::TimedMetric
- Extended by:
- Forwardable
- Defined in:
- lib/hitimes/timed_metric.rb
Overview
A TimedMetric holds the metrics on how long it takes to do something. For example, measuring how long a method takes to operate.
tm = TimedMetric.new( 'my-method' )
200.times do
my_method_result = tm.measure do
my_method( ... )
end
end
puts "#{ tm.name } operated at a rate of #{ tm.rate } calls per second"
Since TimedMetric is a child class of Metric make sure to look at the Metric API also.
A TimedMetric measures the execution time of an option with the Interval class.
A TimedMetric contains a Stats object, therefore TimedMetric has count
, max
, mean
, min
, rate
, stddev
, sum
, sumsq
methods that delegate to that Stats object for convenience.
Instance Attribute Summary collapse
-
#stats ⇒ Object
readonly
holds all the statistics.
Attributes inherited from Metric
#additional_data, #name, #sampling_delta
Class Method Summary collapse
-
.now(name, additional_data = {}) ⇒ Object
:call-seq: TimedMetric.now -> TimedMetric.
Instance Method Summary collapse
-
#initialize(name, additional_data = {}) ⇒ TimedMetric
constructor
:call-seq: TimedMetric.new( ‘name’) -> TimedMetric TimedMetric.new( ‘name’, ‘other’ => ‘data’) -> TimedMetric.
-
#measure(&block) ⇒ Object
:call-seq: timed_metric.measure { … } -> Object.
-
#running? ⇒ Boolean
:call-seq: timed_metric.running? -> true or false.
-
#split ⇒ Object
:call-seq: timed_metric.split -> Float.
-
#start ⇒ Object
:call-seq: timed_metric.start -> nil.
-
#stop ⇒ Object
:call-seq: timed_metric.stop -> Float or nil.
-
#to_hash ⇒ Object
:call-seq: metric.to_hash -> Hash Convert the metric to a hash.
Methods inherited from Metric
#sampling_start_time, #sampling_stop_time, #utc_microseconds
Constructor Details
#initialize(name, additional_data = {}) ⇒ TimedMetric
:call-seq:
TimedMetric.new( 'name') -> TimedMetric
TimedMetric.new( 'name', 'other' => 'data') -> TimedMetric
Create a new TimedMetric giving it a name and additional data. additional_data
may be anything that follows the to_hash
protocol
59 60 61 62 63 |
# File 'lib/hitimes/timed_metric.rb', line 59 def initialize( name, additional_data = {} ) super( name, additional_data ) @stats = Stats.new @current_interval = Interval.new end |
Instance Attribute Details
#stats ⇒ Object (readonly)
holds all the statistics
35 36 37 |
# File 'lib/hitimes/timed_metric.rb', line 35 def stats @stats end |
Class Method Details
.now(name, additional_data = {}) ⇒ Object
:call-seq:
TimedMetric.now -> TimedMetric
Return a TimedMetric that has been started
44 45 46 47 48 |
# File 'lib/hitimes/timed_metric.rb', line 44 def now( name, additional_data = {} ) t = TimedMetric.new( name, additional_data ) t.start return t end |
Instance Method Details
#measure(&block) ⇒ Object
:call-seq:
timed_metric.measure { ... } -> Object
Measure the execution of a block and add those stats to the running stats. The return value is the return value of the block
121 122 123 124 125 126 127 128 129 130 |
# File 'lib/hitimes/timed_metric.rb', line 121 def measure( &block ) return_value = nil begin start return_value = yield ensure stop end return return_value end |
#running? ⇒ Boolean
:call-seq:
timed_metric.running? -> true or false
return whether or not the timer is currently running.
71 72 73 |
# File 'lib/hitimes/timed_metric.rb', line 71 def running? @current_interval.running? end |
#split ⇒ Object
:call-seq:
timed_metric.split -> Float
Split the current TimedMetric. Essentially, mark a split time. This means stop the current interval and create a new interval, but make sure that the new interval lines up exactly, timewise, behind the previous interval.
If the timer is running, then split returns the duration of the previous interval, i.e. the split-time. If the timer is not running, nothing happens and false is returned.
145 146 147 148 149 150 151 152 153 154 |
# File 'lib/hitimes/timed_metric.rb', line 145 def split if @current_interval.running? then next_interval = @current_interval.split d = @current_interval.duration @stats.update( d ) @current_interval = next_interval return d end return false end |
#start ⇒ Object
:call-seq:
timed_metric.start -> nil
Start the current metric, if the current metric is already started, then this is a noop.
82 83 84 85 86 87 88 89 |
# File 'lib/hitimes/timed_metric.rb', line 82 def start if not @current_interval.running? then @current_interval.start @sampling_start_time ||= self.utc_microseconds() @sampling_start_interval ||= Interval.now end nil end |
#stop ⇒ Object
:call-seq:
timed_metric.stop -> Float or nil
Stop the current metric. This updates the stats and removes the current interval. If the timer was stopped then the duration of the last Interval is returned. If the timer was already stopped then false is returned and no stats are updated.
100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/hitimes/timed_metric.rb', line 100 def stop if @current_interval.running? then d = @current_interval.stop @stats.update( d ) @current_interval = Interval.new # update the length of time we have been sampling @sampling_delta = @sampling_start_interval.duration_so_far return d end return false end |