lookout-statsd 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: d1991db3ab55ae4ba74b693dfcb600b2d809cb96
-  data.tar.gz: 1718da7a874889f7c94eb18e20db2ae937b97b36
-SHA512:
-  metadata.gz: 793034d20062c3a9a3c5014191b7fdf3e118bd5271170ab35ff3e3aa66c7a2c23541669179820581700979e7441b6d1fe0137b451faca62501c8d0ab01bcf363
-  data.tar.gz: 57b8807ef73cafd8c6ce406d987500b8f6b118ad02ef23f8a2875650801f0e380045b92348fbe7226bdd7fecb5703693b290f3ff7d3f2903d7b1116ccd2d2423
+--- 
+SHA1: 
+  data.tar.gz: 7a997f961f7e49bc67f2987e0afc4b831630b244
+  metadata.gz: bcf20394e43bbf29ac3831d0f103f5cb1732be47
+SHA512: 
+  data.tar.gz: d7a5153f7f8453991f87d48c58e697914c1050ca91a9e68927d91ba84a835c47e8c996ece0cfbbc8eb9459e201f12913edf09464e317b2a0b13e4ab87e930b12
+  metadata.gz: c0b58cc86a12178b2a6e58d17d6de15ef2fac204ad6402e6da7744de10bed5c9182054b5a4aba4b13321c9951a34b6a34c1cc442a5bbf673beb6c74465d8a7d9

data/README.md

@@ -10,8 +10,8 @@ A very simple client to format and send metrics to a StatsD server.
 In your client code:
 
     require 'rubygems'
-    require 'statsd'
-    STATSD = Statsd::Client.new(:host => 'localhost', :port => 8125)
+    require 'lookout/statsd'
+    STATSD = Lookout::StatsdClient.new(:host => 'localhost', :port => 8125)
 
     STATSD.increment('some_counter') # basic incrementing
     STATSD.increment('system.nested_counter', 0.1) # incrementing with sampling (10%)
@@ -28,11 +28,11 @@ client will always resolve the address unless `host` is set to 'localhost' or
 '127.0.0.1'.
 
     require 'rubygems'
-    require 'statsd'
+    require 'lookout/statsd'
 
-    STATSD = Statsd::Client.new(:host => 'specialstats.host.example',
-                                :port => '8125',
-                                :resolve_always => false)
+    STATSD = Lookout::StatsdClient.new(:host => 'specialstats.host.example',
+                                       :port => '8125',
+                                       :resolve_always => false)
 
     STATSD.increment('some_counter') # basic incrementing
 

data/lib/{statsd.rb → lookout/statsd.rb}

@@ -2,20 +2,41 @@ require 'socket'
 require 'resolv'
 require 'forwardable'
 
-module Statsd
-  # initialize singleton instance in an initializer
-  def self.create_instance(opts={})
-    raise "Already initialized Statsd" if defined? @@instance
-    @@instance ||= Client.new(opts)
-  end
+module Lookout
+  class Statsd
+    # initialize singleton instance to be an instance of
+    # +Lookout::StatsdClient+, with the given options
+    def self.create_instance(opts={})
+      raise "Already initialized Statsd" if instance_set?
+      @@instance ||= StatsdClient.new(opts)
+    end
+
+    # Explicitly set singleton instance. The instance must follow the
+    # same API as +Lookout::StatsdClient+
+    def self.set_instance(instance)
+      raise "Already initialized Statsd" if instance_set?
+      @@instance = instance
+    end
 
-  # access singleton instance, which must have been initialized with #create_instance
-  def self.instance
-    raise "Statsd has not been initialized" unless @@instance
-    @@instance
+    # Clear singleton instance, for use in testing ONLY
+    def self.clear_instance
+      @@instance = nil
+    end
+
+    # Check if the instance has been set
+    def self.instance_set?
+      defined?(@@instance) && !!@@instance
+    end
+
+    # Access singleton instance, which must have been initialized with
+    # .create_instance or .set_instance
+    def self.instance
+      raise "Statsd has not been initialized" unless instance_set?
+      @@instance
+    end
   end
 
-  class Client
+  class StatsdClient
     attr_accessor :host, :port, :prefix, :resolve_always, :batch_size
 
     def initialize(opts={})
@@ -73,14 +94,26 @@ module Statsd
       send_stats(stats.map { |s| "#{p}#{s}:#{delta}|c" }, sample_rate)
     end
 
-    # +stats+ is a hash
-    def gauge(stats)
-      send_stats(stats.map { |s,val|
-                   if @prefix
-                     s = "#{@prefix}.#{s}"
-                   end
-                   "#{s}:#{val}|g"
-                 })
+    # +stat_or_stats+ may either be a Hash OR a String. If it's a
+    # String, then value must be specified. Other statsd client gems
+    # have mostly standardized on using the String+value format, but
+    # this gem traditionally supported just a Hash. This now supports
+    # both for compatibility.
+    def gauge(stat_or_stats, value=nil, opts=nil)
+      # Can't use duck-typing here, since String responds to :map
+      if stat_or_stats.is_a?(Hash)
+        send_stats(stat_or_stats.map { |s,val|
+                     if @prefix
+                       s = "#{@prefix}.#{s}"
+                     end
+                     "#{s}:#{val}|g"
+                   })
+      else
+        if @prefix
+          stat_or_stats = "#{@prefix}.#{stat_or_stats}"
+        end
+        send_stats("#{stat_or_stats}:#{value}|g")
+      end
     end
 
     def send_data(*args)
@@ -170,7 +203,7 @@ module Statsd
   # 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
+  class Batch < Lookout::StatsdClient
 
     attr_accessor :batch_size
 
@@ -228,9 +261,8 @@ module Statsd
         # Use params[:controller] insted of controller.controller_name to get full path.
         controller_name = controller.params[:controller].gsub("/", ".")
         key = "requests.#{controller_name}.#{controller.params[:action]}"
-        Statsd.instance.timing(key, &block)
+        Lookout::Statsd.instance.timing(key, &block)
       end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,3 +1,3 @@
 $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
-require 'statsd'
+require 'lookout/statsd'

data/spec/statsd/rails/action_timer_filter_spec.rb

@@ -1,22 +1,22 @@
 require 'spec_helper'
 
-describe Statsd::Rails::ActionTimerFilter do
+describe Lookout::Rails::ActionTimerFilter do
 
   describe ".filter" do
     before(:all) do
-      Statsd.create_instance
+      Lookout::Statsd.create_instance
     end
 
     it "should log the appropriate data with simple controller" do
       controller = mock_controller('control', 'act')
-      Statsd.instance.should_receive(:timing).with("requests.control.act")
-      Statsd::Rails::ActionTimerFilter.filter(controller) {}
+      Lookout::Statsd.instance.should_receive(:timing).with("requests.control.act")
+      Lookout::Rails::ActionTimerFilter.filter(controller) {}
     end
 
     it "should log the appropriate data with complex controller" do
       controller = mock_controller('api/v1/control', 'act')
-      Statsd.instance.should_receive(:timing).with("requests.api.v1.control.act")
-      Statsd::Rails::ActionTimerFilter.filter(controller) {}
+      Lookout::Statsd.instance.should_receive(:timing).with("requests.api.v1.control.act")
+      Lookout::Rails::ActionTimerFilter.filter(controller) {}
     end
   end
 

data/spec/statsd_spec.rb

@@ -1,69 +1,83 @@
 require 'spec_helper'
 
-describe Statsd do
-  describe '#create_instance' do
-    before(:each) do
-      # Make sure prior test hasn't already invoked create_instance
-      if Statsd.class_variable_defined?(:@@instance)
-        Statsd.send(:remove_class_variable, :@@instance)
-      end
-    end
+describe Lookout::Statsd do
+  before(:each) do
+    described_class.clear_instance
+  end
 
-    after(:each) do
-      Statsd.send(:remove_class_variable, :@@instance)
-    end
+  after(:each) do
+    described_class.clear_instance
+  end
 
+  describe '.create_instance' do
     it 'should create an instance' do
-      Statsd.create_instance
-      Statsd.instance.should_not be nil
+      described_class.create_instance
+      described_class.instance.should_not be nil
     end
 
     context 'if an instance has been created' do
       before :each do
-        Statsd.create_instance
+        described_class.create_instance
       end
       it 'should raise if called twice' do
-        expect { Statsd.create_instance }.to raise_error
+        expect { described_class.create_instance }.to raise_error
       end
     end
+  end
+
+  describe '.set_instance' do
+    let(:instance) { double('Statsd') }
+
+    it 'should set instance' do
+      described_class.set_instance(instance)
+      expect(described_class.instance).to eq instance
+    end
 
+    context 'if an instance has been created' do
+      before :each do
+        described_class.set_instance(instance)
+      end
+      it 'should raise if called twice' do
+        expect { described_class.set_instance(instance) }.to raise_error
+      end
+    end
   end
 
   describe '#instance' do
     it 'should raise if not created' do
-      expect { Statsd.instance }.to raise_error
+      expect { described_class.instance }.to raise_error
     end
   end
 end
 
-describe Statsd::Client do
+describe Lookout::StatsdClient do
   describe '#initialize' do
     it 'should work without arguments' do
-      c = Statsd::Client.new
+      c = Lookout::StatsdClient.new
       c.should_not be nil
     end
 
     it 'should accept a :host keyword argument' do
       host = 'zombo.com'
-      c = Statsd::Client.new(:host => host)
+      c = Lookout::StatsdClient.new(:host => host)
       c.host.should match(host)
     end
 
     it 'should accept a :port keyword argument' do
       port = 1337
-      c = Statsd::Client.new(:port => port)
+      c = Lookout::StatsdClient.new(:port => port)
       c.port.should == port
     end
 
     it 'should accept a :prefix keyword argument' do
       prefix = 'dev'
-      c = Statsd::Client.new(:prefix => prefix)
+      c = Lookout::StatsdClient.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 = Lookout::StatsdClient.new(:resolve_always => lookup)
       c.resolve_always.should be(lookup)
     end
 
@@ -71,14 +85,14 @@ describe Statsd::Client 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 = Lookout::StatsdClient.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 = Lookout::StatsdClient.new(:host => 'statsd.example.example')
           c.resolve_always.should be(true)
         end
       end
@@ -90,14 +104,14 @@ describe Statsd::Client do
   describe '#send_stats' do
 
     it 'should use cached resolve address when :resolve_always is false' do
-      c = Statsd::Client.new(:resolve_always => false)
+      c = Lookout::StatsdClient.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)
+      c = Lookout::StatsdClient.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')
@@ -105,7 +119,7 @@ describe Statsd::Client do
   end
 
   describe '#timing' do
-    let(:c) { Statsd::Client.new }
+    let(:c) { Lookout::StatsdClient.new }
 
     it 'should pass the sample rate along' do
       sample = 10
@@ -145,7 +159,7 @@ describe Statsd::Client do
   end
 
   describe '#increment' do
-    let(:c) { Statsd::Client.new }
+    let(:c) { Lookout::StatsdClient.new }
 
     it 'should update the counter by 1' do
       c.should_receive(:update_counter).with('foo', 1, anything())
@@ -154,7 +168,7 @@ describe Statsd::Client do
   end
 
   describe '#decrement' do
-    let(:c) { Statsd::Client.new }
+    let(:c) { Lookout::StatsdClient.new }
 
     it 'should update the counter by -1' do
       c.should_receive(:update_counter).with('foo', -1, anything())
@@ -163,7 +177,7 @@ describe Statsd::Client do
   end
 
   describe '#update_counter' do
-    let(:c) { Statsd::Client.new }
+    let(:c) { Lookout::StatsdClient.new }
 
     it 'should prepend the prefix if it has one' do
       c.prefix = 'dev'
@@ -179,40 +193,72 @@ describe Statsd::Client do
   end
 
   describe '#gauge' do
-    let(:c) { Statsd::Client.new }
+    let(:c) { Lookout::StatsdClient.new }
 
-    it 'should encode the values correctly' do
-      c.should_receive(:send_stats).with do |array|
-        array.should include('foo:1|g')
-        array.should include('bar:2|g')
+    context "called with a Hash" do
+      it 'should encode the values correctly' do
+        c.should_receive(:send_stats).with do |array|
+          array.should include('foo:1|g')
+          array.should include('bar:2|g')
+        end
+        c.gauge('foo' => 1, 'bar' => 2)
+      end
+
+      it 'should prepend the prefix if it has one' do
+        c.prefix = 'dev'
+        c.should_receive(:send_stats).with(['dev.foo:1|g'])
+        c.gauge('foo' => 1)
       end
-      c.gauge('foo' => 1, 'bar' => 2)
     end
 
-    it 'should prepend the prefix if it has one' do
-      c.prefix = 'dev'
-      c.should_receive(:send_stats).with(['dev.foo:1|g'])
-      c.gauge('foo' => 1)
+    context "called with String+Value" do
+      context "without specifying options" do
+        it 'should encode the values correctly' do
+          c.should_receive(:send_stats).with('foo:1|g')
+          c.gauge('foo', 1)
+        end
+
+        it 'should prepend the prefix if it has one' do
+          c.prefix = 'dev'
+          c.should_receive(:send_stats).with('dev.foo:1|g')
+          c.gauge('foo', 1)
+        end
+      end
+
+      context "specifying options" do
+        let(:opts) { {:ignored => true} }
+
+        it 'should encode the values correctly' do
+          c.should_receive(:send_stats).with('foo:1|g')
+          c.gauge('foo', 1, opts)
+        end
+
+        it 'should prepend the prefix if it has one' do
+          c.prefix = 'dev'
+          c.should_receive(:send_stats).with('dev.foo:1|g')
+          c.gauge('foo', 1, opts)
+        end
+      end
     end
   end
 
   describe '#batch' do
-    let(:c) { Statsd::Client.new }
+    let(:c) { Lookout::StatsdClient.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|
+      Lookout::Batch.any_instance do |b|
         b.backlog.should_receive(:<<).exactly.twice
       end
-      Statsd::Batch.any_instance.should_receive(:flush).and_call_original
+      Lookout::Batch.any_instance.should_receive(:flush).and_call_original
       c.should_receive(:send_data).once
       subject
     end
   end
 end
 
-describe Statsd::Batch do
-  let(:c) { Statsd::Client.new :host => 'foo.com', :prefix => 'my.app', :port => 1234, :batch_size => 20 }
+describe Lookout::Batch do
+  let(:c) { Lookout::StatsdClient.new :host => 'foo.com', :prefix => 'my.app', :port => 1234, :batch_size => 20 }
 
   it 'should delegate fields correctly' do
     c.batch do |b|
@@ -318,4 +364,4 @@ describe Statsd::Batch do
       end
     end
   end
-end
+end

data/statsd.gemspec

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

metadata

@@ -1,32 +1,36 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: lookout-statsd
-version: !ruby/object:Gem::Version
-  version: 2.0.3
+version: !ruby/object:Gem::Version 
+  version: 3.0.0
 platform: ruby
-authors:
+authors: 
 - R. Tyler Croy
 - Andrew Coldham
 - Ben VandenBos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+
+date: 2016-07-13 00:00:00 Z
 dependencies: []
+
 description: A simple ruby statsd client.
-email:
+email: 
 - rtyler.croy@mylookout.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".gitignore"
-- ".travis.yml"
+
+files: 
+- .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - README.md
 - Rakefile
-- lib/statsd.rb
-- lib/statsd/test.rb
+- lib/lookout/statsd.rb
 - netcat-example.sh
 - spec/spec_helper.rb
 - spec/statsd/rails/action_timer_filter_spec.rb
@@ -34,25 +38,30 @@ files:
 - statsd.gemspec
 homepage: https://github.com/lookout/statsd
 licenses: []
+
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
+    - !ruby/object:Gem::Version 
       version: 1.3.6
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.0.16
 signing_key: 
 specification_version: 4
 summary: Ruby statsd client.
 test_files: []
+

data/lib/statsd/test.rb

@@ -1,3 +0,0 @@
-require 'statsd'
-counters = timers = []
-#Statsd::Graphite.flush_stats(counters,timers)