metrics-instrument 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in metrics-instrument.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ragnarson Sp. z o.o.
+
+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,40 @@
+# Metrics client for Ruby apps
+
+Adaptation of [statsd-instrument](https://github.com/Shopify/statsd-instrument/blob/master/README.md) for the (yet unreleased) metrics server.
+
+## Configuration
+```ruby
+Metrics.server = 'statsd.myservice.com:8125'
+Metrics.logger = Rails.logger
+Metrics.mode = :production
+Metrics.default_sample_rate = 0.1 # Sample 10% of events. By default all events are reported.
+```
+
+## Usage
+### Metrics.measure
+```ruby
+# You can pass a key and a ms value
+Metrics.measure('GoogleBase.insert', 2.55)
+
+# or more commonly pass a block that calls your code
+Metrics.measure('GoogleBase.insert') do
+  GoogleBase.insert(product)
+end
+```
+
+or with metaprogramming:
+
+```ruby
+GoogleBase.extend Metrics::Instrument
+GoogleBase.metrics_measure :insert, 'GoogleBase.insert'
+```
+
+### Metaprogramming methods
+
+* `metrics_count` adds '1' to the metric
+* `metrics_count_if` adds '1' to the metric if method returned something
+  that evaulates to true. Takes optional block to evaluate the returned
+value.
+* `metrics_count_success` adds '1' to `metric.success` for successful
+  calls and `metrics.failure` for failed calls.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/metrics-instrument.rb

@@ -0,0 +1 @@
+require "metrics/instrument"

data/lib/metrics-instrument/version.rb

@@ -0,0 +1,5 @@
+module Metrics
+  module Instrument
+    VERSION = "0.0.1"
+  end
+end

data/lib/metrics/instrument.rb

@@ -0,0 +1,138 @@
+require 'socket'
+require 'benchmark'
+require 'logger'
+require 'timeout'
+
+class << Benchmark
+  def ms
+    1000 * realtime { yield }
+  end
+end
+
+module Metrics
+  class << self
+    attr_accessor :host, :port, :mode, :logger, :enabled, :default_sample_rate
+  end
+
+  self.enabled = true
+  self.default_sample_rate = 1
+  self.logger = Logger.new($stdout)
+
+  Timeout = defined?(::SystemTimer) ? ::SystemTimer : ::Timeout
+
+  def self.server=(conn)
+    self.host, port = conn.split(':')
+    self.port = port.to_i
+  end
+
+  module Instrument
+    def metrics_measure(method, name)
+      add_to_method(method, name, :measure) do |old_method, new_method, metric_name, *args|
+        define_method(new_method) do |*args|
+          Metrics.measure(metric_name) { send(old_method, *args) }
+        end
+      end
+    end
+
+    def metrics_count_success(method, name)
+      add_to_method(method, name, :count_success) do |old_method, new_method, metric_name|
+        define_method(new_method) do |*args|
+          begin
+            truthiness = result = send(old_method, *args)
+          rescue
+            truthiness = false
+            raise
+          else
+            truthiness = (yield(result) rescue false) if block_given?
+            result
+          ensure
+            Metrics.increment("#{metric_name}." + (truthiness == false ? 'failure' : 'success'))
+          end
+        end
+      end
+    end
+
+    def metrics_count_if(method, name)
+      add_to_method(method, name, :count_if) do |old_method, new_method, metric_name|
+        define_method(new_method) do |*args|
+          begin
+            truthiness = result = send(old_method, *args)
+          rescue
+            truthiness = false
+            raise
+          else
+            truthiness = (yield(result) rescue false) if block_given?
+            result
+          ensure
+            Metrics.increment(metric_name) if truthiness
+          end
+        end
+      end
+    end
+
+    def metrics_count(method, name)
+      add_to_method(method, name, :count) do |old_method, new_method, metric_name|
+        define_method(new_method) do |*args|
+          Metrics.increment(metric_name)
+          send(old_method, *args)
+        end
+      end
+    end
+
+    private
+    def add_to_method(method, name, action, &block)
+      metric_name = name
+
+      method_name_without_metrics = :"#{method}_for_#{action}_on_#{self.name}_without_#{name}"
+      # raw_ssl_request_for_measure_on_FedEx_without_ActiveMerchant.Shipping.#{self.class.name}.ssl_request
+
+      method_name_with_metrics = :"#{method}_for_#{action}_on_#{self.name}_with_#{name}"
+      # raw_ssl_request_for_measure_on_FedEx_with_ActiveMerchant.Shipping.#{self.class.name}.ssl_request
+
+      raise ArgumentError, "already instrumented #{method} for #{self.name}" if method_defined? method_name_without_metrics
+      raise ArgumentError, "could not find method #{method} for #{self.name}" unless method_defined?(method) || private_method_defined?(method)
+
+      alias_method method_name_without_metrics, method
+      yield method_name_without_metrics, method_name_with_metrics, metric_name
+      alias_method method, method_name_with_metrics
+    end
+  end
+
+  def self.measure(key, milli = nil)
+    result = nil
+    ms = milli || Benchmark.ms do
+      result = yield
+    end
+
+    write(key, ms)
+    result
+  end
+
+  def self.increment(key, delta = 1, sample_rate = default_sample_rate)
+    write(key, delta, sample_rate)
+  end
+
+  private
+  def self.socket
+    @socket ||= UDPSocket.new
+  end
+
+  def self.write(k, v, sample_rate = default_sample_rate)
+    return unless enabled
+    return if sample_rate < 1 && rand > sample_rate
+
+    msg = "#{k} #{v}"
+
+    if mode == :production
+      socket_wrapper { socket.send(msg, 0, host, port) }
+    else
+      logger.info "[Metrics] #{msg}"
+    end
+  end
+
+  def self.socket_wrapper(options = {})
+    Timeout.timeout(options.fetch(:timeout, 0.1)) { yield }
+  rescue Timeout::Error, SocketError, IOError, SystemCallError => e
+    logger.error e
+  end
+end

data/metrics-instrument.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "metrics-instrument/version"
+
+Gem::Specification.new do |s|
+  s.name        = "metrics-instrument"
+  s.version     = Metrics::Instrument::VERSION
+  s.authors     = ["Grzesiek Kolodziejczyk"]
+  s.email       = ["grk@ragnarson.com"]
+  s.homepage    = "https://github.com/Ragnarson/metrics-instrument"
+  s.summary     = %q{A Metrics client for Ruby apps}
+  s.description = %q{A Metrics client for Ruby apps. Provides metaprogramming methods to inject Metrics instrumentation into your code.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'rake'
+  #s.add_development_dependency 'minitest-reporters'
+end

data/test/metrics-instrument_test.rb

@@ -0,0 +1,197 @@
+require 'metrics-instrument'
+require 'test/unit'
+require 'mocha'
+require 'logger'
+
+Metrics.logger = Logger.new('/dev/null')
+
+module ActiveMerchant; end
+class ActiveMerchant::Base
+  def ssl_post(arg)
+    if arg
+      'OK'
+    else
+      raise 'Not OK'
+    end
+  end
+end
+
+class ActiveMerchant::Gateway < ActiveMerchant::Base
+  def purchase(arg)
+    ssl_post(arg)
+    true
+  rescue
+    false
+  end
+
+  def self.sync
+    true
+  end
+
+  def self.singleton_class
+    class << self; self; end
+  end
+end
+
+class ActiveMerchant::UniqueGateway < ActiveMerchant::Base
+  def ssl_post(arg)
+    {:success => arg}
+  end
+
+  def purchase(arg)
+    ssl_post(arg)
+  end
+end
+
+ActiveMerchant::Base.extend Metrics::Instrument
+
+class MetricsTest < Test::Unit::TestCase
+  def setup
+    Metrics.stubs(:increment)
+  end
+
+  def test_metrics_count_if
+    ActiveMerchant::Gateway.metrics_count_if :ssl_post, 'ActiveMerchant.Gateway.if'
+
+    Metrics.expects(:increment).with(includes('if')).once
+    ActiveMerchant::Gateway.new.purchase(true)
+    ActiveMerchant::Gateway.new.purchase(false)
+  end
+
+  def test_metrics_count_if_with_block
+    ActiveMerchant::UniqueGateway.metrics_count_if :ssl_post, 'ActiveMerchant.Gateway.block' do |result|
+      result[:success]
+    end
+
+    Metrics.expects(:increment).with(includes('block')).once
+    ActiveMerchant::UniqueGateway.new.purchase(true)
+    ActiveMerchant::UniqueGateway.new.purchase(false)
+  end
+
+  def test_metrics_count_success
+    ActiveMerchant::Gateway.metrics_count_success :ssl_post, 'ActiveMerchant.Gateway'
+
+    Metrics.expects(:increment).with(includes('success'))
+    ActiveMerchant::Gateway.new.purchase(true)
+
+    Metrics.expects(:increment).with(includes('failure'))
+    ActiveMerchant::Gateway.new.purchase(false)
+  end
+
+  def test_metrics_count_success_with_block
+    ActiveMerchant::UniqueGateway.metrics_count_success :ssl_post, 'ActiveMerchant.Gateway' do |result|
+      result[:success]
+    end
+
+    Metrics.expects(:increment).with(includes('success'))
+    ActiveMerchant::UniqueGateway.new.purchase(true)
+
+    Metrics.expects(:increment).with(includes('failure'))
+    ActiveMerchant::UniqueGateway.new.purchase(false)
+  end
+
+  def test_metrics_count
+    ActiveMerchant::Gateway.metrics_count :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+
+    Metrics.expects(:increment).with(includes('ssl_post'))
+    ActiveMerchant::Gateway.new.purchase(true)
+  end
+
+  def test_metrics_measure
+    ActiveMerchant::UniqueGateway.metrics_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+
+    Metrics.expects(:write).with('ActiveMerchant.Gateway.ssl_post', is_a(Float)).returns({:success => true})
+    ActiveMerchant::UniqueGateway.new.purchase(true)
+  end
+
+  def test_instrumenting_class_method
+    ActiveMerchant::Gateway.singleton_class.extend Metrics::Instrument
+    ActiveMerchant::Gateway.singleton_class.metrics_count :sync, 'ActiveMerchant.Gateway.sync'
+
+    Metrics.expects(:increment).with(includes('sync'))
+    ActiveMerchant::Gateway.sync
+  end
+
+  def test_count_with_sampling
+    Metrics.unstub(:increment)
+    Metrics.stubs(:rand).returns(0.6)
+    Metrics.logger.expects(:info).never
+
+    Metrics.increment('sampling.foo.bar', 1, 0.1)
+  end
+
+  def test_count_with_successful_sample
+    Metrics.unstub(:increment)
+    Metrics.stubs(:rand).returns(0.01)
+    Metrics.logger.expects(:info).once.with do |string|
+      string.include?('1')
+    end
+
+    Metrics.increment('sampling.foo.bar', 1, 0.1)
+  end
+
+  def test_production_mode_should_use_udp_socket
+    Metrics.unstub(:increment)
+
+    Metrics.mode = :production
+    Metrics.server = 'localhost:123'
+    UDPSocket.any_instance.expects(:send)
+
+    Metrics.increment('fooz')
+    Metrics.mode = :test
+  end
+
+  def test_should_not_write_when_disabled
+    Metrics.enabled = false
+    Metrics.expects(:logger).never
+    Metrics.increment('fooz')
+    Metrics.enabled = true
+  end
+
+  def test_metrics_measure_with_explicit_value
+    Metrics.expects(:write).with('values.foobar', 42)
+
+    Metrics.measure('values.foobar', 42)
+  end
+
+  def test_socket_error_should_not_raise
+    Metrics.mode = :production
+    UDPSocket.any_instance.expects(:send).raises(SocketError)
+    Metrics.measure('values.foobar', 42)
+    Metrics.mode = :test
+  end
+
+  def test_timeout_error_should_not_raise
+    Metrics.mode = :production
+    UDPSocket.any_instance.expects(:send).raises(Timeout::Error)
+    Metrics.measure('values.foobar', 42)
+    Metrics.mode = :test
+  end
+
+  def test_system_call_error_should_not_raise
+    Metrics.mode = :production
+    UDPSocket.any_instance.expects(:send).raises(Errno::ETIMEDOUT)
+    Metrics.measure('values.foobar', 42)
+    Metrics.mode = :test
+  end
+
+  def test_io_error_should_not_raise
+    Metrics.mode = :production
+    UDPSocket.any_instance.expects(:send).raises(IOError)
+    Metrics.measure('values.foobar', 42)
+    Metrics.mode = :test
+  end
+
+  def test_long_request_should_timeout
+    Metrics.mode = :production
+    UDPSocket.any_instance.expects(:send).yields do
+      begin
+        Timeout.timeout(0.5) { sleep 1 }
+      rescue Timeout::Error
+        raise "Allowed long running request"
+      end
+    end
+    Metrics.measure('values.foobar', 42)
+    Metrics.mode = :test
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: metrics-instrument
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Grzesiek Kolodziejczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70134701481200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70134701481200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70134701480780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70134701480780
+description: A Metrics client for Ruby apps. Provides metaprogramming methods to inject
+  Metrics instrumentation into your code.
+email:
+- grk@ragnarson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/metrics-instrument.rb
+- lib/metrics-instrument/version.rb
+- lib/metrics/instrument.rb
+- metrics-instrument.gemspec
+- test/metrics-instrument_test.rb
+homepage: https://github.com/Ragnarson/metrics-instrument
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3448421278235268376
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3448421278235268376
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: A Metrics client for Ruby apps
+test_files:
+- test/metrics-instrument_test.rb