ruby-metrics 0.7.0 → 0.8.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-metrics (0.7.0)
+    ruby-metrics (0.8.0)
       json
       quantity
 
@@ -11,6 +11,9 @@ GEM
     diff-lcs (1.1.2)
     json (1.5.1)
     quantity (0.1.1)
+    rack (1.2.2)
+    rack-test (0.5.7)
+      rack (>= 1.0)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)
@@ -27,6 +30,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  rack-test
   rspec
   ruby-metrics!
   simplecov (>= 0.3.8)

data/README.md

@@ -16,26 +16,68 @@ Right now, I have:
 * Gauges
 * Histograms w/ uniform sampling
 * Histograms w/ exponentially decaying sampling
- 
-Upcoming:
-
-* Timers 
+* 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:8001/status would yield:
+    puts @metrics.to_json
+    #=> {"my_counter":"2"}
+
+
+## Integration
+
+Integrating ruby-metrics into existing applications is entirely up to your needs. Provided options include:
+
+* Embedded WEBrick listener:
+
+  This runs a background thread and enables HTTP access to a local port (8001 by default) for a JSON representation of the current metrics.
+
+``` ruby
+require 'ruby-metrics/integration/webrick'
+@agent = Metrics::Agent.new
+@agent.start(:port => 8081)
+```
+
+* Rack Middleware:
+
+  This will add metrics such as `requests` (a timer) as well as counters for each class of HTTP status code (1xx, 2xx, etc). Also counts uncaught exceptions before reraising.
+  Provides a configurable path option (`:show`) to trigger the return of the metrics (as JSON) when the request path matches exactly (a string), as a regular expression, or as any object that responds to `call` for custom logic (passed the whole `env`).
+
+``` ruby
+require 'ruby-metrics'
+@agent = Metrics::Agent.new
+
+use Metrics::Integration::Rack::Middleware, :agent => @agent, :show => '/stats'
+
+run app
+```
+
+* Rack Endpoint:
+
+  Use this to expose an endpoint for external consumption for your metrics.
+  Works best when used with a URLMap or mounted in addition to other routes, like Rails' `mount` route matcher.
+
+``` ruby
+require 'ruby-metrics'
+@agent = Metrics::Agent.new
+
+run Metrics::Integration::Rack::Endpoint.new(:agent => @agent)
+```
 
-    {"my_counter":"2"}
+or
 
+``` ruby
+# in config/router.rb
+mount Metrics::Integration::Rack::Endpoint.new(:agent => @agent)
+```
 
 [metrics]: https://github.com/codahale/metrics
 

data/examples/counter.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 require '../lib/ruby-metrics'
 
 @metrics = Metrics::Agent.new
-@metrics.start
 
 counter = @metrics.counter :my_counter
 counter.incr

data/examples/gauge.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 require '../lib/ruby-metrics'
 
 @metrics = Metrics::Agent.new
-@metrics.start
 
 hit_count = 42
 http_requests = 53

data/examples/histogram.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require '../lib/ruby-metrics'
+require '../lib/ruby-metrics/integration/webrick'
 
 @metrics = Metrics::Agent.new
 @metrics.start
@@ -16,7 +16,7 @@ end
 step = 0
 
 # This is here so that we will run indefinitely so you can hit the 
-# status page on localhost:8001/status
+# status page on localhost:8001/stats
 loop do
   sleep 1
   

data/examples/integration/rack_endpoint.ru

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+# Ran with:
+# rackup -p 8000 ./examples/integration/rack_endpoint.ru
+# 
+# Make requests to: http://localhost:8000/
+# See stats at    : http://localhost:8000/stats
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ruby-metrics')
+@agent = Metrics::Agent.new
+
+counter = @agent.counter(:my_counter)
+
+app = proc do |env|
+  counter.incr
+  [200, {'Content-Type' => 'text/plain'}, ["Counted!"]]
+end
+
+map = Rack::URLMap.new({
+  '/stats'  => Metrics::Integration::Rack::Endpoint.new(:agent => @app),
+  '/'       => app
+})
+
+run map

data/examples/integration/rack_middleware.ru

@@ -0,0 +1,21 @@
+require 'rubygems'
+
+# Ran with:
+# rackup -p 8000 ./examples/integration/rack_middleware.ru
+# 
+# Make requests to: http://localhost:8000/
+# See stats at    : http://localhost:8000/stats
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ruby-metrics')
+@agent = Metrics::Agent.new
+
+counter = @agent.counter(:my_counter)
+
+use Metrics::Integration::Rack::Middleware, :agent => @agent
+
+app = proc do |env|
+  counter.incr
+  [200, {'Content-Type' => 'text/plain'}, ["Counted!"]]
+end
+
+run app

data/examples/integration/webrick.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ruby-metrics'))
+
+# Run with:
+# ruby examples/integration/webrick.rb
+
+@agent = Metrics::Agent.new
+
+counter = @agent.counter(:my_counter)
+counter.incr
+counter.incr
+
+Metrics::Integration::WEBrick.start(:port => 8001,
+                                    :agent => @agent)
+
+sleep
+# Now navigate to: http://localhost:8001/stats

data/examples/meter.rb

@@ -1,9 +1,8 @@
 require 'rubygems'
-require '../lib/ruby-metrics'
+require '../lib/ruby-metrics/integration/webrick'
 
-# Specify a port for the agent
-@metrics = Metrics::Agent.new(8081)
-@metrics.start
+@metrics = Metrics::Agent.new
+@metrics.start :port => 8081 # optional
 
 timer = @metrics.meter :my_meter
 timer.mark(500)
@@ -11,7 +10,7 @@ timer.mark(500)
 step = 0
 
 # This is here so that we will run indefinitely so you can hit the 
-# status page on localhost:8081/status
+# status page on localhost:8081/stats
 loop do
   sleep 1
   

data/examples/timer.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require '../lib/ruby-metrics/integration/webrick'
+
+@metrics = Metrics::Agent.new
+@metrics.start :port => 8081 # optional
+
+timer = @metrics.timer :my_timer
+timer.update(500,   :milliseconds)
+timer.update(5,     :seconds)
+timer.update(4242,  :nanoseconds)
+
+msec_timer = @metrics.timer :msec_timer, {:duration_unit => :microseconds, :rate_unit => :seconds}
+
+step = 0
+
+# This is here so that we will run indefinitely so you can hit the 
+# status page on localhost:8081/stats
+loop do
+  sleep 1
+  
+  modifier = rand(200).to_i
+  step += 1
+  
+  if (step % 2)
+    modifier *= -1
+  end
+  
+  timer.update(500  + modifier, :microseconds)
+  msec_timer.update(500 + modifier, :microseconds)
+
+end

data/lib/ruby-metrics/agent.rb

@@ -1,26 +1,6 @@
 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
+require File.join(File.dirname(__FILE__), 'integration')
 
 module Metrics
   class Agent
@@ -29,28 +9,14 @@ module Metrics
     
     attr_reader :instruments
     
-    def initialize(port = 8001)
+    def initialize
       logger.debug "Initializing Metrics..."
       @instruments = Metrics::Instruments
-      @port = port
     end
     
-    def start
-      start_daemon_thread
+    def to_json
+      @instruments.to_json
     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 => @port})
-          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

@@ -4,27 +4,24 @@ require File.join(File.dirname(__FILE__), 'statistics', 'sample')
 require File.join(File.dirname(__FILE__), 'statistics', 'uniform_sample')
 require File.join(File.dirname(__FILE__), 'statistics', 'exponential_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 File.join(File.dirname(__FILE__), 'instruments', 'timer')
-
-
 require 'json'
 
 module Metrics
   module Instruments
     @instruments = {}
-    
-    @types = {
-      :counter                => Counter,
-      :meter                  => Meter,
-      :gauge                  => Gauge,
-      :exponential_histogram  => ExponentialHistogram,
-      :uniform_histogram      => UniformHistogram
-    }
+    @types = {}
+
+    def self.register_instrument(type, klass)
+      @types[type] = klass
+    end
+
+    def self.registered_instruments
+      @types
+    end
+
+    def self.register_with_options(type, name, options = {})
+      @instruments[name] = @types[type].new(options)
+    end
     
     def self.register(type, name, &block)
       @instruments[name] = @types[type].new(&block)
@@ -48,6 +45,10 @@ module Metrics
         Metrics::Instruments.register(type, name, &block)
       end
       
+      def register_with_options(type, name, options)
+        Metrics::Instruments.register_with_options(type, name, options)
+      end
+      
       def counter(name)
         register(:counter, name)
       end
@@ -60,6 +61,10 @@ module Metrics
         register(:gauge, name, &block)
       end
       
+      def timer(name, options = {})
+        register_with_options(:timer, name, options)
+      end      
+
       def uniform_histogram(name)
         register(:uniform_histogram, name)
       end
@@ -74,3 +79,11 @@ module Metrics
     
   end
 end
+
+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 File.join(File.dirname(__FILE__), 'instruments', 'timer')
+

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

@@ -29,5 +29,7 @@ module Metrics
       end
       
     end
+
+    register_instrument(:counter, Counter)
   end
 end

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

@@ -16,5 +16,7 @@ module Metrics
       end
       
     end
+
+    register_instrument(:gauge, Gauge)
   end
 end

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

@@ -166,13 +166,16 @@ module Metrics
         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

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

@@ -1,6 +1,10 @@
+require File.join(File.dirname(__FILE__), '..', 'time_units')
+
 module Metrics
   module Instruments
     class Meter < Base
+      include Metrics::TimeConversion 
+      
       # From http://www.teamquest.com/pdfs/whitepaper/ldavg2.pdf
       INTERVAL = 5.0
       INTERVAL_IN_NS = 5000000000.0
@@ -39,8 +43,8 @@ module Metrics
       end
       
       def calc_rate(rate, factor, count)
-        rate = rate + (factor * (count - rate))
-        rate
+        rate = rate.to_f + (factor.to_f * (count.to_f - rate.to_f))
+        rate.to_f
       end
       
       def tick
@@ -59,24 +63,24 @@ module Metrics
       end
       
       def one_minute_rate(rate_unit = :seconds)
-        scale_to_ns @one_minute_rate, rate_unit
+        convert_to_ns @one_minute_rate, rate_unit
       end
       
       def five_minute_rate(rate_unit = :seconds)
-        scale_to_ns @five_minute_rate, rate_unit
+        convert_to_ns @five_minute_rate, rate_unit
       end
       
       def fifteen_minute_rate(rate_unit = :seconds)
-        scale_to_ns @fifteen_minute_rate, rate_unit
+        convert_to_ns @fifteen_minute_rate, rate_unit
       end
       
-      def mean_rate(rate_unit = seconds)
+      def mean_rate(rate_unit = :seconds)
         count = @count
         if count == 0
           return 0.0;
         else
           elapsed = Time.now.to_f - @start_time.to_f
-          scale_to_ns (count / elapsed), rate_unit
+          convert_to_ns (count.to_f / elapsed.to_f), rate_unit
         end
       end
       
@@ -88,23 +92,8 @@ module Metrics
         }.to_json
       end
       
-      private
-      def scale_to_ns(value, unit)
-        mult = case unit
-        when :seconds
-          Seconds.to_nsec
-        when :minutes
-          Minutes.to_nsec
-        when :hours
-          Hours.to_nsec
-        when :days
-          Days.to_nsec
-        when :weeks
-          Weeks.to_nsec
-        end
-
-        value * mult
-      end
     end
+
+    register_instrument(:meter, Meter)
   end
 end

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

@@ -7,12 +7,12 @@ module Metrics
       
       attr_reader :duration_unit, :rate_unit
       
-      def initialize(duration_unit = :seconds, rate_unit = :seconds)
+      def initialize(options = {})
         @meter          = Meter.new
         @histogram      = ExponentialHistogram.new
 
-        @duration_unit  = duration_unit
-        @rate_unit      = rate_unit
+        @duration_unit  = options[:duration_unit] || :seconds
+        @rate_unit      = options[:rate_unit] || :seconds
         
         clear
       end
@@ -30,7 +30,8 @@ module Metrics
         start_time = Time.now.to_f
         result = block.call
         time_diff = Time.now.to_f - start_time
-        update_timer(time_diff)
+        time_in_ns = convert_to_ns time_diff, :seconds        
+        update_timer(time_in_ns)
         result
       end
       
@@ -97,12 +98,33 @@ module Metrics
         end
       end
       
+      def to_s
+        {
+          :count => self.count,
+          :rates => {
+            :one_minute_rate => self.one_minute_rate,
+            :five_minute_rate => self.five_minute_rate,
+            :fifteen_minute_rate => self.fifteen_minute_rate, 
+            :unit => @rate_unit
+          },
+          :durations => { 
+            :min => self.min,
+            :max => self.max,
+            :mean => self.mean,
+            :percentiles => self.quantiles([0.25, 0.50, 0.75, 0.95, 0.97, 0.98, 0.99]),
+            :unit => @duration_unit
+          }
+        }.to_json
+      end
+      
       private
       def scale_duration_to_ns(value, unit)
-        value / convert_to_ns(1, unit)
+        value.to_f / convert_to_ns(1, unit).to_f
       end
       
     end
+
+    register_instrument(:timer, Timer)
   end
 end  
       

data/lib/ruby-metrics/integration.rb

@@ -0,0 +1,12 @@
+module Metrics
+  module Integration
+    
+    autoload :WEBrick, File.join(File.dirname(__FILE__), 'integration', 'webrick')
+    
+    module Rack
+      autoload :Middleware, File.join(File.dirname(__FILE__), 'integration', 'rack_middleware')
+      autoload :Endpoint,   File.join(File.dirname(__FILE__), 'integration', 'rack_endpoint')
+    end
+    
+  end
+end

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

@@ -0,0 +1,33 @@
+# Provides:
+# * configurable agent
+# * endpoint for accessing metrics JSON
+# 
+module Metrics
+  module Integration
+    module Rack
+      class Endpoint
+        
+        attr_accessor :app, :options, :agent,
+                      # integration metrics
+                      :requests, :uncaught_exceptions,
+                      :status_codes
+        
+        def initialize(options ={})
+          @options  = options
+          @agent    = @options.delete(:agent) || Agent.new
+        end
+        
+        def call(_)
+          body = @agent.to_json
+          
+          [ 200,
+            { 'Content-Type'    => 'application/json',
+              'Content-Length'  => body.size.to_s },
+            [body]
+          ]
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# Provides:
+# * configurable agent
+# * configurable endpoint for current metrics
+#   * strings == path_info
+#   * regexp =~ path_info
+#   * proc.call(env) #=> boolean
+# * env['metrics.agent'] upstream
+# * specific metrics by default
+#   * requests (timer)
+#   * uncaught_exceptions (counter)
+#   * response_1xx through response_5xx (counter)
+# 
+module Metrics
+  module Integration
+    module Rack
+      class Middleware
+        
+        attr_accessor :app, :options, :agent,
+                      # integration metrics
+                      :requests, :uncaught_exceptions,
+                      :status_codes
+        
+        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]
+        rescue Exception
+          # TODO: add "last_uncaught_exception" with string of error
+          self.uncaught_exceptions.incr
+          raise
+        end
+        
+        def show?(env, test = self.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
+          end
+        end
+        
+        def show(_)
+          body = @agent.to_json
+          
+          [ 200,
+            { 'Content-Type'    => 'application/json',
+              'Content-Length'  => body.size.to_s },
+            [body]
+          ]
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'ruby-metrics')
+
+require 'webrick'
+
+module Metrics
+  
+  class Agent
+    def start(options = {})
+      Integration::WEBrick.start(options.merge(:agent => self))
+    end
+  end
+  
+  module Integration
+    class WEBrick < ::WEBrick::HTTPServlet::AbstractServlet
+      include Logging
+      
+      def self.start(options = {})
+        connection_options = {:Port => options.delete(:port) || options.delete(:Port) || 8001}
+        agent = options.delete(:agent) || Agent.new
+        
+        logger.debug "Creating Metrics daemon thread."
+        @thread = Thread.new do
+          begin
+            server = ::WEBrick::HTTPServer.new(connection_options)
+            server.mount "/stats", self, agent
+            server.start
+          rescue Exception => e
+            logger.error "Error in thread: %s: %s\n\t%s" % [e.class.to_s,
+                                                            e.message,
+                                                            e.backtrace.join("\n\t")]
+          end
+        end
+      end
+      
+      def initialize(server, agent)
+        @agent = agent
+      end
+      
+      def do_GET(request, response)
+        response.status           = 200
+        response['Content-Type']  = 'application/json'
+        response.body             = @agent.to_json
+      end
+      
+    end
+  end
+end

data/lib/ruby-metrics/version.rb

@@ -1,3 +1,3 @@
 module Metrics
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/ruby-metrics.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "simplecov", [">= 0.3.8"] #, :require => false
+  s.add_development_dependency "rack-test"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/agent_spec.rb

@@ -45,16 +45,4 @@ describe Metrics::Agent do
     @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
+end

data/spec/instruments/timer_spec.rb

@@ -9,7 +9,7 @@ describe Metrics::Instruments::Timer do
   
   context "An empty timer" do
     before(:each) do 
-      @timer = Metrics::Instruments::Timer.new()
+      @timer = Metrics::Instruments::Timer.new
     end
     
     it "should have a max of zero" do
@@ -56,7 +56,7 @@ describe Metrics::Instruments::Timer do
   
   context "Timing some events" do
     before(:each) do
-      @timer = Metrics::Instruments::Timer.new(:milliseconds, :seconds)
+      @timer = Metrics::Instruments::Timer.new({:duration_unit => :milliseconds, :rate_unit => :seconds})
       @timer.update(10, :milliseconds)
       @timer.update(20, :milliseconds)
       @timer.update(20, :milliseconds)
@@ -91,23 +91,27 @@ describe Metrics::Instruments::Timer do
     it "should contain the series added" do
       @timer.values.sort.should == [10, 20, 20, 30, 40]
     end
+    
+    it "should accurately represent itself using JSON" do
+      @timer.to_s.should == "{\"count\":5,\"rates\":{\"one_minute_rate\":0.0,\"five_minute_rate\":0.0,\"fifteen_minute_rate\":0.0,\"unit\":\"seconds\"},\"durations\":{\"min\":10.0,\"max\":40.0,\"mean\":24.0,\"percentiles\":{\"0.25\":20.0,\"0.5\":20.0,\"0.75\":30.0,\"0.95\":38.0,\"0.97\":38.8,\"0.98\":39.2,\"0.99\":39.6},\"unit\":\"milliseconds\"}}"
+    end
   end
   
   context "Timing blocks of code" do
     before(:each) do
-      @timer = Metrics::Instruments::Timer.new(:nanoseconds, :nanoseconds)
+      @timer = Metrics::Instruments::Timer.new({:duration_unit => :nanoseconds, :rate_unit => :nanoseconds})
     end
     
     it "should return the result of the block passed" do       
       result = @timer.time do 
-        sleep(5)
+        sleep(0.25)
         "narf"
       end
 
       result.should == "narf"
       
-      @timer.max.should >= 5.0
-      @timer.max.should <= 6.0
+      @timer.max.should >= 250000000
+      @timer.max.should <= 300000000
 
     end
   end

data/spec/instruments_spec.rb

@@ -58,5 +58,19 @@ describe Metrics::Instruments do
     proc = Proc.new { "result" }
     @instruments.register :gauge, :test_gauge, &proc
   end
-    
+
+  context '#register_instrument' do
+    it 'registers a new instrument' do
+      lambda { Metrics::Instruments.register_instrument(:test, String) }.should_not raise_error
+    end
+
+    it 'returns the list of registered instruments' do
+      Metrics::Instruments.register_instrument(:str, String)
+      Metrics::Instruments.register_instrument(:int, Fixnum)
+
+      inst = Metrics::Instruments.registered_instruments
+      inst[:str].should == String
+      inst[:int].should == Fixnum
+    end
+  end
 end

data/spec/integration/rack_endpoint_spec.rb

@@ -0,0 +1,60 @@
+require "rack/test"
+
+describe Metrics::Integration::Rack::Endpoint do
+  include Rack::Test::Methods
+  
+  def app(options = {})
+    @app ||= Metrics::Integration::Rack::Endpoint.new(options)
+  end
+  def agent
+    app.agent
+  end
+  
+  it "should show stats" do
+    get "/"
+    last_response.should be_ok
+    last_response.body.should == agent.to_json
+  end
+  
+  context "configuring" do
+    
+    context "agent" do
+      it "should create an agent by default" do
+        app(:agent => nil)
+        agent.should be_a(Metrics::Agent)
+      end
+      
+      it "should use an agent if provided" do
+        @agent = Metrics::Agent.new
+        app(:agent => @agent)
+        agent.should be_a(Metrics::Agent)
+        agent.should == @agent
+      end
+    end
+    
+    context "show" do
+      it "should match a string to the PATH_INFO exactly" do
+        app(:show => "/foo")
+        get '/foo'
+        last_response.should be_ok
+        last_response.body.should == agent.to_json
+      end
+      
+      it "should match a regular expression to the PATH_INFO" do
+        app(:show => /bar/)
+        get '/foobarbaz'
+        last_response.should be_ok
+        last_response.body.should == agent.to_json
+      end
+      
+      it "should call `call` on the show option if it responds to it" do
+        app(:show => lambda{ |env| env['PATH_INFO'] == "/bing" })
+        get '/bing'
+        last_response.should be_ok
+        last_response.body.should == agent.to_json
+      end
+    end
+    
+  end
+  
+end

data/spec/integration/rack_middleware_spec.rb

@@ -0,0 +1,129 @@
+require "rack/test"
+
+describe Metrics::Integration::Rack::Middleware do
+  include Rack::Test::Methods
+  
+  def app(status = 200, body = ["Hello, World!"], headers = {})
+    @app ||= lambda{ |env| [status, {'Content-Type' => 'text/plain', 'Content-Length' => body.to_s.size.to_s}.merge(headers), body] }
+  end
+  alias_method :original_app, :app
+  
+  describe "without integration" do
+    it "should work normally" do
+      get "/"
+      
+      last_response.should be_ok
+      last_response.body.should == "Hello, World!"
+    end
+  end
+  
+  describe "with integration" do
+    def app(options = {})
+      @integrated_app ||= Metrics::Integration::Rack::Middleware.new(original_app, options)
+    end
+    def agent
+      app.agent
+    end
+    
+    it "should work normally" do
+      get "/"
+      
+      last_response.should be_ok
+      last_response.body.should == "Hello, World!"
+    end
+    
+    it "should show stats for default endpoint" do
+      get "/stats"
+      last_response.should be_ok
+      last_response.body.should == agent.to_json
+    end
+    
+    it "should make 'metrics.agent' available to the upstream environment" do
+      @app = lambda do |env|
+        env['metrics.agent'].should be_a(Metrics::Agent)
+        env['metrics.agent'].should == agent
+        [200, {}, []]
+      end
+      
+      get '/'
+      last_response.should be_ok
+    end
+    
+    describe "integration metrics" do
+      
+      it "should count all requests" do
+        lambda do
+          get '/'
+        end.should change{ app.requests.count }.by(1)
+      end
+      
+      it "should count uncaught exceptions" do
+        @app = lambda{ |env| raise }
+        lambda do
+          lambda do
+            get '/'
+          end.should raise_error
+        end.should change{ app.uncaught_exceptions.to_i }.by(1)
+      end
+      
+      it "should time request length" do
+        length = 0.1
+        @app = lambda{ |env| sleep(length); [200, {}, ['']] }
+        get '/'
+        app.requests.mean.should be_within(length / 10).of(length)
+      end
+      
+      [ 200, 304, 404, 500].each do |status|
+        it "should count #{status} HTTP status code as #{status / 100}xx" do
+          @app = lambda{ |env| [status, {}, []] }
+          lambda do
+            get '/'
+          end.should change{ app.status_codes[status / 100].to_i }.by(1)
+        end
+      end
+      
+    end
+    
+    context "configuring" do
+      
+      context "agent" do
+        it "should create an agent by default" do
+          app(:agent => nil)
+          agent.should be_a(Metrics::Agent)
+        end
+        
+        it "should use an agent if provided" do
+          @agent = Metrics::Agent.new
+          app(:agent => @agent)
+          agent.should be_a(Metrics::Agent)
+          agent.should == @agent
+        end
+      end
+      
+      context "show" do
+        it "should match a string to the PATH_INFO exactly" do
+          app(:show => "/foo")
+          get '/foo'
+          last_response.should be_ok
+          last_response.body.should == agent.to_json
+        end
+        
+        it "should match a regular expression to the PATH_INFO" do
+          app(:show => /bar/)
+          get '/foobarbaz'
+          last_response.should be_ok
+          last_response.body.should == agent.to_json
+        end
+        
+        it "should call `call` on the show option if it responds to it" do
+          app(:show => lambda{ |env| env['PATH_INFO'] == "/bing" })
+          get '/bing'
+          last_response.should be_ok
+          last_response.body.should == agent.to_json
+        end
+      end
+      
+    end
+  end
+  
+end

data/spec/integration/webrick_spec.rb

@@ -0,0 +1,18 @@
+require "rack/test"
+
+describe Metrics::Integration::WEBrick do
+  
+  it "should start the WEBrick thread" 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)
+    
+    Metrics::Integration::WEBrick.start
+  end
+  
+end

data/spec/spec_helper.rb

@@ -10,6 +10,9 @@ end
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ruby-metrics'
 
+Metrics.logger = Logger.new(STDERR)
+Metrics.logger.level = Logger::INFO
+
 RSpec.configure do |config|
   config.mock_with :rspec
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - John Ewart
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 -07:00
+date: 2011-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,19 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 description: A Ruby implementation of metrics inspired by @coda's JVM metrics for those of us in Ruby land
 email: 
 - john@johnewart.net
@@ -92,7 +105,11 @@ files:
 - examples/counter.rb
 - examples/gauge.rb
 - examples/histogram.rb
+- examples/integration/rack_endpoint.ru
+- examples/integration/rack_middleware.ru
+- examples/integration/webrick.rb
 - examples/meter.rb
+- examples/timer.rb
 - lib/ruby-metrics.rb
 - lib/ruby-metrics/agent.rb
 - lib/ruby-metrics/instruments.rb
@@ -102,6 +119,10 @@ files:
 - lib/ruby-metrics/instruments/histogram.rb
 - lib/ruby-metrics/instruments/meter.rb
 - lib/ruby-metrics/instruments/timer.rb
+- lib/ruby-metrics/integration.rb
+- lib/ruby-metrics/integration/rack_endpoint.rb
+- lib/ruby-metrics/integration/rack_middleware.rb
+- lib/ruby-metrics/integration/webrick.rb
 - lib/ruby-metrics/logging.rb
 - lib/ruby-metrics/statistics/exponential_sample.rb
 - lib/ruby-metrics/statistics/sample.rb
@@ -117,6 +138,9 @@ files:
 - spec/instruments/meter_spec.rb
 - spec/instruments/timer_spec.rb
 - spec/instruments_spec.rb
+- spec/integration/rack_endpoint_spec.rb
+- spec/integration/rack_middleware_spec.rb
+- spec/integration/webrick_spec.rb
 - spec/spec_helper.rb
 - spec/statistics/exponential_sample_spec.rb
 - spec/statistics/sample_spec.rb
@@ -136,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -24047821763014180
+      hash: 4032034234176091931
       segments: 
       - 0
       version: "0"
@@ -145,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -24047821763014180
+      hash: 4032034234176091931
       segments: 
       - 0
       version: "0"
@@ -165,6 +189,9 @@ test_files:
 - spec/instruments/meter_spec.rb
 - spec/instruments/timer_spec.rb
 - spec/instruments_spec.rb
+- spec/integration/rack_endpoint_spec.rb
+- spec/integration/rack_middleware_spec.rb
+- spec/integration/webrick_spec.rb
 - spec/spec_helper.rb
 - spec/statistics/exponential_sample_spec.rb
 - spec/statistics/sample_spec.rb