ruby-metrics 0.9.0 → 0.9.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '04971d78af7ca682008c7d66db2eac34111c089bb17778cc18ff434843707126'
+  data.tar.gz: e1ec094ef4a2082d12df838b211fac9cebaf207bf4fabb33fb3b30eaef1f97ff
+SHA512:
+  metadata.gz: 60b859a4037eb7f22d2bbaa0965cc1ed55845817a613701a9a3f19bba088c6886feb68aad020e421506d330fb87eafa612b0c364773d850dbcd92d9e95798e56
+  data.tar.gz: 1b2f48bee677fadfffb53335058aa036985f64f9ce2f6f7901bae3fe8b996dc26c36b83d0303d1ea93065e5eef6cf298ff8c4328c8c13df0182592b694c2d02a

data/Rakefile

@@ -21,7 +21,7 @@ task :release => :build do
   sh 'git', 'tag', '-m', "Version #{Metrics::VERSION}",  "v#{Metrics::VERSION}"
   sh "git push origin master"
   sh "git push origin v#{Metrics::VERSION}"
-  #sh "ls pkg/*.gem | xargs -n 1 gem push"
+  sh "ls pkg/*.gem | xargs -n 1 gem push"
 end
 
 RSpec::Core::RakeTask.new do |t|

data/lib/ruby-metrics/agent.rb

@@ -67,6 +67,10 @@ module Metrics
       @reporter = Reporter.new({:agent => self, :delay => delay})
     end
 
+    def stop_reporting
+      @reporter.stop
+    end
+
     def as_json(*_)
       @instruments
     end

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

@@ -1,11 +1,14 @@
+require_relative 'instrument'
+
 module Metrics
   module Instruments
-    class Counter
+    class Counter < Instrument
 
       attr_reader :units
 
       def initialize(options = {})
         @value = 0
+        @units = options[:units]
       end
 
       def inc(value = 1)

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

@@ -1,6 +1,8 @@
+require_relative 'instrument'
+
 module Metrics
   module Instruments
-    class Gauge
+    class Gauge < Instrument
       attr_reader :units
 
       def initialize(options = {}, &block)

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

@@ -1,23 +1,24 @@
+require_relative 'instrument'
 require 'ruby-metrics/statistics/uniform_sample'
 require 'ruby-metrics/statistics/exponential_sample'
 
 module Metrics
   module Instruments
-    class Histogram
+    class Histogram < Instrument
+      attr_reader :count
 
       def initialize(type = :uniform)
-        @count = 0
-        case type
-        when :uniform
-          @sample = Metrics::Statistics::UniformSample.new
-        when :exponential
-          @sample = Metrics::Statistics::ExponentialSample.new
-        end
-        @min = nil
-        @max = nil
-        @sum = 0
-        @variance_s = 0
-        @variance_m = -1
+        @sample =
+          case type
+          when :uniform
+            Metrics::Statistics::UniformSample.new
+          when :exponential
+            Metrics::Statistics::ExponentialSample.new
+          else
+            raise ArgumentError, "Unknown type #{type.inspect}"
+          end
+
+        clear
       end
 
       def update(value)
@@ -26,7 +27,7 @@ module Metrics
       	@sample.update(value)
       	update_max(value)
       	update_min(value)
-        update_variance(value);
+        update_variance(value)
       end
 
       def clear
@@ -40,111 +41,80 @@ module Metrics
       end
 
       def quantiles(percentiles)
-        # Calculated using the same logic as R and Ecxel use
+        # Calculated using the same logic as R and Excel 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]
 
+        sorted_values = @sample.values[0...@count].sort
+        scores = { }
         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]
+          scores[pct] =
+            if @count == 0
+              0.0
             else
-              lower = values[idx.to_i - 1]
-              upper = values[idx.to_i]
-              scores[pct] = lower + (idx - idx.floor) * (upper - lower)
-            end
+              index = pct * (sorted_values.length - 1) + 1.0
+              if index <= 1
+                sorted_values.first
+              elsif index >= sorted_values.length
+                sorted_values.last
+              else
+                lower = sorted_values[index.to_i - 1]
+                upper = sorted_values[index.to_i]
+                lower + (index - index.floor) * (upper - lower)
+              end
           end
         end
-
-        return scores
+        scores
       end
 
       def update_min(value)
-        if (@min == nil || value < @min)
+        if @min.nil? || value < @min
           @min = value
         end
       end
 
       def update_max(value)
-        if (@max == nil || value > @max)
+        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))
+        new_m = @variance_m + ((value - @variance_m) / @count)
+        new_s = @variance_s + ((value - @variance_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
+        if @count <= 1
+          0.0
         else
-          return variance_s.to_f / (count - 1).to_i
+          @variance_s.to_f / (@count - 1)
         end
       end
 
-      def count
-        count = @count
-        return count
-      end
-
-
       def max
-        max = @max
-        if max != nil
-          return max
-        else
-          return 0.0
-        end
+        @max || 0.0
       end
 
       def min
-        min = @min
-        if min != nil
-          return min
-        else
-          return 0.0
-        end
+        @min || 0.0
       end
 
       def mean
-        count = @count
-        sum = @sum
-
-        if count > 0
-          return sum / count
+        if @count > 0
+          @sum / @count
         else
-          return 0.0
+          0.0
         end
       end
 
       def std_dev
-        count = @count
-        variance = self.variance()
-
-        if count > 0
-          return Math.sqrt(variance)
+        if @count > 0
+          Math.sqrt(variance)
         else
-          return 0.0
+          0.0
         end
       end
 
@@ -154,11 +124,11 @@ module Metrics
 
       def as_json(*_)
         {
-          :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])
+          :min         => min,
+          :max         => max,
+          :mean        => mean,
+          :variance    => variance,
+          :percentiles => quantiles(Timer::DEFAULT_PERCENTILES)
         }
       end
 

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

@@ -0,0 +1,13 @@
+module Metrics
+  module Instruments
+    class Instrument
+      def tags
+        @tags ||= {}
+      end
+
+      def tag(key, value)
+        tags[key] = value
+      end
+    end
+  end
+end

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

@@ -1,42 +1,41 @@
+require_relative 'instrument'
 require 'ruby-metrics/time_units'
 
 module Metrics
   module Instruments
-    class Meter
+    class Meter < Instrument
       include Metrics::TimeConversion
 
       # 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 :count
-      attr_reader :units
+      INTERVAL_SECONDS = 5.0
+      ONE_MINUTE_FACTOR     = 1 - Math.exp(-INTERVAL_SECONDS / 60.0)
+      FIVE_MINUTE_FACTOR    = 1 - Math.exp(-INTERVAL_SECONDS / (60.0 * 5.0))
+      FIFTEEN_MINUTE_FACTOR = 1 - Math.exp(-INTERVAL_SECONDS / (60.0 * 15.0))
+
+      attr_reader :count, :units
       alias_method :counted, :count
 
       def initialize(options = {})
-        @one_minute_rate = @five_minute_rate = @fifteen_minute_rate = 0.0
-        @count  = 0
-        @initialized = false
-        @start_time = Time.now.to_f
-        @units = "#{options[:units]}"
+        @units = options[:units]
+        clear
 
         @timer_thread = Thread.new do
           begin
             loop do
-              self.tick
-              sleep(INTERVAL)
+              tick
+              sleep(INTERVAL_SECONDS)
             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
+        end
       end
 
       def clear
+        @one_minute_rate = @five_minute_rate = @fifteen_minute_rate = 0.0
+        @count  = 0
+        @initialized = false
+        @start_time = Time.now.to_f
       end
 
       def mark(count = 1)
@@ -44,19 +43,18 @@ module Metrics
       end
 
       def calc_rate(rate, factor, count)
-        rate = rate.to_f + (factor.to_f * (count.to_f - rate.to_f))
-        rate.to_f
+        rate.to_f + factor.to_f * (count.to_f - rate.to_f)
       end
 
       def tick
-        count = @count.to_f  / Seconds.to_nsec(INTERVAL).to_f
+        count = @count.to_f / Seconds.to_nsec(INTERVAL_SECONDS).to_f
 
-        if (@initialized)
+        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)
+          @one_minute_rate = @five_minute_rate = @fifteen_minute_rate  = count
           @initialized = true
         end
 
@@ -76,21 +74,20 @@ module Metrics
       end
 
       def mean_rate(rate_unit = :seconds)
-        count = @count
-        if count == 0
-          return 0.0
+        if @count == 0
+          0.0
         else
           elapsed = Time.now.to_f - @start_time.to_f
-          mult = scale_time_units(:seconds, rate_unit)
-          count.to_f / (mult * elapsed.to_f)
+          scale_factor = scale_time_units(:seconds, rate_unit)
+          @count.to_f / (elapsed * scale_factor)
         end
       end
 
       def as_json(*_)
         {
-          :one_minute_rate => self.one_minute_rate,
-          :five_minute_rate => self.five_minute_rate,
-          :fifteen_minute_rate => self.fifteen_minute_rate
+          :one_minute_rate      => one_minute_rate,
+          :five_minute_rate     => five_minute_rate,
+          :fifteen_minute_rate  => fifteen_minute_rate
         }
       end
 

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

@@ -1,12 +1,15 @@
-require File.join(File.dirname(__FILE__), '..', 'time_units')
+require_relative 'instrument'
+require 'ruby-metrics/time_units'
 
 module Metrics
   module Instruments
-    class Timer
+    class Timer < Instrument
       include Metrics::TimeConversion
 
       attr_reader :duration_unit, :rate_unit, :units
 
+      DEFAULT_PERCENTILES = [0.25, 0.50, 0.75, 0.95, 0.97, 0.98, 0.99]
+
       def initialize(options = {})
         @meter          = Meter.new
         @histogram      = ExponentialHistogram.new
@@ -19,17 +22,17 @@ module Metrics
       end
 
       def clear
+        @meter.clear
         @histogram.clear
       end
 
       def update(duration, unit)
-        mult = convert_to_ns(1, unit)
-        self.update_timer(duration * mult)
+        update_timer(convert_to_ns(duration, unit))
       end
 
-      def time(&block)
+      def time
         start_time = Time.now.to_f
-        result = block.call
+        result = yield
         time_diff = Time.now.to_f - start_time
         time_in_ns = convert_to_ns time_diff, :seconds
         update_timer(time_in_ns)
@@ -72,24 +75,17 @@ module Metrics
         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|
+      def quantiles(percentiles = DEFAULT_PERCENTILES)
+        @histogram.quantiles(percentiles).inject({}) do |result, (k, v)|
           result[k] = scale_duration_to_ns v, @duration_unit
+          result
         end
-
-        result
       end
 
       def values
-        result = []
-
-        @histogram.values.each do |value|
-          result << (scale_duration_to_ns value, @duration_unit)
+        @histogram.values.map do |value|
+          scale_duration_to_ns value, @duration_unit
         end
-
-        result
       end
 
       def update_timer(duration)
@@ -112,7 +108,7 @@ module Metrics
             :min => min,
             :max => max,
             :mean => mean,
-            :percentiles => quantiles([0.25, 0.50, 0.75, 0.95, 0.97, 0.98, 0.99]),
+            :percentiles => quantiles,
             :unit => @duration_unit
           }
         }
@@ -124,7 +120,7 @@ module Metrics
 
       private
       def scale_duration_to_ns(value, unit)
-        value.to_f / convert_to_ns(1, unit).to_f
+        value.to_f / convert_to_ns(1.0, unit)
       end
     end
   end

data/lib/ruby-metrics/integration/rack_endpoint.rb

@@ -12,7 +12,7 @@ module Metrics
                       :requests, :uncaught_exceptions,
                       :status_codes
         
-        def initialize(options ={})
+        def initialize(options = {})
           @options  = options
           @agent    = @options.delete(:agent) || Agent.new
         end

data/lib/ruby-metrics/integration/rack_middleware.rb

@@ -15,54 +15,41 @@ module Metrics
     module Rack
       class Middleware
         
-        attr_accessor :app, :options, :agent,
-                      # integration metrics
-                      :requests, :uncaught_exceptions,
-                      :status_codes
-        
+        attr_accessor :app, :options, :agent
+
         def initialize(app, options ={})
           @app      = app
           @options  = {:show => "/stats"}.merge(options)
           @agent    = @options.delete(:agent) || Agent.new
-          
-          # Integration Metrics
-          @requests             = @agent.timer(:_requests)
-          @uncaught_exceptions  = @agent.counter(:_uncaught_exceptions)
-          
-          # HTTP Status Codes
-          @status_codes = {
-            1 => @agent.counter(:_status_1xx),
-            2 => @agent.counter(:_status_2xx),
-            3 => @agent.counter(:_status_3xx),
-            4 => @agent.counter(:_status_4xx),
-            5 => @agent.counter(:_status_5xx)
-          }
         end
-        
+
         def call(env)
           return show(env) if show?(env)
           
           env['metrics.agent'] = @agent
           
-          status, headers, body = self.requests.time{ @app.call(env) }
-          
-          if status_counter = self.status_codes[status / 100]
-            status_counter.incr
-          end
-          
+          status, headers, body = time_request { @app.call(env) }
+
+          incr_status_code_counter(status / 100)
+
           [status, headers, body]
         rescue Exception
           # TODO: add "last_uncaught_exception" with string of error
-          self.uncaught_exceptions.incr
+          incr_uncaught_exceptions
           raise
         end
-        
-        def show?(env, test = self.options[:show])
+
+      private
+        def show?(env, test = options[:show])
           case
-          when String === test;         env['PATH_INFO'] == test
-          when Regexp === test;         env['PATH_INFO'] =~ test
-          when test.respond_to?(:call); test.call(env)
-          else                          test
+          when String === test
+            env['PATH_INFO'] == test
+          when Regexp === test
+            env['PATH_INFO'] =~ test
+          when test.respond_to?(:call)
+            test.call(env)
+          else
+            test
           end
         end
         
@@ -75,7 +62,18 @@ module Metrics
             [body]
           ]
         end
-        
+
+        def time_request(&block)
+          @agent.timer(:_requests).time(&block)
+        end
+
+        def incr_uncaught_exceptions
+          @agent.counter(:_uncaught_exceptions).incr
+        end
+
+        def incr_status_code_counter(hundred)
+          @agent.counter(:"_status_#{hundred}xx").incr
+        end
       end
     end
   end

data/lib/ruby-metrics/reporter.rb

@@ -5,7 +5,12 @@ module Metrics
 
     include Logging
 
+    def stop
+      @running = false
+    end
+
     def initialize(options = {})
+      @running = true
 
       if options[:agent] == nil
         raise "Need an agent to report data from"
@@ -15,13 +20,13 @@ module Metrics
       agent = options[:agent] 
 
       Thread.new {
-        while(true)
+        while @running
           agent.reporters.each do |name, service|
             service.report(agent)
           end
           sleep delay
         end
-      }.join
+      }
     end
 
   end