yam-ruby-metrics 0.8.6

data/spec/instruments/counter_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Metrics::Instruments::Counter do
+  before(:each) do
+    @counter = Metrics::Instruments::Counter.new
+  end
+  
+  it "should create a new entity with zero as its value" do
+    @counter.to_i.should == 0
+  end
+  
+  it "should increment its counter by the value specified" do
+    value = 1
+    lambda do
+      @counter.inc(value)
+    end.should change{ @counter.to_i }.by(value)
+  end
+  
+  it "should increment its counter by one by default" do
+    lambda do
+      @counter.inc
+    end.should change{ @counter.to_i }.by(1)
+  end
+  
+  it "should decrement its counter by the value specified" do
+    value = 1
+    lambda do
+      @counter.dec(value)
+    end.should change{ @counter.to_i }.by(-value)
+  end
+  
+  it "should decrement its counter by one by default" do
+    lambda do
+      @counter.dec
+    end.should change{ @counter.to_i }.by(-1)
+  end
+  
+  it "should alias #incr to #inc" do
+    lambda do
+      @counter.incr
+    end.should change{ @counter.to_i }.by(1)
+  end
+  
+  it "should alias #decr to #dec" do
+    lambda do
+      @counter.decr
+    end.should change{ @counter.to_i }.by(-1)
+  end
+  
+  it "should clear the counter correctly" do 
+    @counter.clear
+    @counter.to_i.should == 0
+  end
+  
+  it "should correctly represent the value as a string" do 
+    @counter.clear
+    @counter.to_i.should == 0
+    @counter.to_s.should == "0"
+  end
+  
+  it "should return the new count when incrementing" do
+    count = @counter.to_i
+    @counter.inc(value = 1).should == count + value
+  end
+  
+  it "should return the new count when decrementing" do
+    lambda do
+      @counter.dec(1)
+    end.should change{ @counter.to_i }.by(-1)
+  end
+  
+  context "to_json" do
+    let(:json) { @counter.to_json }
+    it "should serialize to its current value" do
+      json.should == @counter.to_s
+    end
+  end
+  
+end

data/spec/instruments/gauge_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Metrics::Instruments::Gauge do
+  before(:each) do
+  end
+
+  it "should create a new gauge" do
+    callback = Proc.new {}
+    @gauge = Metrics::Instruments::Gauge.new &callback
+  end
+  
+  it "should correctly callback the block given when we call Gauge#get" do
+    result = 42
+    
+    callback = Proc.new do 
+      {
+        :result => result
+      }
+    end
+    
+    @gauge = Metrics::Instruments::Gauge.new &callback
+    
+    @gauge.get[:result].should == 42
+    
+    result += 1
+    
+    @gauge.get[:result].should == 43
+  end
+  
+  context "to_json" do
+    it "should serialize the current value" do
+      result = 0
+      gauge = Metrics::Instruments::Gauge.new{ result }
+      
+      gauge.to_json.should == result.to_s
+      
+      result = 2
+      gauge.to_json.should == result.to_s
+    end
+  end
+  
+end

data/spec/instruments/histogram_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+# This is compared to results from R using the built-in old-faithful dataset
+
+describe Metrics::Instruments::Histogram do
+
+  context "using a uniform sample" do
+    before(:each) do
+      @histogram = Metrics::Instruments::Histogram.new
+      data = %w(3.600 1.800 3.333 2.283 4.533 2.883 4.700 3.600 1.950 4.350 1.833 3.917 4.200 1.750 4.700 2.167 1.750 4.800 1.600 4.250 1.800 1.750 3.450 3.067 4.533 3.600 1.967 4.083 3.850 4.433 4.300 4.467 3.367 4.033 3.833 2.017 1.867 4.833 1.833 4.783 4.350 1.883 4.567 1.750 4.533 3.317 3.833 2.100 4.633 2.000 4.800 4.716 1.833 4.833 1.733 4.883 3.717 1.667 4.567 4.317 2.233 4.500 1.750 4.800 1.817 4.400 4.167 4.700 2.067 4.700 4.033 1.967 4.500 4.000 1.983 5.067 2.017 4.567 3.883 3.600 4.133 4.333 4.100 2.633 4.067 4.933 3.950 4.517 2.167 4.000 2.200 4.333 1.867 4.817 1.833 4.300 4.667 3.750 1.867 4.900 2.483 4.367 2.100 4.500 4.050 1.867 4.700 1.783 4.850 3.683 4.733 2.300 4.900 4.417 1.700 4.633 2.317 4.600 1.817 4.417 2.617 4.067 4.250 1.967 4.600 3.767 1.917 4.500 2.267 4.650 1.867 4.167 2.800 4.333 1.833 4.383 1.883 4.933 2.033 3.733 4.233 2.233 4.533 4.817 4.333 1.983 4.633 2.017 5.100 1.800 5.033 4.000 2.400 4.600 3.567 4.000 4.500 4.083 1.800 3.967 2.200 4.150 2.000 3.833 3.500 4.583 2.367 5.000 1.933 4.617 1.917 2.083 4.583 3.333 4.167 4.333 4.500 2.417 4.000 4.167 1.883 4.583 4.250 3.767 2.033 4.433 4.083 1.833 4.417 2.183 4.800 1.833 4.800 4.100 3.966 4.233 3.500 4.366 2.250 4.667 2.100 4.350 4.133 1.867 4.600 1.783 4.367 3.850 1.933 4.500 2.383 4.700 1.867 3.833 3.417 4.233 2.400 4.800 2.000 4.150 1.867 4.267 1.750 4.483 4.000 4.117 4.083 4.267 3.917 4.550 4.083 2.417 4.183 2.217 4.450 1.883 1.850 4.283 3.950 2.333 4.150 2.350 4.933 2.900 4.583 3.833 2.083 4.367 2.133 4.350 2.200 4.450 3.567 4.500 4.150 3.817 3.917 4.450 2.000 4.283 4.767 4.533 1.850 4.250 1.983 2.250 4.750 4.117 2.150 4.417 1.817 4.467)
+      data.each do |point|
+        @histogram.update(point.to_f)
+      end
+      @histogram.count.should == 272
+    end
+  
+    it "should update variance correctly" do
+      @histogram.variance.should == 1.3027283328494685
+    end
+  
+    it "should calculate standard deviations properly" do
+      @histogram.std_dev.should == 1.1413712511052083
+    end
+  
+    it "should accurately calculate quantiles" do
+      quantiles = @histogram.quantiles([0.99, 0.98, 0.95, 0.80, 0.57, 0.32])
+      quantiles.should == 
+        {
+          0.99 => 5.009570000000001, 
+          0.98 => 4.93300,
+          0.95 => 4.81700, 
+          0.80 => 4.53300, 
+          0.57 => 4.13300, 
+          0.32 => 2.39524
+        }
+    end
+
+    it "should accurately calculate the mean" do 
+      @histogram.mean.should == 3.4877830882352936
+    end
+  
+    it "should return correct values for mean, std. deviation and variance when no elements are in the histogram" do
+      histogram = Metrics::Instruments::Histogram.new
+      histogram.variance.should == 0.0
+      histogram.mean.should == 0.0
+      histogram.std_dev.should == 0.0
+    end
+  
+    it "should return the first value as the quantile if only one value" do
+      histogram = Metrics::Instruments::Histogram.new
+      histogram.update(42)
+      histogram.quantiles([0.50]).should == {0.50 => 42}
+    end  
+
+    it "should return the last value as the 100%" do
+      histogram = Metrics::Instruments::Histogram.new
+      histogram.update(42)
+      histogram.update(64)
+      histogram.quantiles([1.00]).should == {1.00 => 64}
+    end  
+
+
+    it "should return correct values for min and max" do
+      histogram = Metrics::Instruments::Histogram.new
+      histogram.update(42)
+      histogram.min.should == 42
+      histogram.max.should == 42
+    end
+
+    context "resetting the histogram" do
+
+      it "should clear data correctly" do
+        sample = Metrics::Statistics::UniformSample.new    
+        sample.should_receive(:clear)
+        Metrics::Statistics::UniformSample.should_receive(:new).and_return sample
+
+        histogram = Metrics::Instruments::Histogram.new
+        histogram.clear
+        histogram.max.should == 0.0
+        histogram.min.should == 0.0
+      end
+      
+    end
+  end
+  
+  context "using an exponentially weighted sample" do
+    it "should return correct values for mean, std. deviation and variance when no elements are in the histogram" do
+      histogram = Metrics::Instruments::Histogram.new(:exponential)
+      histogram.variance.should == 0.0
+      histogram.mean.should == 0.0
+      histogram.std_dev.should == 0.0
+    end
+  end
+  
+  context "to_json" do
+    before(:each) do
+      @histogram  = Metrics::Instruments::Histogram.new
+      @hash       = JSON.parse(@histogram.to_json)
+    end
+    
+    %w( min max mean variance ).each do |attr|
+      it "should serialize with the #{attr} value" do
+        @hash[attr].should_not be_nil
+      end
+    end
+    
+    %w( 0.25 0.5 0.75 0.95 0.97 0.98 0.99 ).each do |percentile|
+      it "should have the #{percentile} percentile" do
+        @hash["percentiles"][percentile].should_not be_nil
+      end
+    end
+    
+  end
+  
+end

data/spec/instruments/meter_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Metrics::Instruments::Meter do
+  before(:each) do
+    Thread.stub!(:new).and_return do |block|
+      # Do nothing
+    end
+  end
+
+  it "should initialize averages to 0" do 
+    meter = Metrics::Instruments::Meter.new
+    meter.one_minute_rate.should == 0.0
+    meter.five_minute_rate.should == 0.0
+    meter.fifteen_minute_rate.should == 0.0
+  end
+  
+  it "should increment count" do
+    meter = Metrics::Instruments::Meter.new
+    meter.mark(500)
+    meter.counted.should == 500
+  end
+  
+  it "should accept options for the constructor" do
+    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
+      @meter.mark(3)
+      @meter.tick()
+    end
+
+    def tick_for(seconds)
+      count = ((seconds) / 5).to_i
+      (1..count).each do
+        @meter.tick()
+      end
+    end
+    
+    context "For a 1 minute window" do
+      it "should have a rate of 0.6 events/sec after the first tick" do
+        @meter.one_minute_rate.should == 0.6
+      end
+    
+      it "should have a rate of 0.22072766470286553 events/sec after 1 minute" do
+        tick_for(60)
+        @meter.one_minute_rate.should == 0.22072766470286553
+      end
+    end
+    
+    context "For a 5 minute window" do
+      it "should have a rate of 0.6 events/sec after the first tick" do
+        @meter.five_minute_rate.should == 0.6
+      end
+    
+      it "should have a rate of 0.49123845184678905 events/sec after 1 minute" do
+        tick_for(60)
+        @meter.five_minute_rate.should == 0.49123845184678905
+      end
+    end
+    
+    context "For a 15 minute window" 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(60)
+        @meter.fifteen_minute_rate.should == 0.5613041910189706
+      end      
+    end
+  
+  end
+  
+  context "to_json" do
+    before(:each) do
+      @meter  = Metrics::Instruments::Meter.new
+      @hash   = JSON.parse(@meter.to_json)
+    end
+    
+    %w( one_minute_rate five_minute_rate fifteen_minute_rate ).each do |attr|
+      it "should serialize with the #{attr} value" do
+        @hash[attr].should_not be_nil
+      end
+    end
+    
+  end
+  
+end

data/spec/instruments/timer_spec.rb

@@ -0,0 +1,146 @@
+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({:duration_unit => :milliseconds, :rate_unit => :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({:duration_unit => :nanoseconds, :rate_unit => :nanoseconds})
+    end
+    
+    it "should return the result of the block passed" do       
+      result = @timer.time do 
+        sleep(0.25)
+        "narf"
+      end
+
+      result.should == "narf"
+      
+      @timer.max.should >= 250000000
+      @timer.max.should <= 300000000
+
+    end
+  end
+  
+  context "to_json" do
+    before(:each) do
+      @timer  = Metrics::Instruments::Timer.new
+      @hash   = JSON.parse(@timer.to_json)
+    end
+    
+    it "should serialize with the count value" do
+      @hash["count"].should_not be_nil
+    end
+    
+    %w( one_minute_rate five_minute_rate fifteen_minute_rate ).each do |rate|
+      it "should serialize with the #{rate} rate" do
+        @hash["rates"][rate].should_not be_nil
+      end
+    end
+    
+    %w( min max mean ).each do |duration|
+      it "should serialize with the #{duration} duration" do
+        @hash["durations"][duration].should_not be_nil
+      end
+    end
+    
+    %w( 0.25 0.5 0.75 0.95 0.97 0.98 0.99 ).each do |percentile|
+      it "should serialize with the #{percentile} duration percentile" do
+        @hash["durations"]["percentiles"][percentile].should_not be_nil
+      end
+    end
+    
+  end
+  
+end