ruby-metrics 0.6.0 → 0.7.0

data/Gemfile.lock

@@ -1,15 +1,16 @@
 PATH
   remote: .
   specs:
-    ruby-metrics (0.6.0)
+    ruby-metrics (0.7.0)
       json
-      ruby-units
+      quantity
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
     json (1.5.1)
+    quantity (0.1.1)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)
@@ -18,7 +19,6 @@ GEM
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)
-    ruby-units (1.2.0)
     simplecov (0.4.0)
       simplecov-html (~> 0.4.0)
     simplecov-html (0.4.3)

data/lib/ruby-metrics/instruments/histogram.rb

@@ -145,6 +145,10 @@ module Metrics
         end
       end
       
+      def values
+        @sample.values
+      end
+      
       def to_s
         {
           :min => self.min, 
@@ -154,7 +158,7 @@ module Metrics
           :percentiles => self.quantiles([0.25, 0.50, 0.75, 0.95, 0.97, 0.98, 0.99])
         }.to_json
       end
-      
+    
     end
   
     class ExponentialHistogram < Histogram

data/lib/ruby-metrics/instruments/meter.rb

@@ -1,5 +1,3 @@
-require 'ruby-units'
-
 module Metrics
   module Instruments
     class Meter < Base
@@ -10,31 +8,17 @@ module Metrics
       FIVE_MINUTE_FACTOR    = 1 - Math.exp(-INTERVAL / (60.0 * 5.0))
       FIFTEEN_MINUTE_FACTOR = 1 - Math.exp(-INTERVAL / (60.0 * 15.0))
       
-      attr_reader :counted, :uncounted
+      attr_reader :count
+      alias_method :counted, :count
       
       def initialize(options = {})
         @one_minute_rate = @five_minute_rate = @fifteen_minute_rate = 0.0
-        @counted = @uncounted = 0
+        @count  = 0
         @initialized = false
-        
-        if options[:interval]
-          interval = options[:interval]
-        else
-          interval = "5 seconds"
-        end
-        
-        if options[:rateunit]
-          @rateunit = options[:rateunit]
-        else
-          @rateunit = interval
-        end
-        
-        # HACK: this is here because ruby-units thinks 1s in ns is 999,999,999.9999999 not 1bn 
-        # TODO: either fix ruby-units, or remove it?
-        @ratemultiplier = @rateunit.to("nanoseconds").scalar.ceil
-        
+        @start_time = Time.now.to_f
+                        
         @timer_thread = Thread.new do
-          sleep_time = interval.to("seconds").scalar
+          sleep_time = INTERVAL
           begin
             loop do
               self.tick
@@ -51,8 +35,7 @@ module Metrics
       end
       
       def mark(count = 1)
-        @uncounted += count
-        @counted += count
+        @count += count
       end
       
       def calc_rate(rate, factor, count)
@@ -61,7 +44,7 @@ module Metrics
       end
       
       def tick
-        count = @uncounted.to_f  / INTERVAL_IN_NS.to_f
+        count = @count.to_f  / Seconds.to_nsec(INTERVAL).to_f
 
         if (@initialized)
           @one_minute_rate      = calc_rate(@one_minute_rate,     ONE_MINUTE_FACTOR,     count)
@@ -72,19 +55,29 @@ module Metrics
           @initialized = true
         end
         
-        @uncounted = 0
+        @count = 0
       end
       
-      def one_minute_rate
-        @one_minute_rate * @ratemultiplier
+      def one_minute_rate(rate_unit = :seconds)
+        scale_to_ns @one_minute_rate, rate_unit
       end
       
-      def five_minute_rate
-        @five_minute_rate * @ratemultiplier
+      def five_minute_rate(rate_unit = :seconds)
+        scale_to_ns @five_minute_rate, rate_unit
       end
       
-      def fifteen_minute_rate
-        @fifteen_minute_rate * @ratemultiplier
+      def fifteen_minute_rate(rate_unit = :seconds)
+        scale_to_ns @fifteen_minute_rate, rate_unit
+      end
+      
+      def mean_rate(rate_unit = seconds)
+        count = @count
+        if count == 0
+          return 0.0;
+        else
+          elapsed = Time.now.to_f - @start_time.to_f
+          scale_to_ns (count / elapsed), rate_unit
+        end
       end
       
       def to_s
@@ -94,6 +87,24 @@ module Metrics
           :fifteen_minute_rate => self.fifteen_minute_rate
         }.to_json
       end
+      
+      private
+      def scale_to_ns(value, unit)
+        mult = case unit
+        when :seconds
+          Seconds.to_nsec
+        when :minutes
+          Minutes.to_nsec
+        when :hours
+          Hours.to_nsec
+        when :days
+          Days.to_nsec
+        when :weeks
+          Weeks.to_nsec
+        end
+
+        value * mult
+      end
     end
   end
 end

data/lib/ruby-metrics/instruments/timer.rb

@@ -0,0 +1,108 @@
+require File.join(File.dirname(__FILE__), '..', 'time_units')
+
+module Metrics
+  module Instruments
+    class Timer < Base
+      include Metrics::TimeConversion 
+      
+      attr_reader :duration_unit, :rate_unit
+      
+      def initialize(duration_unit = :seconds, rate_unit = :seconds)
+        @meter          = Meter.new
+        @histogram      = ExponentialHistogram.new
+
+        @duration_unit  = duration_unit
+        @rate_unit      = rate_unit
+        
+        clear
+      end
+      
+      def clear
+        @histogram.clear
+      end
+
+      def update(duration, unit)
+        mult = convert_to_ns(1, unit)
+        self.update_timer (duration * mult)
+      end
+
+      def time(&block) 
+        start_time = Time.now.to_f
+        result = block.call
+        time_diff = Time.now.to_f - start_time
+        update_timer(time_diff)
+        result
+      end
+      
+      def count
+        @histogram.count
+      end
+
+      def fifteen_minute_rate
+        @meter.fifteen_minute_rate(@rate_unit)
+      end
+
+      def five_minute_rate
+        @meter.five_minute_rate(@rate_unit)
+      end
+
+      def one_minute_rate
+        @meter.one_minute_rate(@rate_unit)
+      end
+      
+      def mean_rate
+        @meter.mean_rate(@rate_unit)
+      end
+
+      def max
+        scale_duration_to_ns @histogram.max, @duration_unit
+      end
+      
+      def min
+        scale_duration_to_ns @histogram.min, @duration_unit
+      end
+      
+      def mean
+        scale_duration_to_ns @histogram.mean, @duration_unit
+      end
+      
+      def std_dev
+        scale_duration_to_ns @histogram.std_dev, @duration_unit
+      end
+      
+      def quantiles(percentiles = [0.99,0.97,0.95,0.75,0.5,0.25])
+        result = {}
+        
+        @histogram.quantiles(percentiles).each do |k,v|
+          result[k] = scale_duration_to_ns v, @duration_unit
+        end
+        
+        result
+      end
+
+      def values
+        result = []
+
+        @histogram.values.each do |value|
+          result << (scale_duration_to_ns value, @duration_unit)
+        end
+        
+        result
+      end
+      
+      def update_timer(duration)
+        if duration >= 0
+          @histogram.update(duration)
+          @meter.mark
+        end
+      end
+      
+      private
+      def scale_duration_to_ns(value, unit)
+        value / convert_to_ns(1, unit)
+      end
+      
+    end
+  end
+end  
+      

data/lib/ruby-metrics/instruments.rb

@@ -1,3 +1,5 @@
+require File.join(File.dirname(__FILE__), 'time_units')
+
 require File.join(File.dirname(__FILE__), 'statistics', 'sample')
 require File.join(File.dirname(__FILE__), 'statistics', 'uniform_sample')
 require File.join(File.dirname(__FILE__), 'statistics', 'exponential_sample')
@@ -7,6 +9,7 @@ require File.join(File.dirname(__FILE__), 'instruments', 'counter')
 require File.join(File.dirname(__FILE__), 'instruments', 'meter')
 require File.join(File.dirname(__FILE__), 'instruments', 'gauge')
 require File.join(File.dirname(__FILE__), 'instruments', 'histogram')
+require File.join(File.dirname(__FILE__), 'instruments', 'timer')
 
 
 require 'json'

data/lib/ruby-metrics/statistics/exponential_sample.rb

@@ -7,7 +7,7 @@ module Metrics
         @count  = 0
         @size   = size
         @alpha  = alpha
-        @rescale_window = "1 hour".to("seconds").scalar
+        @rescale_window = 1.hour.to_seconds.to_i
         self.clear
       end
       

data/lib/ruby-metrics/time_units.rb

@@ -0,0 +1,61 @@
+module Metrics
+  
+  class TimeUnit 
+    def self.to_nsec(mult = 1)
+      raise NotImplementedError
+    end
+  end
+  
+  class Nanoseconds < TimeUnit
+    def self.to_nsec(mult = 1)
+      mult
+    end
+  end
+  
+  class Microseconds < TimeUnit
+    def self.to_nsec(mult = 1)
+      1000 * mult
+    end
+  end
+  
+  class Milliseconds < TimeUnit
+    def self.to_nsec(mult = 1)
+      1000000 * mult
+    end
+  end
+  
+  class Seconds < TimeUnit
+    def self.to_nsec(mult = 1)
+      1000000000 * mult
+    end
+  end
+  
+  class Minutes < TimeUnit
+    def self.to_nsec(mult = 1)
+      60000000000 * mult
+    end
+  end
+  
+  class Hours < TimeUnit
+    def self.to_nsec(mult = 1)
+      3600000000000 * mult
+    end
+  end
+  
+  module TimeConversion
+   
+  
+    def convert_to_ns(value, unit)
+      units = {
+          :nanoseconds            => Nanoseconds,
+          :microseconds           => Microseconds,
+          :milliseconds           => Milliseconds,
+          :seconds                => Seconds,
+          :minutes                => Minutes,
+          :hours                  => Hours
+      }
+      
+      return units[unit].to_nsec * value
+    end
+  end
+end

data/lib/ruby-metrics/version.rb

@@ -1,3 +1,3 @@
 module Metrics
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/ruby-metrics.rb

@@ -1,5 +1,6 @@
 # == Metrics Initialization
 #
+require 'quantity/all'
 
 module Metrics
   
@@ -12,4 +13,10 @@ module Metrics
   
 end
 
+Quantity::Unit.add_unit :minute,  :time, 60000,     :minutes
+Quantity::Unit.add_unit :hour,    :time, 3600000,   :hours
+Quantity::Unit.add_unit :day,     :time, 86400000,  :days
+Quantity::Unit.add_unit :week,    :time, 604800000, :weeks
+
+
 require File.join(File.dirname(__FILE__), 'ruby-metrics', 'agent')

data/ruby-metrics.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "ruby-metrics"
 
   s.add_dependency "json"
-  s.add_dependency "ruby-units"
+  s.add_dependency "quantity"
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "simplecov", [">= 0.3.8"] #, :require => false

data/spec/instruments/meter_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'ruby-units'
 
 describe Metrics::Instruments::Meter do
   before(:each) do
@@ -19,23 +18,22 @@ describe Metrics::Instruments::Meter do
     meter = Metrics::Instruments::Meter.new
     meter.mark(500)
     meter.counted.should == 500
-    meter.uncounted.should == 500
   end
   
   it "should accept options for the constructor" do
-    meter = Metrics::Instruments::Meter.new({:interval => "10 seconds", :rateunit => "5 seconds"})
+    meter = Metrics::Instruments::Meter.new
   end
   
   context "A timer with an initial mark of 3 at a 1 second rate unit on a 5 second interval" do
     
     before(:each) do 
-      @meter = Metrics::Instruments::Meter.new({:interval => "5 seconds", :rateunit => "1 second"})
+      @meter = Metrics::Instruments::Meter.new
       @meter.mark(3)
       @meter.tick()
     end
 
     def tick_for(time)
-      count = ((time.to("seconds")) / 5).scalar
+      count = ((time.to_seconds) / 5).to_i
       (1..count).each do
         @meter.tick()
       end
@@ -47,7 +45,7 @@ describe Metrics::Instruments::Meter do
       end
     
       it "should have a rate of 0.22072766470286553 events/sec after 1 minute" do
-        tick_for("1 minute")
+        tick_for(1.minute)
         @meter.one_minute_rate.should == 0.22072766470286553
       end
     end
@@ -58,7 +56,7 @@ describe Metrics::Instruments::Meter do
       end
     
       it "should have a rate of 0.49123845184678905 events/sec after 1 minute" do
-        tick_for("1 minute")
+        tick_for(1.minute)
         @meter.five_minute_rate.should == 0.49123845184678905
       end
     end
@@ -67,9 +65,17 @@ describe Metrics::Instruments::Meter do
       it "should have a rate of 0.6 events/sec after the first tick" do
         @meter.fifteen_minute_rate.should == 0.6
       end
+      
+      it "should have a rate of 36.0 events per minute after the first tick" do
+        @meter.fifteen_minute_rate(:minutes).should == 36.0
+      end
+      
+      it "should have a rate of 2160.0 events per hour after the first tick" do 
+        @meter.fifteen_minute_rate(:hours).should == 2160.0
+      end
 
       it "should have a rate of 0.5613041910189706 events/sec after 1 minute" do
-        tick_for("1 minute")
+        tick_for(1.minute)
         @meter.fifteen_minute_rate.should == 0.5613041910189706
       end      
     end

data/spec/instruments/timer_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Metrics::Instruments::Timer do
+  before(:each) do
+    Thread.stub!(:new).and_return do |block|
+      # Do nothing
+    end
+  end
+  
+  context "An empty timer" do
+    before(:each) do 
+      @timer = Metrics::Instruments::Timer.new()
+    end
+    
+    it "should have a max of zero" do
+      @timer.max.should == 0
+    end
+
+    it "should have a min of zero" do
+      @timer.min.should == 0
+    end
+
+    it "should have a mean of zero" do
+      @timer.mean.should == 0
+    end
+
+    it "should have a min of zero" do
+      @timer.std_dev.should == 0
+    end
+    
+    it "should have quantiles of zero" do
+      @timer.quantiles.should == {0.99=>0.0, 0.97=>0.0, 0.95=>0.0, 0.75=>0.0, 0.5=>0.0, 0.25=>0.0}
+    end
+    
+    it "should have a mean rate of zero" do
+      @timer.mean_rate.should == 0
+    end
+
+    it "should have a one-minute rate of zero" do
+      @timer.one_minute_rate.should == 0
+    end
+
+    it "should have a five-minute rate of zero" do
+      @timer.five_minute_rate.should == 0
+    end
+
+    it "should have a fifteen-minute rate of zero" do
+      @timer.fifteen_minute_rate.should == 0
+    end
+
+    it "should have no values stored" do
+      @timer.values.length.should == 0
+    end
+
+  end
+  
+  context "Timing some events" do
+    before(:each) do
+      @timer = Metrics::Instruments::Timer.new(:milliseconds, :seconds)
+      @timer.update(10, :milliseconds)
+      @timer.update(20, :milliseconds)
+      @timer.update(20, :milliseconds)
+      @timer.update(30, :milliseconds)
+      @timer.update(40, :milliseconds)
+    end
+
+    it "should have counted 5 events" do
+      @timer.count.should == 5
+    end
+    
+    it "should accurately calculate the minimum duration" do
+      @timer.min.should == 10
+    end
+
+    it "should accurately calculate the maximum duration" do
+      @timer.max.should == 40
+    end
+
+    it "should accurately calculate the mean duration" do
+      @timer.mean.should == 24
+    end
+
+    it "should accurately calculate the standard deviation of the durations" do
+      @timer.std_dev.should == 11.401754901476078
+    end
+    
+    it "should accurately calculate percentiles" do 
+      @timer.quantiles.should == {0.99=>39.6, 0.97=>38.8, 0.95=>38.0, 0.75=>30.0, 0.5=>20.0, 0.25=>20.0}
+    end
+    
+    it "should contain the series added" do
+      @timer.values.sort.should == [10, 20, 20, 30, 40]
+    end
+  end
+  
+  context "Timing blocks of code" do
+    before(:each) do
+      @timer = Metrics::Instruments::Timer.new(:nanoseconds, :nanoseconds)
+    end
+    
+    it "should return the result of the block passed" do       
+      result = @timer.time do 
+        sleep(5)
+        "narf"
+      end
+
+      result.should == "narf"
+      
+      @timer.max.should >= 5.0
+      @timer.max.should <= 6.0
+
+    end
+  end
+  
+end

data/spec/time_units_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Metrics::TimeUnit do
+  it "should raise NotImplementedError for #to_nsec" do
+    begin
+      Metrics::TimeUnit.to_nsec
+    rescue NotImplementedError
+      true
+    else
+      fail
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - John Ewart
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-15 00:00:00 -07:00
+date: 2011-04-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,7 +31,7 @@ dependencies:
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ruby-units
+  name: quantity
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -101,10 +101,12 @@ files:
 - lib/ruby-metrics/instruments/gauge.rb
 - lib/ruby-metrics/instruments/histogram.rb
 - lib/ruby-metrics/instruments/meter.rb
+- lib/ruby-metrics/instruments/timer.rb
 - lib/ruby-metrics/logging.rb
 - lib/ruby-metrics/statistics/exponential_sample.rb
 - lib/ruby-metrics/statistics/sample.rb
 - lib/ruby-metrics/statistics/uniform_sample.rb
+- lib/ruby-metrics/time_units.rb
 - lib/ruby-metrics/version.rb
 - ruby-metrics.gemspec
 - spec/agent_spec.rb
@@ -113,11 +115,13 @@ files:
 - spec/instruments/gauge_spec.rb
 - spec/instruments/histogram_spec.rb
 - spec/instruments/meter_spec.rb
+- spec/instruments/timer_spec.rb
 - spec/instruments_spec.rb
 - spec/spec_helper.rb
 - spec/statistics/exponential_sample_spec.rb
 - spec/statistics/sample_spec.rb
 - spec/statistics/uniform_sample_spec.rb
+- spec/time_units_spec.rb
 has_rdoc: true
 homepage: https://github.com/johnewart/ruby-metrics
 licenses: []
@@ -132,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 764509393290573048
+      hash: -24047821763014180
       segments: 
       - 0
       version: "0"
@@ -141,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 764509393290573048
+      hash: -24047821763014180
       segments: 
       - 0
       version: "0"
@@ -159,8 +163,10 @@ test_files:
 - spec/instruments/gauge_spec.rb
 - spec/instruments/histogram_spec.rb
 - spec/instruments/meter_spec.rb
+- spec/instruments/timer_spec.rb
 - spec/instruments_spec.rb
 - spec/spec_helper.rb
 - spec/statistics/exponential_sample_spec.rb
 - spec/statistics/sample_spec.rb
 - spec/statistics/uniform_sample_spec.rb
+- spec/time_units_spec.rb