ruby-metrics 0.5.0

data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+*.gem
+pkg/*
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2@metrics

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in ruby-metrics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    ruby-metrics (0.5.0)
+      json
+      ruby-units
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    json (1.5.1)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-units (1.2.0)
+    simplecov (0.4.0)
+      simplecov-html (~> 0.4.0)
+    simplecov-html (0.4.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  ruby-metrics!
+  simplecov (>= 0.3.8)

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 John Ewart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,44 @@
+
+## What is this?
+
+This is a Ruby version of performance metrics inspired by [metrics][metrics] developed by Coda Hale at Yammer. Currently this is under *heavy* development -- it needs Gem packaging, more features, validation of metrics, more functional testing, and a little better test coverage. Pull requests happily accepted, please include docs and tests where possible!
+
+## What needs to be done?
+
+Among other important things, this needs to be made more thread-safe. I'm currently looking at Mr. Nutter's ruby-atomic gem for making this less tedious but any suggestions are welcome!
+
+## What's in this?
+
+Right now, I have:
+
+* Counters
+* Meters
+* Gauges
+* Histograms w/ uniform sampling
+ 
+Upcoming:
+
+* Histograms w/ exponentially decaying sampling
+* Timers 
+
+## Getting Started
+
+The goal of ruby-metrics is to get up and running quickly. You start an agent, register some instruments, and they're exported over HTTP via JSON. For example, getting started with a counter would look like this:
+
+    @metrics = Metrics::Agent.new
+    @metrics.start
+
+    counter = @metrics.counter :my_counter
+    counter.incr
+    counter.incr
+
+Then, hitting localhost:8081/status would yield:
+
+    {"my_counter":"2"}
+
+
+[metrics]: https://github.com/codahale/metrics
+
+## License
+
+Copyright 2011 John Ewart <john@johnewart.net>. Released under the MIT license. See the file LICENSE for further details.

data/Rakefile

@@ -0,0 +1,19 @@
+require "rubygems"
+require "bundler"
+require "rspec/core/rake_task"
+Bundler::GemHelper.install_tasks
+
+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
+end
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/autotest/discover.rb

@@ -0,0 +1,3 @@
+Autotest.add_discovery do
+    "rspec2"
+end

data/examples/counter.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require '../lib/ruby-metrics'
+
+@metrics = Metrics::Agent.new
+@metrics.start
+
+counter = @metrics.counter :my_counter
+counter.incr
+counter.incr
+
+puts "Counter: #{counter.to_i}"

data/examples/gauge.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require '../lib/ruby-metrics'
+
+@metrics = Metrics::Agent.new
+@metrics.start
+
+hit_count = 42
+http_requests = 53
+
+gauge = @metrics.gauge :my_gauge do
+  {
+    :hit_count => hit_count,
+    :http_requests => http_requests
+  }
+end
+
+puts "Gauge: #{gauge.to_s}"
+
+hit_count = 65
+http_requests = 99
+
+puts "Gauge: #{gauge.to_s}"
+
+result = gauge.get
+
+puts "Result: #{result}"

data/examples/histogram.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require '../lib/ruby-metrics'
+
+@metrics = Metrics::Agent.new
+@metrics.start
+
+histogram = @metrics.histogram :my_histogram
+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
+
+step = 0
+
+# This is here so that we will run indefinitely so you can hit the 
+# status page on localhost:8001/status
+loop do
+  sleep 1
+  
+  modifier = rand(500).to_i / 100
+  step += 1
+  
+  if (step % 2)
+    modifier *= -1
+  end
+  
+  histogram.update((2  + modifier).to_f)
+end

data/examples/meter.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require '../lib/ruby-metrics'
+
+@metrics = Metrics::Agent.new
+@metrics.start
+
+timer = @metrics.meter :my_meter
+timer.mark(500)
+
+step = 0
+
+# This is here so that we will run indefinitely so you can hit the 
+# status page on localhost:8001/status
+loop do
+  sleep 1
+  
+  modifier = rand(200).to_i
+  step += 1
+  
+  if (step % 2)
+    modifier *= -1
+  end
+  
+  timer.mark(500  + modifier)
+end

data/lib/ruby-metrics.rb

@@ -0,0 +1,15 @@
+# == Metrics Initialization
+#
+
+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')

data/lib/ruby-metrics/agent.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__), 'logging')
+require File.join(File.dirname(__FILE__), 'instruments')
+require 'webrick'
+
+class Status < WEBrick::HTTPServlet::AbstractServlet
+  
+  def initialize(server, instruments)
+    @instruments = instruments
+  end
+  
+  def do_GET(request, response)
+    status, content_type, body = do_stuff_with(request)
+    
+    response.status = status
+    response['Content-Type'] = content_type
+    response.body = body
+  end
+  
+  def do_stuff_with(request)
+    return 200, "text/plain", @instruments.to_json
+  end
+  
+end
+
+module Metrics
+  class Agent
+    include Logging
+    include Instruments::TypeMethods
+    
+    attr_reader :instruments
+    
+    def initialize
+      logger.debug "Initializing Metrics..."
+      @instruments = Metrics::Instruments
+    end
+    
+    def start
+      start_daemon_thread
+    end
+    
+    protected
+    def start_daemon_thread(connection_options = {})
+      logger.debug "Creating Metrics daemon thread."
+      @daemon_thread = Thread.new do
+        begin
+          server = WEBrick::HTTPServer.new ({:Port => 8001})
+          server.mount "/status", Status, @instruments
+          server.start
+        rescue Exception => e
+          logger.error "Error in worker thread: #{e.class.name}: #{e}\n  #{e.backtrace.join("\n  ")}"
+        end # begin
+      end # thread new
+    end
+  end
+end

data/lib/ruby-metrics/instruments.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), 'statistics', 'sample')
+require File.join(File.dirname(__FILE__), 'statistics', 'uniform_sample')
+
+require File.join(File.dirname(__FILE__), 'instruments', 'base')
+require File.join(File.dirname(__FILE__), 'instruments', 'counter')
+require File.join(File.dirname(__FILE__), 'instruments', 'meter')
+require File.join(File.dirname(__FILE__), 'instruments', 'gauge')
+require File.join(File.dirname(__FILE__), 'instruments', 'histogram')
+
+
+require 'json'
+
+module Metrics
+  module Instruments
+    @instruments = {}
+    
+    @types = {
+      :counter   => Counter,
+      :meter     => Meter,
+      :gauge     => Gauge,
+      :histogram => Histogram
+    }
+    
+    def self.register(type, name, &block)
+      @instruments[name] = @types[type].new(&block)
+    end
+    
+    def self.unregister_all
+      @instruments = {}
+    end
+    
+    def self.registered
+      @instruments
+    end
+    
+    def self.to_json
+      @instruments.to_json 
+    end
+    
+    module TypeMethods
+      
+      def register(type, name, &block)
+        Metrics::Instruments.register(type, name, &block)
+      end
+      
+      def counter(name)
+        register(:counter, name)
+      end
+      
+      def meter(name)
+        register(:meter, name)
+      end
+      
+      def gauge(name, &block)
+        register(:gauge, name, &block)
+      end
+      
+      def histogram(name)
+        register(:histogram, name)
+      end
+    end
+    
+  end
+end

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

@@ -0,0 +1,19 @@
+module Metrics
+  module Instruments
+    class Base
+            
+      def to_i
+        raise NotImplementedError
+      end
+      
+      def to_s
+        raise NotImplementedError
+      end
+      
+      def to_f
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Metrics
+  module Instruments
+    class Counter < Base
+      
+      def initialize
+        @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_s
+        @value.to_s
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Metrics
+  module Instruments
+    class Gauge < Base
+      
+      def initialize(&block)
+        raise ArgumentError, "a block is required" unless block_given?
+        @block = block
+      end
+      
+      def get
+        instance_exec(&@block)
+      end
+      
+      def to_s
+        get.to_json
+      end
+      
+    end
+  end
+end