statsd-instrument 1.2.0 → 1.3.0

data/README.md

@@ -1,6 +1,6 @@
 # StatsD client for Ruby apps
 
-![Built on Travis](https://secure.travis-ci.org/Shopify/statsd-instrument.png?branch=master)
+[![Built on Travis](https://secure.travis-ci.org/Shopify/statsd-instrument.png?branch=master)](https://secure.travis-ci.org/Shopify/statsd-instrument)
 
 This is a ruby client for statsd (http://github.com/etsy/statsd). It provides a lightweight way to track and measure metrics in your application. 
 

data/lib/statsd/instrument.rb

@@ -12,11 +12,12 @@ end
 module StatsD
   class << self
     attr_accessor :host, :port, :mode, :logger, :enabled, :default_sample_rate,
-                  :prefix
+                  :prefix, :implementation
   end
   self.enabled = true
   self.default_sample_rate = 1
-  
+  self.implementation = :statsd
+
   TimeoutClass = defined?(::SystemTimer) ? ::SystemTimer : ::Timeout
 
   # StatsD.server = 'localhost:1234'
@@ -28,17 +29,17 @@ module StatsD
   module Instrument
     def statsd_measure(method, name)
       add_to_method(method, name, :measure) do |old_method, new_method, metric_name, *args|
-        define_method(new_method) do |*args|
-          StatsD.measure(metric_name) { send(old_method, *args) }
+        define_method(new_method) do |*args, &block|
+          StatsD.measure(metric_name) { send(old_method, *args, &block) }
         end
       end
     end
 
     def statsd_count_success(method, name)
       add_to_method(method, name, :count_success) do |old_method, new_method, metric_name|
-        define_method(new_method) do |*args|
+        define_method(new_method) do |*args, &block|
           begin
-            truthiness = result = send(old_method, *args)
+            truthiness = result = send(old_method, *args, &block)
           rescue
             truthiness = false
             raise
@@ -54,9 +55,9 @@ module StatsD
 
     def statsd_count_if(method, name)
       add_to_method(method, name, :count_if) do |old_method, new_method, metric_name|
-        define_method(new_method) do |*args|
+        define_method(new_method) do |*args, &block|
           begin
-            truthiness = result = send(old_method, *args)
+            truthiness = result = send(old_method, *args, &block)
           rescue
             truthiness = false
             raise
@@ -72,9 +73,9 @@ module StatsD
 
     def statsd_count(method, name)
       add_to_method(method, name, :count) do |old_method, new_method, metric_name|
-        define_method(new_method) do |*args|
+        define_method(new_method) do |*args, &block|
           StatsD.increment(metric_name)
-          send(old_method, *args)
+          send(old_method, *args, &block)
         end
       end
     end
@@ -102,7 +103,7 @@ module StatsD
   def self.measure(key, milli = nil)
     result = nil
     ms = milli || Benchmark.ms do
-      result = yield 
+      result = yield
     end
 
     write(key, ms, :ms)
@@ -114,9 +115,10 @@ module StatsD
     write(key, delta, :incr, sample_rate)
   end
 
-  #gaugor:333|g
-  def self.gauge(key, value, sample_rate = default_sample_rate)
-    write(key, value, :g, sample_rate)
+  # gaugor:333|g
+  # guagor:1234|kv|@1339864935 (statsite)
+  def self.gauge(key, value, sample_rate_or_epoch = default_sample_rate)
+    write(key, value, :g, sample_rate_or_epoch)
   end
 
   private
@@ -136,10 +138,11 @@ module StatsD
     when :ms
       command << '|ms'
     when :g
-      command << '|g'
+      command << (self.implementation == :statsite ? '|kv' : '|g')
     end
 
-    command << "|@#{sample_rate}" if sample_rate < 1
+    command << "|@#{sample_rate}" if sample_rate < 1 || (self.implementation == :statsite && sample_rate > 1)
+    command << "\n" if self.implementation == :statsite
 
     if mode.to_s == 'production'
       socket_wrapper { socket.send(command, 0, host, port) }

data/statsd-instrument.gemspec

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

data/test/statsd-instrument_test.rb

@@ -20,6 +20,10 @@ class ActiveMerchant::Base
       raise 'Not OK'
     end
   end
+
+  def post_with_block(&block)
+    yield if block_given?
+  end
 end
 
 class ActiveMerchant::Gateway < ActiveMerchant::Base
@@ -32,7 +36,7 @@ class ActiveMerchant::Gateway < ActiveMerchant::Base
 
   def self.sync
     true
-  end 
+  end
 
   def self.singleton_class
     class << self; self; end
@@ -65,6 +69,16 @@ class StatsDTest < Test::Unit::TestCase
     ActiveMerchant::Gateway.new.purchase(false)
   end
 
+  def test_statsd_count_if_with_method_receiving_block
+    ActiveMerchant::Base.statsd_count_if :post_with_block, 'ActiveMerchant.Base.post_with_block' do |result|
+      result[:success]
+    end
+
+    return_value = ActiveMerchant::Base.new.post_with_block {'block called'}
+
+    assert_equal 'block called', return_value
+  end
+
   def test_statsd_count_if_with_block
     ActiveMerchant::UniqueGateway.statsd_count_if :ssl_post, 'ActiveMerchant.Gateway.block' do |result|
       result[:success]
@@ -85,6 +99,16 @@ class StatsDTest < Test::Unit::TestCase
     ActiveMerchant::Gateway.new.purchase(false)
   end
 
+  def test_statsd_count_success_with_method_receiving_block
+    ActiveMerchant::Base.statsd_count_success :post_with_block, 'ActiveMerchant.Base.post_with_block' do |result|
+      result[:success]
+    end
+
+    return_value = ActiveMerchant::Base.new.post_with_block {'block called'}
+
+    assert_equal 'block called', return_value
+  end
+
   def test_statsd_count_success_with_block
     ActiveMerchant::UniqueGateway.statsd_count_success :ssl_post, 'ActiveMerchant.Gateway' do |result|
       result[:success]
@@ -104,6 +128,14 @@ class StatsDTest < Test::Unit::TestCase
     ActiveMerchant::Gateway.new.purchase(true)
   end
 
+  def test_statsd_count_with_method_receiving_block
+    ActiveMerchant::Base.statsd_count :post_with_block, 'ActiveMerchant.Base.post_with_block'
+
+    return_value = ActiveMerchant::Base.new.post_with_block {'block called'}
+
+    assert_equal 'block called', return_value
+  end
+
   def test_statsd_measure
     ActiveMerchant::UniqueGateway.statsd_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
 
@@ -111,6 +143,14 @@ class StatsDTest < Test::Unit::TestCase
     ActiveMerchant::UniqueGateway.new.purchase(true)
   end
 
+  def test_statsd_measure_with_method_receiving_block
+    ActiveMerchant::Base.statsd_measure :post_with_block, 'ActiveMerchant.Base.post_with_block'
+
+    return_value = ActiveMerchant::Base.new.post_with_block {'block called'}
+
+    assert_equal 'block called', return_value
+  end
+
   def test_instrumenting_class_method
     ActiveMerchant::Gateway.singleton_class.extend StatsD::Instrument
     ActiveMerchant::Gateway.singleton_class.statsd_count :sync, 'ActiveMerchant.Gateway.sync'
@@ -159,6 +199,30 @@ class StatsDTest < Test::Unit::TestCase
     StatsD.gauge('fooy', 42)
   end
 
+  def test_write_supports_statsite_gauge_syntax
+    StatsD.unstub(:gauge)
+
+    StatsD.mode = :production
+    StatsD.server = 'localhost:123'
+    StatsD.implementation = :statsite
+
+    UDPSocket.any_instance.expects(:send).with("fooy:42|kv\n", 0, 'localhost', 123)
+
+    StatsD.gauge('fooy', 42)
+  end
+
+  def test_write_supports_statsite_gauge_timestamp
+    StatsD.unstub(:gauge)
+
+    StatsD.mode = :production
+    StatsD.server = 'localhost:123'
+    StatsD.implementation = :statsite
+
+    UDPSocket.any_instance.expects(:send).with("fooy:42|kv|@123456\n", 0, 'localhost', 123)
+
+    StatsD.gauge('fooy', 42, 123456)
+  end
+
   def test_should_not_write_when_disabled
     StatsD.enabled = false
     StatsD.expects(:logger).never

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2178819120 !ruby/object:Gem::Requirement
+  requirement: &2173609220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2178819120
+  version_requirements: *2173609220
 description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
   StatsD instrumentation into your code.
 email: