statsd-instrument 1.1.2 → 1.2.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,4 +1,10 @@
 source "http://rubygems.org"
 
+group :test do
+  gem 'rake'
+end
+
 # Specify your gem's dependencies in statsd-instrument.gemspec
 gemspec
+
+gem 'SystemTimer', :platform => :mri_18, :require => ''

data/README.md

@@ -1,5 +1,7 @@
 # StatsD client for Ruby apps
 
+![Built on Travis](https://secure.travis-ci.org/Shopify/statsd-instrument.png?branch=master)
+
 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. 
 
 We call out to statsd by sending data over a UDP socket. UDP sockets are fast, but unreliable, there is no guarantee that your data will ever arrive at it's location. In other words, fire and forget. This is perfect for this use case because it means your code doesn't get bogged down trying to log statistics. We send data to statsd several times per request and haven't noticed a performance hit.
@@ -20,6 +22,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.prefix = 'my_app' # An optional prefix to be added to each stat.
 StatsD.default_sample_rate = 0.1 # Sample 10% of events. By default all events are reported.
 ```
 
@@ -132,3 +135,22 @@ You can instrument class methods, just like instance methods, using the metaprog
 AWS::S3::Base.singleton_class.extend StatsD::Instrument
 AWS::S3::Base.singleton_class.statsd_measure :request, 'S3.request'
 ```
+
+## Reliance on DNS
+Out of the box StatsD is set up to be unidirectional fire-and-forget over UDP. Configuring the StatsD host to be a non-ip will trigger a DNS lookup (ie synchronous round trip network call) for each metric sent. This can be particularly problematic in clouds that have a shared DNS infrastructure such as AWS.
+
+### Common Workarounds
+1. Using an IP avoids the DNS lookup but generally requires an application deploy to change.
+2. Hardcoding the DNS/IP pair in /etc/hosts allows the IP to change without redeploying your application but fails to scale as the number of servers increases.
+3. Installing caching software such as nscd that uses the DNS TTL avoids most DNS lookups but makes the exact moment of change indeterminate.
+
+## Compatibility
+
+Tested on:
+
+* Ruby 1.8.7
+* Ruby Enterprise Edition 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+
+Ruby 1.9 compatibility is planned for the long term. Your mileage may vary with other Ruby environments.

data/lib/statsd/instrument.rb

@@ -11,12 +11,13 @@ end
 
 module StatsD
   class << self
-    attr_accessor :host, :port, :mode, :logger, :enabled, :default_sample_rate
+    attr_accessor :host, :port, :mode, :logger, :enabled, :default_sample_rate,
+                  :prefix
   end
   self.enabled = true
   self.default_sample_rate = 1
   
-  Timeout = defined?(::SystemTimer) ? ::SystemTimer : ::Timeout
+  TimeoutClass = defined?(::SystemTimer) ? ::SystemTimer : ::Timeout
 
   # StatsD.server = 'localhost:1234'
   def self.server=(conn)
@@ -113,6 +114,11 @@ 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)
+  end
+
   private
 
   def self.socket
@@ -123,17 +129,19 @@ module StatsD
     return unless enabled
     return if sample_rate < 1 && rand > sample_rate
 
-    command = "#{k}:#{v}"
+    command = "#{self.prefix + '.' if self.prefix}#{k}:#{v}"
     case op
     when :incr
       command << '|c'
     when :ms
       command << '|ms'
+    when :g
+      command << '|g'
     end
 
     command << "|@#{sample_rate}" if sample_rate < 1
 
-    if mode == :production
+    if mode.to_s == 'production'
       socket_wrapper { socket.send(command, 0, host, port) }
     else
       logger.info "[StatsD] #{command}"
@@ -141,7 +149,7 @@ module StatsD
   end
 
   def self.socket_wrapper(options = {})
-    Timeout.timeout(options.fetch(:timeout, 0.1)) { yield }
+    TimeoutClass.timeout(options.fetch(:timeout, 0.1)) { yield }
   rescue Timeout::Error, SocketError, IOError, SystemCallError => e
     logger.error e
   end

data/statsd-instrument.gemspec

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

data/test/statsd-instrument_test.rb

@@ -1,3 +1,9 @@
+# Allow testing with the SystemTimer gem on 1.8
+if RUBY_VERSION =~ /^1.8/
+  puts "Loading SystemTimer gem"
+  require 'system_timer'
+end
+
 require 'statsd-instrument'
 require 'test/unit'
 require 'mocha'
@@ -47,6 +53,7 @@ ActiveMerchant::Base.extend StatsD::Instrument
 
 class StatsDTest < Test::Unit::TestCase
   def setup
+    StatsD.mode = nil
     StatsD.stubs(:increment)
   end
 
@@ -141,19 +148,64 @@ class StatsDTest < Test::Unit::TestCase
     StatsD.mode = :test
   end
 
+  def test_write_supports_gauge_syntax
+    StatsD.unstub(:gauge)
+
+    StatsD.mode = :production
+    StatsD.server = 'localhost:123'
+
+    UDPSocket.any_instance.expects(:send).with('fooy:42|g', 0, 'localhost', 123)
+
+    StatsD.gauge('fooy', 42)
+  end
+
   def test_should_not_write_when_disabled
     StatsD.enabled = false
     StatsD.expects(:logger).never
     StatsD.increment('fooz')
     StatsD.enabled = true
   end
-  
+
+  def test_statsd_mode
+    StatsD.unstub(:increment)
+    StatsD.logger.expects(:info).once
+    StatsD.expects(:socket_wrapper).twice
+    StatsD.mode = :foo
+    StatsD.increment('foo')
+    StatsD.mode = :production
+    StatsD.increment('foo')
+    StatsD.mode = 'production'
+    StatsD.increment('foo')
+  end
+
+  def test_statsd_prefix
+    StatsD.unstub(:increment)
+    StatsD.prefix = 'my_app'
+    StatsD.logger.expects(:info).once.with do |string|
+      string.include?('my_app.foo')
+    end
+    StatsD.logger.expects(:info).once.with do |string|
+      string.include?('food')
+    end
+    StatsD.increment('foo')
+    StatsD.prefix = nil
+    StatsD.increment('food')
+  end
+
   def test_statsd_measure_with_explicit_value
     StatsD.expects(:write).with('values.foobar', 42, :ms)
 
     StatsD.measure('values.foobar', 42)
   end
 
+  def test_statsd_gauge
+    StatsD.expects(:write).with('values.foobar', 12, :g, 1)
+
+    StatsD.default_sample_rate = 1
+
+    StatsD.gauge('values.foobar', 12)
+  end
+
   def test_socket_error_should_not_raise
     StatsD.mode = :production
     UDPSocket.any_instance.expects(:send).raises(SocketError)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-15 00:00:00.000000000 Z
+date: 2012-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2155684560 !ruby/object:Gem::Requirement
+  requirement: &2178819120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155684560
+  version_requirements: *2178819120
 description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
   StatsD instrumentation into your code.
 email:
@@ -31,6 +31,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md