hitimes 1.0.0 → 1.0.1

data/HISTORY

@@ -1,4 +1,9 @@
 = Changelog
+== Version 1.0.1 2009-06-12
+
+* Fix examples
+* performance tuning, new Metric classes are faster than old Timer class
+
 == Version 1.0.0 2009-06-12
 
 * Major version bump with complete refactor of the metric collection API

data/examples/benchmarks.rb

@@ -44,16 +44,39 @@ end
 # Use a new timer each time
 #
 def hitimes_duration_t1
-  Hitimes::Timer.now.stop
+  Hitimes::TimedMetric.now('duration_t1').stop
 end
 
 #
 # reuse the same timer over and over
 #
-HT = Hitimes::Timer.new
+HT2= Hitimes::TimedMetric.new( 'duration_t2' )
 def hitimes_duration_t2
-  HT.start
-  HT.stop
+  HT2.start
+  HT2.stop
+end
+
+HT3 = Hitimes::TimedMetric.new( 'duration_t3' )
+def hitimes_duration_t3
+  HT3.measure { nil }
+end
+
+#
+# Check out the speed of the TimedValueMetric too
+#
+def hitimes_duration_tv1
+  Hitimes::TimedValueMetric.now( 'duration_tv1' ).stop( 42 )
+end
+
+HTV2 = Hitimes::TimedValueMetric.new( 'duration_tv2' )
+def hitimes_duration_tv2
+  HTV2.start
+  HTV2.stop( 42 )
+end
+
+HTV3 = Hitimes::TimedValueMetric.new( 'duration_tv3' )
+def hitimes_duration_tv3
+  HTV3.measure( 42 ) { nil }
 end
 
 #
@@ -76,11 +99,15 @@ end
 
 puts "Testing time sampling 100,000 times"
 
-bm(20) do |x|
-  x.report("Process")              { 100_000.times { process_duration } }
-  x.report("Time")                 { 100_000.times { time_duration    } }
-  x.report("Hitimes::Timer 1")     { 100_000.times { hitimes_duration_t1 } }
-  x.report("Hitimes::Timer 2")     { 100_000.times { hitimes_duration_t2 } }
-  x.report("Hitimes::Interval 1")  { 100_000.times { hitimes_duration_i1 } }
-  x.report("Hitimes::Interval 2")  { 100_000.times { hitimes_duration_i2 } }
+bm(30) do |x|
+  x.report("Process")                     { 100_000.times { process_duration } }
+  x.report("Time")                        { 100_000.times { time_duration    } }
+  x.report("Hitimes::TimedMetric 1")      { 100_000.times { hitimes_duration_t1 } }
+  x.report("Hitimes::TimedMetric 2")      { 100_000.times { hitimes_duration_t2 } }
+  x.report("Hitimes::TimedMetric 3")      { 100_000.times { hitimes_duration_t3 } }
+  x.report("Hitimes::Interval 1")         { 100_000.times { hitimes_duration_i1 } }
+  x.report("Hitimes::Interval 2")         { 100_000.times { hitimes_duration_i2 } }
+  x.report("Hitimes::TimedValueMetric 1") { 100_000.times { hitimes_duration_tv1 } }
+  x.report("Hitimes::TimedValueMetric 2") { 100_000.times { hitimes_duration_tv2 } }
+  x.report("Hitimes::TimedValueMetric 3") { 100_000.times { hitimes_duration_tv3 } }
 end

data/examples/stats.rb

@@ -23,7 +23,9 @@ Dir.entries( dir ).each do |entry|
   end
 end
 
-%w[ count min max mean sum stddev ].each do |m|
+Hitimes::Stats::STATS.each do |m|
   puts "#{m.rjust(6)} : #{s.send( m ) }"
 end
 
+puts s.to_hash.inspect
+

data/ext/hitimes_interval.c

@@ -164,6 +164,34 @@ VALUE hitimes_interval_stop( VALUE self )
     return rc;
 }
 
+/**
+ * call-seq:
+ *     interval.duration_so_far -> Float or false
+ *
+ * return how the duration so far.  This will return the duration from the time
+ * the Interval was started if the interval is running, otherwise it will return
+ * false.
+ */
+VALUE hitimes_interval_duration_so_far( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE               rc = Qfalse;
+    double              d;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( 0L == i->start_instant ) {
+        return rc;
+    }
+
+    if ( 0L == i->stop_instant ) {
+        hitimes_instant_t now = hitimes_get_current_instant( );
+        d = ( now - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+        rc = rb_float_new( d );
+    }
+    return rc;
+}
+
+
 /**
  * call-seq:
  *    interval.started? -> boolean
@@ -328,6 +356,8 @@ void Init_hitimes_interval()
     rb_define_method( cH_Interval, "length",       hitimes_interval_duration, 0 ); 
     rb_define_method( cH_Interval, "to_f",         hitimes_interval_duration, 0 );
     rb_define_method( cH_Interval, "to_seconds",   hitimes_interval_duration, 0 );
+
+    rb_define_method( cH_Interval, "duration_so_far", hitimes_interval_duration_so_far, 0); /* in hitimes_interval.c */
      
     rb_define_method( cH_Interval, "started?",     hitimes_interval_started, 0 ); /* in hitimes_interval.c */
     rb_define_method( cH_Interval, "running?",     hitimes_interval_running, 0 ); /* in hitimes_interval.c */

data/lib/hitimes/metric.rb

@@ -16,13 +16,8 @@ module Hitimes
   #
   class Metric
 
-    # the time at which the first sample was taken
-    # This is the number of microseconds since UNIX epoch UTC as a Float
-    attr_accessor :sampling_start_time
-
-    # the time at which the last sample was taken.
-    # This is the number of microseconds since UNIX epoch UTC as a Float
-    attr_accessor :sampling_stop_time
+    # the number of seconds as a float since the sampling_start_time
+    attr_reader :sampling_delta
 
     # An additional hash of data to associate with the metric
     attr_reader :additional_data
@@ -41,12 +36,55 @@ module Hitimes
     # +name+ may be anything that follows the +to_s+ protocol.
     #
     def initialize( name, additional_data = {} )
-      @sampling_start_time = nil
-      @sampling_stop_time  = nil
+      @sampling_start_time     = nil
+      @sampling_start_interval = nil
+      @sampling_delta          = 0
+
       @name                = name.to_s
       @additional_data     = additional_data.to_hash
     end
 
+    #
+    # :call-seq: 
+    #   metric.sampling_start_time -> Float or nil
+    #
+    # The time at which the first sample was taken.
+    # This is the number of microseconds since UNIX epoch UTC as a Float
+    #
+    # If the metric has not started measuring then the start time is nil.
+    #
+    def sampling_start_time
+      if @sampling_start_interval then
+        @sampling_start_time ||= self.utc_microseconds()
+      else
+        nil
+      end
+    end
+
+    #
+    # :call-seq:
+    #   metric.sampling_stop_time -> Float or nil
+    #
+    # The time at which the last sample was taken
+    # This is the number of microseconds since UNIX epoch UTC as a Float
+    # 
+    # If the metric has not completely measured at least one thing then 
+    # stop time is nil.
+    #
+    # Because accessing the actual 'time of day' is an expesive operation, we
+    # only get the time of day at the beginning of the first measurement and we
+    # keep track of the offset from that point in @sampling_delta.
+    #
+    # When sampling_stop_time is called, the actual time of day is caculated.
+    #
+    def sampling_stop_time
+      if @sampling_delta > 0 then
+        (self.sampling_start_time + (@sampling_delta * 1_000_000))
+      else 
+        nil
+      end
+    end
+
     #
     # :call-seq:
     #    metric.to_hash -> Hash
@@ -55,10 +93,10 @@ module Hitimes
     # Convert the metric to a Hash.  
     #
     def to_hash
-      { 'sampling_start_time' => @sampling_start_time,
-        'sampling_stop_time'  => @sampling_stop_time,
-        'additional_data'     => @additional_data,
-        'name'                => @name }
+      { 'sampling_start_time' => self.sampling_start_time,
+        'sampling_stop_time'  => self.sampling_stop_time,
+        'additional_data'     => self.additional_data,
+        'name'                => self.name }
     end
 
     #

data/lib/hitimes/stats.rb

@@ -1,4 +1,4 @@
-require 'hitimes_ext'
+require 'hitimes'
 require 'stringio'
 module Hitimes
   class Stats

data/lib/hitimes/timed_metric.rb

@@ -60,17 +60,7 @@ module Hitimes
     def initialize( name, additional_data = {} )
       super( name, additional_data )
       @stats            = Stats.new
-      @current_interval = nil
-    end
-
-    #
-    # :call-seq:
-    #   timed_metric.current_interval -> Interval
-    #
-    # Return the current interval, if one doesn't exist create one.
-    #
-    def current_interval
-      @current_interval ||= Interval.new
+      @current_interval = Interval.new
     end
 
     #
@@ -80,7 +70,7 @@ module Hitimes
     # return whether or not the timer is currently running.  
     #
     def running?
-      current_interval.running?
+      @current_interval.running?
     end
 
     # 
@@ -91,8 +81,11 @@ module Hitimes
     # this is a noop.  
     #
     def start
-      current_interval.start unless running?
-      @sampling_start_time ||= self.utc_microseconds() 
+      if not @current_interval.running? then
+        @current_interval.start 
+        @sampling_start_time ||= self.utc_microseconds() 
+        @sampling_start_interval ||= Interval.now
+      end
       nil
     end
 
@@ -106,11 +99,14 @@ module Hitimes
     # no stats are updated.
     # 
     def stop
-      if running? then
-        d = current_interval.stop
-        @current_interval = nil
-        @sampling_stop_time = self.utc_microseconds()
+      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
@@ -148,9 +144,9 @@ module Hitimes
     # happens and false is returned.
     #
     def split  
-      if running? then 
-        next_interval = current_interval.split
-        d = current_interval.duration
+      if @current_interval.running? then 
+        next_interval = @current_interval.split
+        d = @current_interval.duration
         @stats.update( d )
         @current_interval = next_interval 
         return d

data/lib/hitimes/timed_value_metric.rb

@@ -59,22 +59,11 @@ module Hitimes
     #
     def initialize( name, additional_data = {} )
       super( name, additional_data )
-      @current_interval = nil
       @timed_stats      = Stats.new
       @value_stats      = Stats.new
+      @current_interval = Interval.new
     end
 
-    #
-    # :call-seq:
-    #   timed_value_metric.current_interval -> Interval
-    #
-    # Return the current interval, if one doesn't exist create one.
-    #
-    def current_interval
-      @current_interval ||= Interval.new
-    end
-
-
     #
     # :call-seq:
     #   timed_value_metric.running? -> true or false
@@ -82,7 +71,7 @@ module Hitimes
     # return whether or not the metric is currently timing something.
     #
     def running?
-      current_interval.running?
+      @current_interval.running?
     end
 
     # 
@@ -93,8 +82,11 @@ module Hitimes
     # this is a noop.  
     #
     def start
-      current_interval.start unless running?
-      @sampling_start_time ||= self.utc_microseconds() 
+      if not @current_interval.running? then
+        @current_interval.start
+        @sampling_start_time ||= self.utc_microseconds() 
+        @sampling_start_interval ||= Interval.now
+      end
       nil
     end
 
@@ -114,12 +106,15 @@ module Hitimes
     # 
     #
     def stop( value )
-      if running? then
-        d = current_interval.stop
-        @current_interval = nil
-        @sampling_stop_time = self.utc_microseconds()
+      if @current_interval.running? then
+        d = @current_interval.stop
         @timed_stats.update( d )
+        @current_interval = Interval.new
         @value_stats.update( value )
+
+        # update the lenght of time we have been sampling
+        @sampling_delta = @sampling_start_interval.duration_so_far
+
         return d
       end
       return false
@@ -159,9 +154,9 @@ module Hitimes
     #
     #
     def split( value )
-      if running? then 
-        next_interval = current_interval.split
-        d = current_interval.duration
+      if @current_interval.running? then 
+        next_interval = @current_interval.split
+        d = @current_interval.duration
         @timed_stats.update( d )
         @value_stats.update( value )
         @current_interval = next_interval 

data/lib/hitimes/value_metric.rb

@@ -42,10 +42,13 @@ module Hitimes
     # Give the +value+ as the measurement to the metric.  The value is returned
     #
     def measure( value )
-      now = self.utc_microseconds()
-      @sampling_start_time ||= now
-      @sampling_stop_time = now
+      @sampling_start_time ||= self.utc_microseconds()
+      @sampling_start_interval ||= Interval.now
+
       @stats.update( value )
+      
+      # update the length of time we have been sampling
+      @sampling_delta = @sampling_start_interval.duration_so_far
     end
 
     #

data/lib/hitimes/version.rb

@@ -16,7 +16,7 @@ module Hitimes
     MINOR   = 0
 
     # Build number
-    BUILD   = 0
+    BUILD   = 1
 
     #
     # :call-seq:

data/lib/hitimes.rb

@@ -18,8 +18,8 @@ module Hitimes
 end
 require 'hitimes/paths'
 require 'hitimes/version'
-require 'hitimes/stats'
 require 'hitimes_ext'
+require 'hitimes/stats'
 require 'hitimes/mutexed_stats'
 require 'hitimes/metric'
 require 'hitimes/value_metric'

data/spec/interval_spec.rb

@@ -94,6 +94,18 @@ describe Hitimes::Interval do
     x.object_id.should == y.object_id
   end
 
+  it "can return how much time has elapsed from the start without stopping the interval" do
+    i = Hitimes::Interval.new
+    i.start
+    x = i.duration_so_far
+    i.should be_running
+    y = i.duration_so_far
+    i.stop
+    x.should < y
+    x.should < i.duration
+    y.should < i.duration
+  end
+
   describe "#split" do
 
     it "creates a new Interval object" do

data/spec/timed_metric_spec.rb

@@ -95,9 +95,9 @@ describe Hitimes::TimedMetric do
   end
 
   it "keeps track of the last stop time of all the intervals" do
-    f1 = Time.now.gmtime.to_f * 1000000
+    f1 = Time.now.gmtime.to_f * 1_000_000
     5.times { @tm.start ; sleep 0.05 ; @tm.stop }
-    f2 = Time.now.gmtime.to_f * 1000000
+    f2 = Time.now.gmtime.to_f * 1_000_000
     @tm.sampling_stop_time.should > f1
     @tm.sampling_stop_time.should < f2
     # distance from now to max stop time time should be less than the distance
@@ -131,7 +131,7 @@ describe Hitimes::TimedMetric do
       h['name'].should == "test-timed-metric"
     end
 
-    it "has an empty has for additional_data" do
+    it "has an empty hash for additional_data" do
       h = @tm.to_hash
       h['additional_data'].should == Hash.new
       h['additional_data'].size.should == 0

data/tasks/config.rb

@@ -83,7 +83,7 @@ Configuration.for('rdoc') {
   files       Configuration.for('packaging').files.rdoc
   main_page   files.first
   title       Configuration.for('project').name
-  options     %w[ --line-numbers --inline-source ]
+  options     %w[ --line-numbers ]
   output_dir  "doc"
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hitimes
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jeremy Hinegardner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-12 00:00:00 -06:00
+date: 2009-06-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -118,7 +118,6 @@ homepage: http://copiousfreetime.rubyforge.org/hitimes/
 post_install_message: 
 rdoc_options: 
 - --line-numbers
-- --inline-source
 - --main
 - README
 require_paths: