lookout-statsd 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c46d6d96b1086ab6165a4254009cfdd9e3dc7dfa
-  data.tar.gz: a3d8a60d8abbc04a730e281edf58015d638eb587
+  metadata.gz: 09edd7854e30fe524a21a82dd325487e96c83a3b
+  data.tar.gz: f7d047db68333414a84ec0bbdce59f0fcde041b1
 SHA512:
-  metadata.gz: aad201320598de48a5002b876d0738981784e7acb82216b37e30b1f796aa5886f535fa6935b0de71ba89d7ca3dae7014f125752e8ea90f73fc23ff1cea551e51
-  data.tar.gz: 5050801e669c08aa9a12d2d6ac5da237eef48996f5af5edcb1b2799060dc40812a1f1f44d26cac613437cb16f81eddc790826af6186dc0ab4b5df4ba81be1f8d
+  metadata.gz: 53190cf6ac482c34bde75b18f727f1b74904a5ef1bb837c3299e487bea532d164114a9625c5185254379c6a97ef8fec794d83e3fab89e0a10d4068e87909f0bd
+  data.tar.gz: 36d9ce3ed7906da7d80226d9978a03873fe9502744eb234a3a73adbfe81af75ba159694c174566d5b75e3264014161ebbe13d08428dcf9aa1749a7441668bf5a

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+- jruby
+- 2.1
+- 1.9.3
+deploy:
+  provider: rubygems
+  api_key: 701b3f137a894afa3dca9390da8b3afe
+  gem: lookout-statsd
+  on:
+    repo: lookout/statsd
+install:
+- gem install bundler
+- bundle install --jobs=3 --retry=3

data/README.md

@@ -11,7 +11,7 @@ In your client code:
 
     require 'rubygems'
     require 'statsd'
-    STATSD = Statsd::Client.new('localhost',8125)
+    STATSD = Statsd::Client.new(:host => 'localhost', :port => 8125)
 
     STATSD.increment('some_counter') # basic incrementing
     STATSD.increment('system.nested_counter', 0.1) # incrementing with sampling (10%)
@@ -22,6 +22,27 @@ In your client code:
     STATSD.timing('some_job_time', 20) # reporting job that took 20ms
     STATSD.timing('some_job_time', 20, 0.05) # reporting job that took 20ms with sampling (5% sampling)
 
+There is an option for reduced DNS lookups, you can specify an additional
+constructor option `:resolve_always` and set it to `false`. By default, the
+client will always resolve the address unless `host` is set to 'localhost' or
+'127.0.0.1'.
+
+    require 'rubygems'
+    require 'statsd'
+
+    STATSD = Statsd::Client.new(:host => 'specialstats.host.example',
+                                :port => '8125',
+                                :resolve_always => false)
+
+    STATSD.increment('some_counter') # basic incrementing
+
+#### Note about thread-safety
+
+Since class variables and instance variables are not thread-safe on
+initialization, there is a potential for multiple UDP sockets being opened upon
+if you are using a truly multithreaded ruby, i.e. JRuby. Make sure to take that
+in to account when initializing this library.
+
 Guts
 ----
 

data/lib/statsd.rb

@@ -15,12 +15,17 @@ module Statsd
   end
 
   class Client
-    attr_accessor :host, :port, :prefix
+    attr_accessor :host, :port, :prefix, :resolve_always, :batch_size
 
     def initialize(opts={})
       @host = opts[:host] || 'localhost'
       @port = opts[:port] || 8125
+      @batch_size = opts[:batch_size] || 10
       @prefix = opts[:prefix]
+      # set resolve_always to true unless localhost or specified
+      @resolve_always = opts.fetch(:resolve_always, !is_localhost?)
+      @socket = UDPSocket.new
+      @send_data = send_method
     end
 
     def host_ip_addr
@@ -77,6 +82,22 @@ module Statsd
                  })
     end
 
+    # Creates and yields a Batch that can be used to batch instrument reports into
+    # larger packets. Batches are sent either when the packet is "full" (defined
+    # by batch_size), or when the block completes, whichever is the sooner.
+    #
+    # Good artists copy https://github.com/reinh/statsd/blob/master/lib/statsd.rb#L410
+    #
+    # @yield [Batch] a statsd subclass that collects and batches instruments
+    # @example Batch two instument operations:
+    #   $statsd.batch do |batch|
+    #     batch.increment 'sys.requests'
+    #     batch.gauge('user.count', User.count)
+    #   end
+    def batch(&block)
+      Batch.new(self).easy(&block)
+    end
+
     private
 
     def send_stats(data, sample_rate = 1)
@@ -98,17 +119,105 @@ module Statsd
       raise "host and port must be set" unless host && port
 
       begin
-        sock = UDPSocket.new
         data.each do |d|
-          sock.send(d, 0, host, port)
+          @send_data[d]
         end
       rescue # silent but deadly
-      ensure
-        sock.close
       end
       true
     end
 
+    def socket_connect!
+      @socket.connect(@host, @port)
+    end
+
+    # Curries the send based on if we need to lookup dns every time we send
+    def send_method
+      if resolve_always
+        lambda {|data| @socket.send(data, 0, @host, @port)}
+      else
+        socket_connect!
+        lambda {|data| @socket.send(data, 0)}
+      end
+    end
+
+    def is_localhost?
+      @host == 'localhost' || @host == '127.0.0.1'
+    end
+  end
+
+  # Some more unabashed borrowing: https://github.com/reinh/statsd/blob/master/lib/statsd.rb#L410
+  # The big difference between this implementation and reinh's is that we don't support namespaces,
+  # and we have a bunch of hacks for introducing prefixes to the namespaces we're acting against.
+  # = Batch: A batching statsd proxy
+  #
+  # @example Batch a set of instruments using Batch and manual flush:
+  #   $statsd = Statsd.new 'localhost', 8125
+  #   batch = Statsd::Batch.new($statsd)
+  #   batch.increment 'garets'
+  #   batch.timing 'glork', 320
+  #   batch.gauge 'bork', 100
+  #   batch.flush
+  #
+  # Batch is a subclass of Statsd, but with a constructor that proxies to a
+  # normal Statsd instance. It has it's own batch_size parameters
+  # (that inherit defaults from the supplied Statsd instance). It is recommended
+  # that some care is taken if setting very large batch sizes. If the batch size
+  # exceeds the allowed packet size for UDP on your network, communication
+  # troubles may occur and data will be lost.
+  class Batch < Statsd::Client
+
+    extend Forwardable
+    def_delegators :@statsd,
+                   :host, :host=,
+                   :port, :port=,
+                   :prefix,
+                   :postfix,
+                   :delimiter, :delimiter=
+
+    attr_accessor :batch_size
+
+    # @param [Statsd] requires a configured Statsd instance
+    def initialize(statsd)
+      @statsd = statsd
+      @batch_size = statsd.batch_size
+      @backlog = []
+      @send_data = send_method
+    end
+
+    # @yields [Batch] yields itself
+    #
+    # A convenience method to ensure that data is not lost in the event of an
+    # exception being thrown. Batches will be transmitted on the parent socket
+    # as soon as the batch is full, and when the block finishes.
+    def easy
+      yield self
+    ensure
+      flush
+    end
+
+    def flush
+      unless @backlog.empty?
+        @statsd.send_data @backlog.join("\n")
+        @backlog.clear
+      end
+    end
+
+    def send_batch_data(message)
+      @backlog << message
+      if @backlog.size >= @batch_size
+        flush
+      end
+    end
+
+    def send_method
+      lambda { |data|
+        @backlog << data
+        if @backlog.size >= @batch_size
+          flush
+        end
+      }
+    end
   end
 
   module Rails

data/spec/statsd_spec.rb

@@ -55,6 +55,48 @@ describe Statsd::Client do
       c = Statsd::Client.new(:prefix => prefix)
       c.prefix.should match(prefix)
     end
+
+    it 'should accept a :resolve_always keyword argument' do
+      lookup = false
+      c = Statsd::Client.new(:resolve_always => lookup)
+      c.resolve_always.should be(lookup)
+    end
+
+    context 'when :resolve_always is not specified' do
+
+      context 'when host is localhost or 127.0.0.1' do
+        it ':resolve_always should default to false' do
+          c = Statsd::Client.new(:host => 'localhost')
+          c.resolve_always.should be(false)
+        end
+      end
+
+      context 'when host is not local' do
+        it ':resolve_always should default to true' do
+          c = Statsd::Client.new(:host => 'statsd.example.example')
+          c.resolve_always.should be(true)
+        end
+      end
+
+    end
+
+  end
+
+  describe '#send_stats' do
+
+    it 'should use cached resolve address when :resolve_always is false' do
+      c = Statsd::Client.new(:resolve_always => false)
+      sock = c.instance_variable_get(:@socket)
+      expect(sock).to receive(:send).with(anything, 0)
+      c.increment('foo')
+    end
+
+    it 'should always resolve address when :resolve_always is true' do
+      c = Statsd::Client.new(:resolve_always => true)
+      sock = c.instance_variable_get(:@socket)
+      expect(sock).to receive(:send).with(anything, 0, c.host, c.port)
+      c.increment('foo')
+    end
   end
 
   describe '#timing' do
@@ -148,4 +190,18 @@ describe Statsd::Client do
       c.gauge('foo' => 1)
     end
   end
-end
+
+  describe '#batch' do
+    let(:c) { Statsd::Client.new }
+    subject { c.batch { |b| b.increment('foo'); b.increment('bar'); } }
+
+    it 'should take a block and put increments into a buffer' do
+      Statsd::Batch.any_instance do |b|
+        b.backlog.should_receive(:<<).exactly.twice
+      end
+      Statsd::Batch.any_instance.should_receive(:flush).and_call_original
+      c.should_receive(:send_data).once
+      subject
+    end
+  end
+end

data/statsd.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "lookout-statsd"
-  s.version     = "1.0.0"
+  s.version     = "2.0.0"
   s.platform    = Gem::Platform::RUBY
 
   s.authors     = ['R. Tyler Croy', 'Andrew Coldham', 'Ben VandenBos']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookout-statsd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - R. Tyler Croy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies: []
 description: A simple ruby statsd client.
 email:
@@ -20,6 +20,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - README.md
@@ -50,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby statsd client.