ruby-metrics 0.5.0

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

@@ -0,0 +1,155 @@
+module Metrics
+  module Instruments
+    class Histogram < Base
+      
+      def initialize
+        @count = 0
+        @sample = Metrics::Statistics::UniformSample.new
+        @min = nil
+        @max = nil
+        @sum = 0
+        @variance_s = 0
+        @variance_m = -1
+      end
+      
+      def update(value)
+      	@count += 1
+      	@sum += value
+      	@sample.update(value)
+      	update_max(value)
+      	update_min(value)
+        update_variance(value);
+      end
+      
+      def clear 
+        @sample.clear
+        @min = nil
+        @max = nil
+        @sum = 0
+        @count = 0
+        @variance_m = -1
+        @variance_s = 0
+      end
+      
+      def quantiles(percentiles)
+        # Calculated using the same logic as R and Ecxel use
+        # as outlined by the NIST here: http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm
+        count = @count
+        scores = {}
+        values = @sample.values[0..count-1]
+      
+        percentiles.each do |pct|
+          scores[pct] = 0.0
+        end
+        
+        if count > 0
+          values.sort!          
+          percentiles.each do |pct|
+            idx = pct * (values.length - 1) + 1.0
+            if idx <= 1
+              scores[pct] = values[0]
+            elsif idx >= values.length
+              scores[pct] = values[values.length-1]
+            else
+              lower = values[idx.to_i - 1]
+              upper = values[idx.to_i]
+              scores[pct] = lower + (idx - idx.floor) * (upper - lower)
+            end
+          end
+        end
+        
+        return scores
+      end
+      
+      def update_min(value)
+        if (@min == nil || value < @min)
+          @min = value 
+        end
+      end
+      
+      def update_max(value)
+        if (@max == nil || value > @max)
+          @max = value 
+        end        
+      end
+      
+      def update_variance(value)
+        count = @count
+        old_m = @variance_m
+        new_m = @variance_m + ((value - old_m) / count)
+        new_s = @variance_s + ((value - old_m) * (value - new_m))
+        
+        @variance_m = new_m
+        @variance_s = new_s
+      end
+      
+      def variance
+        count = @count
+        variance_s = @variance_s 
+        
+        if count <= 1 
+          return 0.0
+        else
+          return variance_s.to_f / (count - 1).to_i
+        end
+      end
+      
+      def count
+        count = @count
+        return count
+      end
+      
+      
+      def max
+        max = @max
+        if max != nil
+          return max
+        else
+          return 0.0
+        end
+      end
+      
+      def min
+        min = @min
+        if min != nil
+          return min
+        else
+          return 0.0
+        end
+      end
+      
+      def mean
+        count = @count
+        sum = @sum
+        
+        if count > 0
+          return sum / count
+        else
+          return 0.0
+        end
+      end
+      
+      def std_dev 
+        count = @count
+        variance = self.variance()
+        
+        if count > 0
+          return Math.sqrt(variance)
+        else 
+          return 0.0
+        end
+      end
+      
+      def to_s
+        {
+          :min => self.min, 
+          :max => self.max,
+          :mean => self.mean, 
+          :variance => self.variance, 
+          :percentiles => self.quantiles([0.25, 0.50, 0.75, 0.95, 0.97, 0.98, 0.99])
+        }.to_json
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+require 'ruby-units'
+
+module Metrics
+  module Instruments
+    class Meter < Base
+      # From http://www.teamquest.com/pdfs/whitepaper/ldavg2.pdf
+      INTERVAL = 5.0
+      INTERVAL_IN_NS = 5000000000.0
+      ONE_MINUTE_FACTOR     = 1 - Math.exp(-INTERVAL / 60.0)
+      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
+      
+      def initialize(options = {})
+        @one_minute_rate = @five_minute_rate = @fifteen_minute_rate = 0.0
+        @counted = @uncounted = 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
+        
+        @timer_thread = Thread.new do
+          sleep_time = interval.to("seconds").scalar
+          begin
+            loop do
+              self.tick
+              sleep(sleep_time)
+            end
+          rescue Exception => e
+            logger.error "Error in timer thread: #{e.class.name}: #{e}\n  #{e.backtrace.join("\n  ")}"
+          end # begin
+        end # thread new
+
+      end
+      
+      def clear
+      end
+      
+      def mark(count = 1)
+        @uncounted += count
+        @counted += count
+      end
+      
+      def calc_rate(rate, factor, count)
+        rate = rate + (factor * (count - rate))
+        rate
+      end
+      
+      def tick
+        count = @uncounted.to_f  / INTERVAL_IN_NS.to_f
+
+        if (@initialized)
+          @one_minute_rate      = calc_rate(@one_minute_rate,     ONE_MINUTE_FACTOR,     count)
+          @five_minute_rate     = calc_rate(@five_minute_rate,    FIVE_MINUTE_FACTOR,    count)
+          @fifteen_minute_rate  = calc_rate(@fifteen_minute_rate, FIFTEEN_MINUTE_FACTOR, count)
+        else
+          @one_minute_rate = @five_minute_rate = @fifteen_minute_rate  = (count)
+          @initialized = true
+        end
+        
+        @uncounted = 0
+      end
+      
+      def one_minute_rate
+        @one_minute_rate * @ratemultiplier
+      end
+      
+      def five_minute_rate
+        @five_minute_rate * @ratemultiplier
+      end
+      
+      def fifteen_minute_rate
+        @fifteen_minute_rate * @ratemultiplier
+      end
+      
+      def to_s
+        {
+          :one_minute_rate => self.one_minute_rate,
+          :five_minute_rate => self.five_minute_rate,
+          :fifteen_minute_rate => self.fifteen_minute_rate
+        }.to_json
+      end
+    end
+  end
+end

data/lib/ruby-metrics/logging.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+module Metrics
+  module Logging
+    
+    def self.included(target)
+      target.extend ClassMethods
+    end
+    
+    def logger
+      self.class.logger
+    end
+    
+    module ClassMethods
+      def logger
+        Metrics.logger
+      end
+    end
+    
+  end
+end

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

@@ -0,0 +1,21 @@
+module Metrics
+  module Statistics
+    class Sample
+	    def clear
+	      raise NotImplementedError
+	    end
+	    
+	    def size
+	      raise NotImplementedError
+      end
+      
+      def update(value)
+        raise NotImplementedError
+      end
+      
+      def values
+        raise NotImplementedError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Metrics
+  module Statistics
+    class UniformSample < Sample
+      
+      def initialize(size = 1028)
+        @values = Array.new(size)
+        @count = 0
+        @size = size
+        self.clear
+      end
+      
+      def clear
+        (0..@values.length-1).each do |i|
+          @values[i] = 0
+        end
+        @count = 0
+      end
+      
+      def size
+        @values.length
+      end
+      
+      def update(value)
+        if @count < @values.length
+          @values[@count] = value
+          @count += 1
+        else
+          index = rand(@size) % @count
+          @values[index] = value
+        end
+      end
+      
+      def values
+        @values.dup
+      end
+    end
+  end
+end

data/lib/ruby-metrics/version.rb

@@ -0,0 +1,3 @@
+module Metrics
+  VERSION = "0.5.0"
+end

data/ruby-metrics.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-metrics/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-metrics"
+  s.version     = Metrics::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Ewart"]
+  s.email       = ["john@johnewart.net"]
+  s.homepage    = "https://github.com/johnewart/ruby-metrics"
+  s.summary     = %q{Metrics for Ruby}
+  s.description = %q{A Ruby implementation of metrics inspired by @coda's JVM metrics for those of us in Ruby land}
+
+  s.rubyforge_project = "ruby-metrics"
+
+  s.add_dependency "json"
+  s.add_dependency "ruby-units"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov", [">= 0.3.8"] #, :require => false
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/agent_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper.rb'
+
+describe Metrics::Agent do
+  before :each do 
+    @agent = Metrics::Agent.new
+  end
+  
+  it "should create a new agent" do  
+  end
+  
+  it "should add a counter instrument correctly" do 
+    @counter = Metrics::Instruments::Counter.new
+    Metrics::Instruments::Counter.stub!(:new).and_return @counter
+    @agent.counter(:test_counter).should == @counter
+  end
+  
+  it "should allow for creating a gauge with a block via #gauge" do 
+    @agent.gauge :test_gauge do 
+      "result"
+    end
+  end
+  
+  it "should add a meter instrument correctly" do
+    @meter = Metrics::Instruments::Meter.new
+    Metrics::Instruments::Meter.stub!(:new).and_return @meter
+
+    @agent.meter(:test_meter).should == @meter
+  end
+  
+  it "should start the WEBrick daemon" do
+    Thread.stub!(:new).and_return do |block|
+      block.call
+    end
+    
+    mock_server = mock(WEBrick::HTTPServer)
+    WEBrick::HTTPServer.should_receive(:new).and_return mock_server
+    mock_server.should_receive(:mount)
+    mock_server.should_receive(:start)
+    @agent.start
+  end
+    
+end

data/spec/instruments/base_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Metrics::Instruments::Base do
+  before(:each) do
+    @base = Metrics::Instruments::Base.new
+  end
+  
+  %w( to_i to_f to_s ).each do |method|
+    it "should raise a NotImplementedError for ##{method}" do
+      lambda do
+        @base.send(method)
+      end.should raise_exception(NotImplementedError)
+    end
+  end
+  
+end

data/spec/instruments/counter_spec.rb

@@ -0,0 +1,72 @@
+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
+  
+end