ruby-metrics 0.5.0

data/spec/instruments/gauge_spec.rb

@@ -0,0 +1,44 @@
+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
+  
+  it "should JSONify the results when you call to_s" do
+    result = 42
+    
+    callback = Proc.new do 
+      {
+        :result => result
+      }
+    end
+    
+    @gauge = Metrics::Instruments::Gauge.new &callback
+    
+    @gauge.to_s.should == "{\"result\":42}"
+  end
+  
+end

data/spec/instruments/histogram_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+# This is compared to results from R using the built-in old-faithful dataset
+
+describe Metrics::Instruments::Histogram 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 accurately represent itself using JSON" do
+    @histogram.to_s.should == "{\"min\":1.6,\"max\":5.1,\"mean\":3.4877830882352936,\"variance\":1.3027283328494685,\"percentiles\":{\"0.25\":2.16275,\"0.5\":4.0,\"0.75\":4.45425,\"0.95\":4.817,\"0.97\":4.8977900000000005,\"0.98\":4.933,\"0.99\":5.009570000000001}}"
+  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

data/spec/instruments/meter_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'ruby-units'
+
+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
+    meter.uncounted.should == 500
+  end
+  
+  it "should accept options for the constructor" do
+    meter = Metrics::Instruments::Meter.new({:interval => "10 seconds", :rateunit => "5 seconds"})
+  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.mark(3)
+      @meter.tick()
+    end
+
+    def tick_for(time)
+      count = ((time.to("seconds")) / 5).scalar
+      (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("1 minute")
+        @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("1 minute")
+        @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 0.5613041910189706 events/sec after 1 minute" do
+        tick_for("1 minute")
+        @meter.fifteen_minute_rate.should == 0.5613041910189706
+      end      
+    end
+  
+  end
+    
+  
+end

data/spec/instruments_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Metrics::Instruments do
+  before(:each) do
+    @instruments = Metrics::Instruments
+    @instruments.unregister_all
+    
+    @counter = Metrics::Instruments::Counter.new
+    @meter = Metrics::Instruments::Meter.new
+  end
+  
+  it "should initially have no instruments in its hash" do
+    @instruments.registered.should == {}
+  end
+  
+  it "should allow for registering a Counter instrument" do
+    Metrics::Instruments::Counter.stub!(:new).and_return @counter
+    @instruments.register(:counter, :test_counter).should == @counter
+    @instruments.registered.should == {:test_counter => @counter}
+  end
+  
+  it "should allow for registering a Meter instrument" do
+    Metrics::Instruments::Meter.stub!(:new).and_return @meter
+    @instruments.register(:meter, :test_meter).should == @meter
+    @instruments.registered.should == {:test_meter => @meter}
+  end
+  
+  it "should generate JSON correctly" do 
+    Metrics::Instruments::Meter.stub!(:new).and_return @meter
+    @instruments.register(:meter, :test_meter).should == @meter
+    @instruments.registered.should == {:test_meter => @meter}
+    
+    @instruments.to_json.should == "{\"test_meter\":\"{\\\"one_minute_rate\\\":0.0,\\\"five_minute_rate\\\":0.0,\\\"fifteen_minute_rate\\\":0.0}\"}"
+  end
+  
+  it "should not allow for creating a gauge with no block" do 
+    lambda do
+      @instruments.register :gauge, :test_gauge
+    end.should raise_error(ArgumentError)
+  end
+  
+  it "should allow for creating a gauge with a block" do 
+    proc = Proc.new { "result" }
+    @instruments.register :gauge, :test_gauge, &proc
+  end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/spec/"
+  add_group "Instruments", "lib/metrics/instruments"
+  merge_timeout 3600
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ruby-metrics'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/statistics/sample_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Metrics::Statistics::Sample do
+  before(:each) do
+    @sample = Metrics::Statistics::Sample.new
+  end
+  
+  %w( clear values size ).each do |method|
+    it "should raise a NotImplementedError for ##{method}" do
+      lambda do
+        @sample.send(method)
+      end.should raise_exception(NotImplementedError)
+    end
+  end
+  
+  it "should raise a NotImplementedError for 'update'" do
+    lambda do
+      @sample.update(0)
+    end.should raise_exception(NotImplementedError)
+  end
+  
+end

data/spec/statistics/uniform_sample_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Metrics::Statistics::UniformSample do
+  before(:each) do
+  end
+  
+  it "should have a size equal to the initialization parameter" do 
+    sample = Metrics::Statistics::UniformSample.new(100)
+    sample.size.should == 100
+    
+  end
+  
+  it "should allocate an array of the requested size" do
+    sample = Metrics::Statistics::UniformSample.new(100)
+    sample.values.length.should == 100
+    
+    sample.values.each do |value|
+      value.should == 0
+    end
+  end
+  
+  it "should update at the end of the list" do
+    sample = Metrics::Statistics::UniformSample.new(100)
+    (1..100).each do |i|
+      sample.update(i)
+    end
+    
+    values = sample.values
+    
+    (0..99).each do |index|
+      values[index].should == (index + 1)
+    end
+  end
+  
+  it "should update a random entry in the list when it's full" do
+    
+    sample = Metrics::Statistics::UniformSample.new(100)
+    sample.should_receive(:rand).with(any_args()).and_return(50)
+
+    (1..101).each do |i|
+      sample.update(i)
+    end
+    
+    values = sample.values
+    
+    (0..49).each do |index|
+      values[index].should == (index + 1)
+    end
+    
+    values[50].should == 101
+    
+    (51..99).each do |index|
+      values[index].should == (index + 1)
+    end
+    
+  end
+  
+  
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-metrics
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- John Ewart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-units
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 8
+        version: 0.3.8
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: A Ruby implementation of metrics inspired by @coda's JVM metrics for those of us in Ruby land
+email: 
+- john@johnewart.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- autotest/discover.rb
+- examples/counter.rb
+- examples/gauge.rb
+- examples/histogram.rb
+- examples/meter.rb
+- lib/ruby-metrics.rb
+- lib/ruby-metrics/agent.rb
+- lib/ruby-metrics/instruments.rb
+- lib/ruby-metrics/instruments/base.rb
+- lib/ruby-metrics/instruments/counter.rb
+- lib/ruby-metrics/instruments/gauge.rb
+- lib/ruby-metrics/instruments/histogram.rb
+- lib/ruby-metrics/instruments/meter.rb
+- lib/ruby-metrics/logging.rb
+- lib/ruby-metrics/statistics/sample.rb
+- lib/ruby-metrics/statistics/uniform_sample.rb
+- lib/ruby-metrics/version.rb
+- ruby-metrics.gemspec
+- spec/agent_spec.rb
+- spec/instruments/base_spec.rb
+- spec/instruments/counter_spec.rb
+- spec/instruments/gauge_spec.rb
+- spec/instruments/histogram_spec.rb
+- spec/instruments/meter_spec.rb
+- spec/instruments_spec.rb
+- spec/spec_helper.rb
+- spec/statistics/sample_spec.rb
+- spec/statistics/uniform_sample_spec.rb
+has_rdoc: true
+homepage: https://github.com/johnewart/ruby-metrics
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -4356011955923517565
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -4356011955923517565
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ruby-metrics
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Metrics for Ruby
+test_files: 
+- spec/agent_spec.rb
+- spec/instruments/base_spec.rb
+- spec/instruments/counter_spec.rb
+- spec/instruments/gauge_spec.rb
+- spec/instruments/histogram_spec.rb
+- spec/instruments/meter_spec.rb
+- spec/instruments_spec.rb
+- spec/spec_helper.rb
+- spec/statistics/sample_spec.rb
+- spec/statistics/uniform_sample_spec.rb