yam-ruby-metrics 0.8.6

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

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

data/.rvmrc

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

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

@@ -0,0 +1,8 @@
+source :rubygems
+
+# Specify your gem's dependencies in ruby-metrics.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    ruby-metrics (0.8.6)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    json (1.5.1)
+    rack (1.2.2)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rake (0.8.7)
+    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)
+    simplecov (0.4.0)
+      simplecov-html (~> 0.4.0)
+    simplecov-html (0.4.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test
+  rake
+  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,86 @@
+
+## 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
+* 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
+
+    counter = @metrics.counter :my_counter
+    counter.incr
+    counter.incr
+
+    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)
+```
+
+or
+
+``` ruby
+# in config/router.rb
+mount Metrics::Integration::Rack::Endpoint.new(:agent => @agent)
+```
+
+[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,10 @@
+require 'rubygems'
+require '../lib/ruby-metrics'
+
+@metrics = Metrics::Agent.new
+
+counter = @metrics.counter :my_counter
+counter.incr
+counter.incr
+
+puts "Counter: #{counter.to_i}"

data/examples/gauge.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require '../lib/ruby-metrics'
+
+@metrics = Metrics::Agent.new
+
+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,32 @@
+require 'rubygems'
+require '../lib/ruby-metrics/integration/webrick'
+
+@metrics = Metrics::Agent.new
+@metrics.start
+
+exponential_histogram = @metrics.exponential_histogram :exponential_histogram
+uniform_histogram = @metrics.uniform_histogram :uniform_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|
+  exponential_histogram.update(point.to_f)
+  uniform_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/stats
+loop do
+  sleep 1
+  
+  modifier = rand(500).to_i / 100
+  step += 1
+  
+  if (step % 2)
+    modifier *= -1
+  end
+  
+  uniform_histogram.update((2  + modifier).to_f)
+  exponential_histogram.update((2 + modifier).to_f)
+end

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

@@ -0,0 +1,25 @@
+require 'rubygems'
+require '../lib/ruby-metrics/integration/webrick'
+
+@metrics = Metrics::Agent.new
+@metrics.start :port => 8081 # optional
+
+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:8081/stats
+loop do
+  sleep 1
+  
+  modifier = rand(200).to_i
+  step += 1
+  
+  if (step % 2)
+    modifier *= -1
+  end
+  
+  timer.mark(500  + modifier)
+end

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