drone 1.0.4 → 1.0.5

data/lib/drone.rb

@@ -6,6 +6,7 @@ module Drone
   
   require_lib("drone/version")
   
+  require_lib("drone/errors")
   require_lib("drone/monitoring")
   
   # Schedulers

data/lib/drone/errors.rb

@@ -0,0 +1,11 @@
+module Drone
+  ##
+  # Generic base class for all the errors drone can raises
+  class DroneError < RuntimeError; end
+  
+  ##
+  # Raised when trying to reuse a meter name with a different
+  # type.
+  class AlreadyDefined < DroneError; end
+  
+end

data/lib/drone/metrics/histogram.rb

@@ -41,12 +41,13 @@ module Drone
     
     def clear
       @sample.clear()
-      @count = 0
-      @_min = MAX
-      @_max = MIN
-      @_sum = 0
-      @varianceM = -1
-      @varianceS = 0
+            
+      @count = Drone::request_number("#{name}:count", 0)
+      @_min = Drone::request_number("#{name}:min", MAX)
+      @_max = Drone::request_number("#{name}:max", MIN)
+      @_sum = Drone::request_number("#{name}:max", 0)
+      @varianceM = Drone::request_number("#{name}:varianceM", -1)
+      @varianceS = Drone::request_number("#{name}:varianceS", 0)
     end
     
     def update(val)

data/lib/drone/metrics/meter.rb

@@ -7,7 +7,7 @@ require File.expand_path('../../utils/ewma', __FILE__)
 module Drone
   module Metrics
     ##
-    # A meter measures mean throughput and one-, five-, and
+    # This meter measures mean throughput and one-, five-, and
     # fifteen-minute exponentially-weighted moving average throughputs.
     # 
     class Meter < Metric

data/lib/drone/monitoring.rb

@@ -28,7 +28,7 @@ module Drone
       def monitor_rate(name)
         meter = Drone::find_metric(name) || Metrics::Meter.new(name)
         unless meter.is_a?(Metrics::Meter)
-          raise(TypeError, "metric #{name} is already defined as #{rate.class}")
+          raise AlreadyDefined, "metric #{name} is already defined as #{meter.class}"
         end
         
         Drone::register_metric(meter)
@@ -47,7 +47,7 @@ module Drone
       def monitor_time(name)
         timer = Drone::find_metric(name) || Metrics::Timer.new(name)
         unless timer.is_a?(Metrics::Timer)
-          raise(TypeError, "metric #{name} is already defined as #{rate.class}")
+          raise AlreadyDefined, "metric #{name} is already defined as #{timer.class}"
         end
         Drone::register_metric(timer)
         @_timer_waiting = timer

data/lib/drone/storage/memory.rb

@@ -36,6 +36,7 @@ module Drone
           # dummy implementation, with memory storage nothing can
           # happen to our data
           set(new_value)
+          true
         end
         
       end

data/lib/drone/utils/exponentially_decaying_sample.rb

@@ -1,10 +1,29 @@
+require 'flt'
 require File.expand_path('../../core', __FILE__)
 
 module Drone
-  class ExponentiallyDecayingSample
-    # 1 hour in ms
-    RESCALE_THRESHOLD = (1 * 60 * 60 * 1000).freeze
   
+  ##
+  # An exponentially-decaying random sample
+  # 
+  class ExponentiallyDecayingSample
+    # 1 hour
+    RESCALE_THRESHOLD = (1 * 60 * 60).freeze
+    
+    ##
+    # Create a new dataset, if the decay factor is too big
+    # the flt ruby library will be used for internal computations
+    # to allow greater precision, the switch happens if alpha is
+    # higher than 0.1.
+    # 
+    # @param [String] id A unique id representing this
+    #   dataset.
+    # @param [Integer] reservoir_size the number of samples
+    #   to keep.
+    # @param [Number] alpha the decay factor, the higher this
+    #   number, the more biased the sample will be towards
+    #   newer values.
+    # 
     def initialize(id, reservoir_size, alpha)
       @id = id
       @values = Drone::request_hash("#{@id}:values")
@@ -28,25 +47,28 @@ module Drone
       (@values.size < count) ? @values.size : count
     end
   
-  
     def update(val, time = current_time)
-      priority = weight(time - @start_time.get) / rand()
-      count = @count.inc
-      if count <= @reservoir_size
+      priority = weight(time - @start_time.get) / generate_random()
+      new_count = @count.inc
+      
+      if new_count <= @reservoir_size
         @values[priority] = val
       else
-        first = @values.keys.min
+        first = @values.keys[0]
         if first < priority
-          @values[priority] = val
-          while @values.delete(first) == nil
-            first = @values.keys.min
+          old_val, @values[priority] = @values[priority], val
+          unless old_val
+            while @values.delete(first) == nil
+              first = @values.keys[0]
+            end
           end
         end
       end
     
       now = current_time()
-      if now >= @next_scale_time.get
-        rescale(now)
+      next_scale = @next_scale_time.get
+      if now >= next_scale
+        rescale(now, next_scale)
       end
     end
   
@@ -55,26 +77,59 @@ module Drone
         buff << @values[key]
       end
     end
-  
-    def rescale(now)
-      @next_scale_time.set( current_time() + RESCALE_THRESHOLD )
-      new_start = current_time()
-      old_start = @start_time.get_and_set(new_start)
-    
-      @values = Hash[ @values.map{ |k,v|
-          [k * Math.exp(-@alpha * (new_start - old_start)), v]
-        }]
     
+    def rescale(now, next_scale)
+      if @next_scale_time.compare_and_set(next_scale, now + RESCALE_THRESHOLD)
+        new_start = current_time()
+        old_start = @start_time.get_and_set( new_start )
+        time_diff = new_start - old_start
+        
+        @values = Hash[ @values.map{ |k,v|
+            [k * math_exp(-@alpha * time_diff), v]
+          }]
+        
+      end
     end
   
   private
+    
+    def use_flt?
+      @alpha > 0.1
+    end
+    
+    def math_exp(n)
+      if use_flt?
+        Flt::DecNum(Rational(n)).exp()
+      else
+        Math.exp(n)
+      end
+    end
+    
+    ##
+    # Generates a non-zero random number
+    # According to the ruby documentation rand() could return 0
+    # so we ensure this will never happen
+    # 
+    # @return [Float] The random number
+    # 
+    def generate_random()
+      begin
+        r = Kernel.rand()
+      end while r == 0.0
+      
+      if use_flt?
+        Flt::DecNum(Rational(r))
+      else
+        r
+      end
+    end
   
     def current_time
-      Time.now.to_f * 1000
+      Time.now.to_f
     end
   
     def weight(n)
-      Math.exp(@alpha * n)
+      math_exp(@alpha * n)
     end
   
   end

data/lib/drone/version.rb

@@ -1,3 +1,3 @@
 module Drone
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/specs/{unit → metrics}/histogram_spec.rb

@@ -9,7 +9,7 @@ describe 'Histogram' do
     Drone::init_drone()
   end
   
-  describe "A histogram with zero recorded valeus" do
+  describe "A histogram with zero recorded values" do
     before do
       @histogram = Histogram.new("id1", UniformSample.new("id1:sample", 100))
     end
@@ -17,6 +17,10 @@ describe 'Histogram' do
     should "have a count of 0" do
       @histogram.count.should == 0
     end
+    
+    should "have a variance of 0" do
+      @histogram.send(:variance).should == 0
+    end
 
     should "have a max of 0" do
       @histogram.max.should == 0

data/specs/metrics/meter_spec.rb

@@ -48,14 +48,22 @@ EM.describe 'Meter Metrics' do
 
   describe "A meter metric with three events" do
     before do
-      @meter = Metrics::Meter.new("thangs")
-      @meter.mark(3)
+      Delorean.time_travel_to("2 second ago") do
+        @meter = Metrics::Meter.new("thangs")
+        @meter.mark(3)
+      end
     end
 
     should "have a count of three" do
       @meter.count.should == 3
       done
     end
+    
+    should "have a mean rate of 0 events/sec" do
+      @meter.mean_rate.should.be.close?(1.5, 0.01)
+      done
+    end
+    
   end
   
 end

data/specs/metrics/timer_spec.rb

@@ -9,7 +9,7 @@ EM.describe 'Timer Metrics' do
     Drone::start_monitoring()
   end
   
-  describe "A blank timer" do
+  describe "A newly created timer" do
     before do
       @timer = Metrics::Timer.new('id')
     end
@@ -91,6 +91,12 @@ EM.describe 'Timer Metrics' do
       @timer.stdDev.should.be.close?(11.401, 0.001)
       done
     end
+    
+    it 'can be cleared' do
+      @timer.clear()
+      @timer.count.should == 0
+      done
+    end
 
     should "calculate the median/p95/p98/p99/p999" do
       median, p95, p98, p99, p999 = @timer.percentiles(0.5, 0.95, 0.98, 0.99, 0.999)

data/specs/{unit/monitoring_spec.rb → monitoring_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../../common', __FILE__)
+require File.expand_path('../common', __FILE__)
 
 require 'drone'
 require 'drone/monitoring'
@@ -21,11 +21,35 @@ EM.describe 'Monitoring' do
         monitor_rate("users/with_block")
         def method_with_block(&block); block.call; end
         
+        monitor_time("users/timed")
+        def timed_method; end;
+        
       end
       @obj = @klass.new
       
     end
     
+    should "raise an error if the metric name os already used (rate => time)" do
+      proc{
+        @klass.instance_eval do
+          monitor_time("users/no_args")
+        end
+      }.should.raise(Drone::AlreadyDefined)
+      
+      done
+    end
+    
+    should "raise an error if the metric name os already used (time => rate)" do
+      
+      proc{
+        @klass.instance_eval do
+          monitor_rate("users/timed")
+        end
+      }.should.raise(Drone::AlreadyDefined)
+      
+      done
+    end
+    
     should 'reuse same meter for every instances of this class' do
       meter = Drone::find_metric("users/no_args")
       meter.count.should == 0

data/specs/{unit → utils}/ewma_spec.rb

@@ -23,6 +23,7 @@ describe 'EWMA' do
     
     should "have a rate of 0.6 events/sec after the first tick" do
       @ewma.rate.should.be.close(0.6, 0.000001)
+      @ewma.rate(:ms).should.be.close(0.0006, 0.000001)
     end
     
     {

data/specs/utils/exponentially_decaying_sample_spec.rb

@@ -0,0 +1,140 @@
+require File.expand_path('../../common', __FILE__)
+
+require 'drone/utils/exponentially_decaying_sample'
+include Drone
+
+describe 'Exponentially Decaying Sample' do
+  before do
+    Drone::init_drone(nil, Storage::Memory.new)
+  end
+  
+  describe "A sample of 100 out of 1000 elements" do
+    before do
+      @population = (0...100)
+      @sample = ExponentiallyDecayingSample.new('id1', 1000, 0.99)
+      @population.step(1){|n| @sample.update(n) }
+    end
+    
+
+    should "have 100 elements" do
+      @sample.size.should == 100
+      @sample.values.size.should == 100
+    end
+
+    should "only have elements from the population" do
+      arr = @sample.values - @population.to_a
+      arr.should == []
+    end
+    
+  end
+  
+  
+  describe "A sample of 100 out of 10 elements" do
+    before do
+      @population = (0...100)
+      @sample = ExponentiallyDecayingSample.new('id1', 100, 0.99)
+      @population.step(1){|n| @sample.update(n) }
+    end
+
+    should "have 100 elements" do
+      @sample.size.should == 100
+      @sample.values.size.should == 100
+    end
+
+    should "only have elements from the population" do
+      arr = @sample.values - @population.to_a
+      arr.should == []
+    end
+    
+    should "rescale after 1 hour2" do
+      Delorean.time_travel_to("1 hours from now") do
+        @sample.update(42)
+      end
+      
+      @sample.size.should == 100
+      @sample.values.size.should == 100
+    end
+    
+  end
+  
+  
+  describe "A heavily-biased sample of 100 out of 1000 elements" do
+    before do
+      @population = (0...100)
+      @sample = ExponentiallyDecayingSample.new('id1', 100, 0.01)
+      @population.step(1){|n| @sample.update(n) }
+    end
+
+    should "have 100 elements" do
+      @sample.size.should == 100
+      @sample.values.size.should == 100
+    end
+
+    should "only have elements from the population" do
+      arr = @sample.values - @population.to_a
+      arr.should == []
+    end
+    
+    should "rescale after 1 hour" do
+      Delorean.time_travel_to("1 hours from now") do
+        @sample.update(42)
+      end
+      
+      @sample.size.should == 100
+      @sample.values.size.should == 100
+    end
+    
+  end
+  
+  describe "A heavily-biased sample of 1000 out of 1000 elements" do
+    before do
+      @population = (0...1000)
+      @sample =  ExponentiallyDecayingSample.new('id1', 1000, 0.01)
+      @population.step(1){|n| @sample.update(n) }
+    end
+    
+    it "should have 1000 elements" do
+      @sample.size.should == 1000
+      @sample.values.length.should == 1000
+    end
+
+    it "should only have elements from the population" do
+      values = @sample.values
+      @population.each do |datum|
+        values.should.include?(datum)
+      end
+    end
+    
+    it "should replace an element when updating" do
+      Delorean.time_travel_to("10 minutes from now") do
+        @sample.update(4242)
+        @sample.size.should == 1000
+        @sample.values.should.include?(4242)
+      end
+    end
+    
+    it "should rescale so that newer events are higher in priority in the hash" do 
+      Delorean.time_travel_to("1 hour from now") do
+        @sample.update(2121)
+        @sample.size.should == 1000
+      end
+      
+      Delorean.time_travel_to("2 hours from now") do
+        @sample.update(4242)
+        @sample.size.should == 1000
+        
+        values = @sample.values
+        
+        values.length.should == 1000
+        values.should.include?(4242)
+        values.should.include?(2121)
+        
+        # Most recently added values in time should be at the end with the highest priority
+        values[999].should == 4242
+        values[998].should == 2121
+      end
+      
+    end
+  end
+  
+end