ruby-metrics 0.8.6 → 0.9.0

data/.bundle/config

@@ -1,2 +1 @@
---- 
-BUNDLE_DISABLE_SHARED_GEMS: "1"
+--- {}

data/.gitignore

@@ -2,3 +2,5 @@ coverage
 *.gem
 pkg/*
 .DS_Store
+doc
+.yardoc

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.2@metrics
+rvm ruby-1.9.3@metrics

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0 
+  - 2.1

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+v0.8.6 -- June 2, 2011
+======================
+
+* Updated tests for JSON serialization of instruments
+* Fixed JSON serialization of some instruments
+
+v0.8.5 -- May 11, 2011
+======================
+
+* Removed dependency on quantity gem -- conflicted with ActiveSupport
+* Updated code to compute some unit conversions manually instead of depending on quantity
+
+
+v0.8.0 -- April 26, 2011
+========================
+
+* Added timer example
+* Changes to timer initialization
+* Added register_with_options to support timers with different units or options
+* Integrated Matt's changes for integration to modularize webrick and rack export options
+
+v0.7.0 -- April 18, 2011
+========================
+
+* Replaced ruby-units with quantity
+* Added time unit conversion internally
+* Initial implementation of Timer instrument
+* More spec tests to increase coverage
+
+
+v0.6.0 -- April 15, 2011
+========================
+
+* Exponentially decaying samples for histograms
+* Updates to Meter to use exponentially decaying samples
+* Ability to override WEBrick port in constructor
+* Updates to README
+
+v0.5.0 -- April 13, 2011
+========================
+
+* Initial gem packaging (courtesy of @richardiux)
+* Histograms
+* Sampling classes for histograms
+* Updates to weighted average calculations
+* Tests, tests, tests!
+* Mumblety-peg.... 
+

data/Gemfile

@@ -1,4 +1,10 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ruby-metrics.gemspec
-gemspec
+gemspec :name => 'ruby-metrics'
+gemspec :name => 'ruby-metrics-opentsdb'
+
+group :test do
+  gem 'rake'
+  gem 'timecop'
+end

data/README.md

@@ -1,3 +1,4 @@
+[![Build Status](https://travis-ci.org/johnewart/ruby-metrics.svg?branch=master)](https://travis-ci.org/johnewart/ruby-metrics)
 
 ## What is this?
 
@@ -83,4 +84,4 @@ mount Metrics::Integration::Rack::Endpoint.new(:agent => @agent)
 
 ## License
 
-Copyright 2011 John Ewart <john@johnewart.net>. Released under the MIT license. See the file LICENSE for further details.
+Copyright 2011-2014 John Ewart <john@johnewart.net>. Released under the MIT license. See the file LICENSE for further details.

data/Rakefile

@@ -1,14 +1,27 @@
+$:.unshift(File.dirname(__FILE__) + '/lib')
 require "rubygems"
 require "bundler"
 require "rspec/core/rake_task"
-Bundler::GemHelper.install_tasks
+require 'ruby-metrics/version'
 
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
+desc 'Build gem into the pkg directory'
+task :build do
+  FileUtils.rm_rf('pkg')
+  Dir['*.gemspec'].each do |gemspec|
+    puts "Building #{gemspec}"
+    system "gem build #{gemspec}"
+  end
+  FileUtils.mkdir_p('pkg')
+  FileUtils.mv(Dir['*.gem'], 'pkg')
+end
+
+desc 'Tags version, pushes to remote, and pushes gem'
+task :release => :build do
+  puts "Releasing v#{Metrics::VERSION}"
+  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"
 end
 
 RSpec::Core::RakeTask.new do |t|

data/examples/gmontest.rb

@@ -0,0 +1,17 @@
+require 'rubygems' 
+gem 'gmetric'
+require 'gmetric'
+
+result = Ganglia::GMetric.send("172.16.32.130", 8670, {
+   :hostname => 'ook.unixninjas.org', 
+   :spoof => 0,
+   :name => 'narf',
+   :units => 'reqs/sec',
+   :type => 'uint8',
+   :value => 7000,
+   :tmax => 60,
+   :dmax => 300,
+})
+
+puts "Result: #{result.inspect}"
+

data/examples/opentsdb_reporter.rb

@@ -0,0 +1,77 @@
+
+require 'rubygems'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'ruby-metrics'
+require 'ruby-metrics/reporters/opentsdb'
+
+@metrics = Metrics::Agent.new
+@hit_counter = 42
+@http_counter = 53
+
+def hit_count
+  return 42 + rand(40)
+end
+
+def http_requests
+  return 64 + rand(50)
+end
+
+gauge = @metrics.gauge :my_gauge do
+  {
+    :hit_count => hit_count,
+    :http_requests => http_requests
+  }
+end
+
+step = 0
+meter = @metrics.meter :faults, 'faults'
+
+puts "Gauge: #{gauge.to_s}"
+
+result = gauge.get
+counter = @metrics.counter :my_counter
+counter.incr
+counter.incr(50)
+
+counter_two = @metrics.counter :counter_two
+counter_two.incr(0)
+
+timer = @metrics.timer :request_timer, 'requests'
+puts "Result: #{result}"
+
+Thread.new {
+  begin
+    modifier = rand(200).to_i
+    step += 1
+
+    if (step % 2)
+      modifier *= -1
+    end
+
+    meter.mark(500  + modifier)
+    puts "Sleeping for 0.53s --> #{meter.count}"
+    sleep 0.53
+  end while(true)
+}
+
+Thread.new {
+  while(true)
+    begin
+      puts "TIMER1: #{timer.inspect}"
+      timer.time do 
+        sleeptime = rand(10) + 2
+        puts "Sleeping for #{sleeptime}"
+        sleep sleeptime
+        true
+      end
+      puts "TIMER2: #{timer.inspect}"
+    rescue => e
+      puts "Error: #{e.inspect}"
+    end
+  end
+}
+
+opentsdb = Metrics::Reporters::OpenTSDBReporter.new({:hostname => 'localhost', :port => 4242, :agent => @metrics })
+@metrics.report_to('opentsdb', opentsdb)
+@metrics.report_periodically(3.26)

data/lib/ruby-metrics.rb

@@ -1,16 +1,15 @@
 # == Metrics Initialization
 #
 
+require 'logger'
+
 module Metrics
-  
   class << self
     attr_writer :logger
     def logger
       @logger ||= Logger.new(STDOUT)
     end
   end
-  
 end
 
-
-require File.join(File.dirname(__FILE__), 'ruby-metrics', 'agent')
+require 'ruby-metrics/agent'

data/lib/ruby-metrics/agent.rb

@@ -1,22 +1,78 @@
-require File.join(File.dirname(__FILE__), 'logging')
-require File.join(File.dirname(__FILE__), 'instruments')
-require File.join(File.dirname(__FILE__), 'integration')
+require 'ruby-metrics/logging'
+
+require 'ruby-metrics/time_units'
+
+require 'ruby-metrics/instruments/counter'
+require 'ruby-metrics/instruments/meter'
+require 'ruby-metrics/instruments/gauge'
+require 'ruby-metrics/instruments/histogram'
+require 'ruby-metrics/instruments/timer'
+
+require 'ruby-metrics/integration'
+require 'ruby-metrics/reporter'
+
+require 'json'
 
 module Metrics
   class Agent
     include Logging
-    include Instruments::TypeMethods
-    
-    attr_reader :instruments
-    
-    def initialize
-      logger.debug "Initializing Metrics..."
-      @instruments = Metrics::Instruments
-    end
-    
-    def to_json
-      @instruments.to_json
-    end
-    
+
+    attr_reader :instruments, :reporters, :reporter
+
+    def initialize(options = {})
+      @instruments = {}
+      @reporters = {}
+    end
+
+    alias_method :registered, :instruments
+
+    def counter(name, units = '')
+      @instruments[name] ||= Instruments::Counter.new(:units => units)
+    end
+
+    def meter(name, units = '')
+      @instruments[name] ||= Instruments::Meter.new(:units => units)
+    end
+
+    def gauge(name, units = '', &block)
+      @instruments[name] ||= Instruments::Gauge.new(:units => units, &block)
+    end
+
+    def timer(name, units = '', options = {})
+      @instruments[name] ||= Instruments::Timer.new(options.merge(:units => units))
+    end
+
+    def uniform_histogram(name)
+      @instruments[name] ||= Instruments::UniformHistogram.new
+    end
+
+    # For backwards compatibility
+    alias_method :histogram, :uniform_histogram
+
+    def exponential_histogram(name)
+      @instruments[name] ||= Instruments::ExponentialHistogram.new
+    end
+
+    def report_to(name, service)
+      @reporters[name] ||= service
+    end
+
+    def send_metrics!
+      @reporters.each do |name, service|
+        service.report(self)
+      end
+    end
+
+    def report_periodically(delay = nil)
+      @reporter = Reporter.new({:agent => self, :delay => delay})
+    end
+
+    def as_json(*_)
+      @instruments
+    end
+
+    def to_json(*_)
+      as_json.to_json
+    end
   end
 end

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

@@ -1,35 +1,42 @@
 module Metrics
   module Instruments
-    class Counter < Base
-      
-      def initialize
+    class Counter
+
+      attr_reader :units
+
+      def initialize(options = {})
         @value = 0
       end
-      
+
       def inc(value = 1)
         @value += value
       end
       alias_method :incr, :inc
-      
+
       def dec(value = 1)
         @value -= value
       end
       alias_method :decr, :dec
-      
+
       def clear
         @value = 0
       end
-      
+
       def to_i
         @value.to_i
       end
-      
-      def to_json(*_)
+
+      def to_s
         @value.to_s
       end
-      
-    end
 
-    register_instrument(:counter, Counter)
+      def as_json(*_)
+        @value
+      end
+
+      def to_json(*_)
+        as_json.to_json
+      end
+    end
   end
 end

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

@@ -1,22 +1,26 @@
 module Metrics
   module Instruments
-    class Gauge < Base
-      
-      def initialize(&block)
+    class Gauge
+      attr_reader :units
+
+      def initialize(options = {}, &block)
         raise ArgumentError, "a block is required" unless block_given?
         @block = block
+        @units = options[:units]
       end
-      
+
       def get
         instance_exec(&@block)
       end
-      
+
+      def as_json(*_)
+        value = get
+        value.respond_to?(:as_json) ? value.as_json : value
+      end
+
       def to_json(*_)
-        get.to_json
+        as_json.to_json
       end
-      
     end
-
-    register_instrument(:gauge, Gauge)
   end
 end

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

@@ -1,7 +1,10 @@
+require 'ruby-metrics/statistics/uniform_sample'
+require 'ruby-metrics/statistics/exponential_sample'
+
 module Metrics
   module Instruments
-    class Histogram < Base
-      
+    class Histogram
+
       def initialize(type = :uniform)
         @count = 0
         case type
@@ -16,7 +19,7 @@ module Metrics
         @variance_s = 0
         @variance_m = -1
       end
-      
+
       def update(value)
       	@count += 1
       	@sum += value
@@ -25,8 +28,8 @@ module Metrics
       	update_min(value)
         update_variance(value);
       end
-      
-      def clear 
+
+      def clear
         @sample.clear
         @min = nil
         @max = nil
@@ -35,20 +38,20 @@ module Metrics
         @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!          
+          values.sort!
           percentiles.each do |pct|
             idx = pct * (values.length - 1) + 1.0
             if idx <= 1
@@ -62,49 +65,49 @@ module Metrics
             end
           end
         end
-        
+
         return scores
       end
-      
+
       def update_min(value)
         if (@min == nil || value < @min)
-          @min = value 
+          @min = value
         end
       end
-      
+
       def update_max(value)
         if (@max == nil || value > @max)
-          @max = value 
-        end        
+          @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 
+        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
@@ -113,7 +116,7 @@ module Metrics
           return 0.0
         end
       end
-      
+
       def min
         min = @min
         if min != nil
@@ -122,60 +125,58 @@ module Metrics
           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 
+
+      def std_dev
         count = @count
         variance = self.variance()
-        
+
         if count > 0
           return Math.sqrt(variance)
-        else 
+        else
           return 0.0
         end
       end
-      
+
       def values
         @sample.values
       end
-      
-      def to_json(*_)
+
+      def as_json(*_)
         {
-          :min => self.min, 
+          :min => self.min,
           :max => self.max,
-          :mean => self.mean, 
-          :variance => self.variance, 
+          :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
+
+      def to_json(*_)
+        as_json.to_json
       end
-    
     end
-  
+
     class ExponentialHistogram < Histogram
       def initialize
         super(:exponential)
       end
     end
 
-    register_instrument(:exponential_histogram, ExponentialHistogram)
-
     class UniformHistogram < Histogram
       def initialize
         super(:uniform)
       end
     end
-
-    register_instrument(:uniform_histogram, UniformHistogram)
   end
-  
 end