statsd-instrument 1.0.1 → 1.1.0

data/README.md

@@ -20,6 +20,7 @@ This is the same as what Etsy uses (mentioned in the README for http://github.co
 StatsD.server = 'statsd.myservice.com:8125'
 StatsD.logger = Rails.logger
 StatsD.mode = :production
+StatsD.default_sample_rate = 0.1 # Sample 10% of events. By default all events are reported.
 ```
 
 If you set the mode to anything besides production then the library will print its calls to the logger, rather than sending them over the wire.
@@ -123,3 +124,11 @@ GoogleBase.statsd_count_success :insert, 'GoogleBase.insert' do |response|
 end
 ```
 
+### Instrumenting Class Methods
+
+You can instrument class methods, just like instance methods, using the metaprogramming methods. You simply have to configure the instrumentation on the singleton class of the Class you want to instrument.
+
+```ruby
+AWS::S3::Base.singleton_class.extend StatsD::Instrument
+AWS::S3::Base.singleton_class.statsd_measure :request, 'S3.request'
+```

data/lib/statsd/instrument.rb

@@ -1,11 +1,13 @@
 require 'socket'
+require 'benchmark'
 
 module StatsD
   class << self
-    attr_accessor :host, :port, :mode, :logger, :enabled
+    attr_accessor :host, :port, :mode, :logger, :enabled, :default_sample_rate
   end
   self.enabled = true
-
+  self.default_sample_rate = 1
+  
   # StatsD.server = 'localhost:1234'
   def self.server=(conn)
     self.host, port = conn.split(':')
@@ -88,16 +90,16 @@ module StatsD
   # glork:320|ms
   def self.measure(key, milli = nil)
     result = nil
-    ms = Benchmark.ms do
+    ms = milli || Benchmark.ms do
       result = yield 
-    end if milli.nil?
+    end
 
     write(key, ms, :ms)
     result
   end
 
   # gorets:1|c
-  def self.increment(key, delta = 1, sample_rate = 1)
+  def self.increment(key, delta = 1, sample_rate = default_sample_rate)
     write(key, delta, :incr, sample_rate)
   end
 
@@ -107,7 +109,7 @@ module StatsD
     @socket ||= UDPSocket.new
   end
 
-  def self.write(k,v,op, sample_rate = 1)
+  def self.write(k,v,op, sample_rate = default_sample_rate)
     return unless enabled
     return if sample_rate < 1 && rand > sample_rate
 

data/statsd-instrument.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "statsd-instrument"
-  s.version     = '1.0.1'
+  s.version     = '1.1.0'
   s.authors     = ["Jesse Storimer"]
   s.email       = ["jesse@shopify.com"]
   s.homepage    = "http://github.com/shopify/statsd-instrument"

data/test/statsd-instrument_test.rb

@@ -147,4 +147,10 @@ class StatsDTest < Test::Unit::TestCase
     StatsD.increment('fooz')
     StatsD.enabled = true
   end
+  
+  def test_statsd_measure_with_explicit_value
+    StatsD.expects(:write).with('values.foobar', 42, :ms)
+
+    StatsD.measure('values.foobar', 42)
+  end
 end

metadata

@@ -1,47 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: statsd-instrument
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Jesse Storimer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-15 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mocha
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156605620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject StatsD instrumentation into your code.
-email: 
+  prerelease: false
+  version_requirements: *2156605620
+description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
+  StatsD instrumentation into your code.
+email:
 - jesse@shopify.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -51,39 +39,30 @@ files:
 - lib/statsd/instrument.rb
 - statsd-instrument.gemspec
 - test/statsd-instrument_test.rb
-has_rdoc: true
 homepage: http://github.com/shopify/statsd-instrument
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A StatsD client for Ruby apps
-test_files: 
+test_files:
 - test/statsd-instrument_test.rb
+has_rdoc: