statsd-instrument 2.9.2 → 3.0.2

data/lib/statsd/instrument/udp_sink.rb

@@ -1,62 +1,66 @@
 # frozen_string_literal: true
 
-# @note This class is part of the new Client implementation that is intended
-#   to become the new default in the next major release of this library.
-class StatsD::Instrument::UDPSink
-  def self.for_addr(addr)
-    host, port_as_string = addr.split(':', 2)
-    new(host, Integer(port_as_string))
-  end
+module StatsD
+  module Instrument
+    # @note This class is part of the new Client implementation that is intended
+    #   to become the new default in the next major release of this library.
+    class UDPSink
+      def self.for_addr(addr)
+        host, port_as_string = addr.split(':', 2)
+        new(host, Integer(port_as_string))
+      end
 
-  attr_reader :host, :port
+      attr_reader :host, :port
 
-  def initialize(host, port)
-    @host = host
-    @port = port
-    @mutex = Mutex.new
-    @socket = nil
-  end
+      def initialize(host, port)
+        @host = host
+        @port = port
+        @mutex = Mutex.new
+        @socket = nil
+      end
 
-  def sample?(sample_rate)
-    sample_rate == 1 || rand < sample_rate
-  end
+      def sample?(sample_rate)
+        sample_rate == 1 || rand < sample_rate
+      end
 
-  def <<(datagram)
-    with_socket { |socket| socket.send(datagram, 0) > 0 }
-    self
+      def <<(datagram)
+        with_socket { |socket| socket.send(datagram, 0) > 0 }
+        self
 
-  rescue ThreadError
-    # In cases where a TERM or KILL signal has been sent, and we send stats as
-    # part of a signal handler, locks cannot be acquired, so we do our best
-    # to try and send the datagram without a lock.
-    socket.send(datagram, 0) > 0
+      rescue ThreadError
+        # In cases where a TERM or KILL signal has been sent, and we send stats as
+        # part of a signal handler, locks cannot be acquired, so we do our best
+        # to try and send the datagram without a lock.
+        socket.send(datagram, 0) > 0
 
-  rescue SocketError, IOError, SystemCallError
-    # TODO: log?
-    invalidate_socket
-  end
+      rescue SocketError, IOError, SystemCallError
+        # TODO: log?
+        invalidate_socket
+      end
 
-  def addr
-    "#{host}:#{port}"
-  end
+      def addr
+        "#{host}:#{port}"
+      end
 
-  private
+      private
 
-  def with_socket
-    @mutex.synchronize { yield(socket) }
-  end
+      def with_socket
+        @mutex.synchronize { yield(socket) }
+      end
 
-  def socket
-    if @socket.nil?
-      @socket = UDPSocket.new
-      @socket.connect(@host, @port)
-    end
-    @socket
-  end
+      def socket
+        if @socket.nil?
+          @socket = UDPSocket.new
+          @socket.connect(@host, @port)
+        end
+        @socket
+      end
 
-  def invalidate_socket
-    @mutex.synchronize do
-      @socket = nil
+      def invalidate_socket
+        @mutex.synchronize do
+          @socket = nil
+        end
+      end
     end
   end
 end

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "2.9.2"
+    VERSION = "3.0.2"
   end
 end

data/statsd-instrument.gemspec

@@ -16,15 +16,9 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
 
   spec.files = `git ls-files`.split($/)
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'mocha'
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'benchmark-ips'
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
 end

data/test/assertions_test.rb

@@ -31,7 +31,7 @@ class AssertionsTest < Minitest::Test
         StatsD.increment('counter')
       end
     end
-    assert_equal assertion.message, "No StatsD calls for metric counter expected."
+    assert_equal(assertion.message, "No StatsD calls for metric counter expected.")
 
     @test_case.assert_no_statsd_calls('counter1', 'counter2') do
       # noop
@@ -49,21 +49,21 @@ class AssertionsTest < Minitest::Test
         StatsD.increment('counter3')
       end
     end
-    assert_equal assertion.message, "No StatsD calls for metric counter1, counter2 expected."
+    assert_equal(assertion.message, "No StatsD calls for metric counter1, counter2 expected.")
 
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_no_statsd_calls('counter0', 'counter1', 'counter2') do
         StatsD.increment('counter1')
       end
     end
-    assert_equal assertion.message, "No StatsD calls for metric counter1 expected."
+    assert_equal(assertion.message, "No StatsD calls for metric counter1 expected.")
 
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_no_statsd_calls do
         StatsD.increment('other')
       end
     end
-    assert_equal assertion.message, "No StatsD calls for metric other expected."
+    assert_equal(assertion.message, "No StatsD calls for metric other expected.")
 
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_no_statsd_calls do
@@ -71,7 +71,7 @@ class AssertionsTest < Minitest::Test
         StatsD.increment('another')
       end
     end
-    assert_equal assertion.message, "No StatsD calls for metric other, another expected."
+    assert_equal(assertion.message, "No StatsD calls for metric other, another expected.")
   end
 
   def test_assert_statsd
@@ -202,8 +202,8 @@ class AssertionsTest < Minitest::Test
       end
     end
 
-    assert_includes assertion.message, "Captured metrics with the same key"
-    assert_includes assertion.message, "MyJob"
+    assert_includes(assertion.message, "Captured metrics with the same key")
+    assert_includes(assertion.message, "MyJob")
   end
 
   def test_capture_and_assert
@@ -367,7 +367,7 @@ class AssertionsTest < Minitest::Test
         end
       end
     end
-    assert_includes assertion.message, "No StatsD calls for metric counter of type c were made"
+    assert_includes(assertion.message, "No StatsD calls for metric counter of type c were made")
   end
 
   def test_assertion_block_with_unexpected_exceptions
@@ -377,7 +377,7 @@ class AssertionsTest < Minitest::Test
         raise "unexpected"
       end
     end
-    assert_includes assertion.message, "An exception occurred in the block provided to the StatsD assertion"
+    assert_includes(assertion.message, "An exception occurred in the block provided to the StatsD assertion")
 
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_raises(RuntimeError) do
@@ -387,7 +387,7 @@ class AssertionsTest < Minitest::Test
         end
       end
     end
-    assert_includes assertion.message, "An exception occurred in the block provided to the StatsD assertion"
+    assert_includes(assertion.message, "An exception occurred in the block provided to the StatsD assertion")
 
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_raises(RuntimeError) do
@@ -396,7 +396,7 @@ class AssertionsTest < Minitest::Test
         end
       end
     end
-    assert_includes assertion.message, "An exception occurred in the block provided to the StatsD assertion"
+    assert_includes(assertion.message, "An exception occurred in the block provided to the StatsD assertion")
   end
 
   def test_assertion_block_with_other_assertion_failures
@@ -406,6 +406,40 @@ class AssertionsTest < Minitest::Test
         @test_case.flunk('other assertion failure')
       end
     end
-    assert_equal "other assertion failure", assertion.message
+    assert_equal("other assertion failure", assertion.message)
+  end
+
+  def test_assert_when_using_no_prefix
+    env = StatsD::Instrument::Environment.new('STATSD_PREFIX' => nil)
+    StatsD.singleton_client = StatsD::Instrument::Client.from_env(env)
+
+    @test_case.assert_statsd_increment('incr', no_prefix: false) do
+      StatsD.increment('incr')
+    end
+
+    @test_case.assert_statsd_increment('incr', no_prefix: true) do
+      StatsD.increment('incr')
+    end
+
+    env = StatsD::Instrument::Environment.new('STATSD_PREFIX' => 'prefix')
+    StatsD.singleton_client = StatsD::Instrument::Client.from_env(env)
+
+    @test_case.assert_statsd_increment('incr', no_prefix: false) do
+      StatsD.increment('incr')
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('incr', no_prefix: true) do
+        StatsD.increment('incr')
+      end
+    end
+
+    @test_case.assert_statsd_increment('prefix.incr', no_prefix: true) do
+      StatsD.increment('incr')
+    end
+
+    @test_case.assert_statsd_increment('incr', no_prefix: true) do
+      StatsD.increment('incr', no_prefix: true)
+    end
   end
 end

data/test/capture_sink_test.rb

@@ -7,9 +7,9 @@ class CaptureSinkTest < Minitest::Test
     capture_sink = StatsD::Instrument::CaptureSink.new(parent: [])
     capture_sink << 'foo:1|c'
 
-    assert_equal 1, capture_sink.datagrams.length
-    assert_kind_of StatsD::Instrument::Datagram, capture_sink.datagrams.first
-    assert_equal 'foo:1|c', capture_sink.datagrams.first.source
+    assert_equal(1, capture_sink.datagrams.length)
+    assert_kind_of(StatsD::Instrument::Datagram, capture_sink.datagrams.first)
+    assert_equal('foo:1|c', capture_sink.datagrams.first.source)
   end
 
   def test_capture_sink_sends_datagrams_to_parent
@@ -17,7 +17,7 @@ class CaptureSinkTest < Minitest::Test
     capture_sink = StatsD::Instrument::CaptureSink.new(parent: parent)
     capture_sink << 'foo:1|c' << 'bar:1|c'
 
-    assert_equal ['foo:1|c', 'bar:1|c'], parent
+    assert_equal(['foo:1|c', 'bar:1|c'], parent)
   end
 
   def test_nesting_capture_sink_instances
@@ -28,15 +28,15 @@ class CaptureSinkTest < Minitest::Test
     outer_capture_sink << 'foo:1|c'
     inner_capture_sink << 'bar:1|c'
 
-    assert_equal ['foo:1|c', 'bar:1|c'], outer_capture_sink.datagrams.map(&:source)
-    assert_equal ['bar:1|c'], inner_capture_sink.datagrams.map(&:source)
+    assert_equal(['foo:1|c', 'bar:1|c'], outer_capture_sink.datagrams.map(&:source))
+    assert_equal(['bar:1|c'], inner_capture_sink.datagrams.map(&:source))
   end
 
   def test_using_a_different_datagram_class
     sink = StatsD::Instrument::CaptureSink.new(parent: [], datagram_class: String)
     sink << 'foo:1|c'
 
-    assert sink.datagrams.all? { |datagram| datagram.is_a?(String) }
-    assert_equal ['foo:1|c'], sink.datagrams
+    assert(sink.datagrams.all? { |datagram| datagram.is_a?(String) })
+    assert_equal(['foo:1|c'], sink.datagrams)
   end
 end

data/test/client_test.rb

@@ -19,25 +19,25 @@ class ClientTest < Minitest::Test
     )
     client = StatsD::Instrument::Client.from_env(env)
 
-    assert_equal 0.1, client.default_sample_rate
-    assert_equal 'foo', client.prefix
-    assert_equal ['shard:1', 'env:production'], client.default_tags
-    assert_equal StatsD::Instrument::StatsDDatagramBuilder, client.datagram_builder_class
+    assert_equal(0.1, client.default_sample_rate)
+    assert_equal('foo', client.prefix)
+    assert_equal(['shard:1', 'env:production'], client.default_tags)
+    assert_equal(StatsD::Instrument::StatsDDatagramBuilder, client.datagram_builder_class)
 
-    assert_kind_of StatsD::Instrument::UDPSink, client.sink
-    assert_equal '1.2.3.4', client.sink.host
-    assert_equal 8125, client.sink.port
+    assert_kind_of(StatsD::Instrument::UDPSink, client.sink)
+    assert_equal('1.2.3.4', client.sink.host)
+    assert_equal(8125, client.sink.port)
   end
 
   def test_client_from_env_has_sensible_defaults
     env = StatsD::Instrument::Environment.new({})
     client = StatsD::Instrument::Client.from_env(env)
 
-    assert_equal 1.0, client.default_sample_rate
-    assert_nil client.prefix
-    assert_nil client.default_tags
-    assert_equal StatsD::Instrument::DogStatsDDatagramBuilder, client.datagram_builder_class
-    assert_kind_of StatsD::Instrument::LogSink, client.sink
+    assert_equal(1.0, client.default_sample_rate)
+    assert_nil(client.prefix)
+    assert_nil(client.default_tags)
+    assert_equal(StatsD::Instrument::DogStatsDDatagramBuilder, client.datagram_builder_class)
+    assert_kind_of(StatsD::Instrument::LogSink, client.sink)
   end
 
   def test_client_from_env_with_overrides
@@ -51,12 +51,12 @@ class ClientTest < Minitest::Test
     client = StatsD::Instrument::Client.from_env(env,
       prefix: 'bar', implementation: 'dogstatsd', sink: StatsD::Instrument::NullSink.new)
 
-    assert_equal 0.1, client.default_sample_rate
-    assert_equal 'bar', client.prefix
-    assert_equal ['shard:1', 'env:production'], client.default_tags
-    assert_equal StatsD::Instrument::DogStatsDDatagramBuilder, client.datagram_builder_class
+    assert_equal(0.1, client.default_sample_rate)
+    assert_equal('bar', client.prefix)
+    assert_equal(['shard:1', 'env:production'], client.default_tags)
+    assert_equal(StatsD::Instrument::DogStatsDDatagramBuilder, client.datagram_builder_class)
 
-    assert_kind_of StatsD::Instrument::NullSink, client.sink
+    assert_kind_of(StatsD::Instrument::NullSink, client.sink)
   end
 
   def test_capture
@@ -71,27 +71,27 @@ class ClientTest < Minitest::Test
     end
     @client.increment('quc')
 
-    assert_equal ['bar', 'baz'], outer_datagrams.map(&:name)
-    assert_equal ['baz'], inner_datagrams.map(&:name)
+    assert_equal(['bar', 'baz'], outer_datagrams.map(&:name))
+    assert_equal(['baz'], inner_datagrams.map(&:name))
   end
 
   def test_metric_methods_return_truish_void
-    assert @client.increment('foo')
-    assert @client.measure('bar', 122.54)
-    assert @client.set('baz', 123)
-    assert @client.gauge('baz', 12.3)
+    assert(@client.increment('foo'))
+    assert(@client.measure('bar', 122.54))
+    assert(@client.set('baz', 123))
+    assert(@client.gauge('baz', 12.3))
   end
 
   def test_increment_with_default_value
     datagrams = @client.capture { @client.increment('foo') }
-    assert_equal 1, datagrams.size
-    assert_equal 'foo:1|c', datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal('foo:1|c', datagrams.first.source)
   end
 
   def test_measure_with_value
     datagrams = @client.capture { @client.measure('foo', 122.54) }
-    assert_equal 1, datagrams.size
-    assert_equal 'foo:122.54|ms', datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal('foo:122.54|ms', datagrams.first.source)
   end
 
   def test_measure_with_block
@@ -99,32 +99,32 @@ class ClientTest < Minitest::Test
     datagrams = @client.capture do
       @client.measure('foo') {}
     end
-    assert_equal 1, datagrams.size
-    assert_equal 'foo:100.0|ms', datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal('foo:100.0|ms', datagrams.first.source)
   end
 
   def test_gauge
     datagrams = @client.capture { @client.gauge('foo', 123) }
-    assert_equal 1, datagrams.size
-    assert_equal 'foo:123|g', datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal('foo:123|g', datagrams.first.source)
   end
 
   def test_set
     datagrams = @client.capture { @client.set('foo', 12345) }
-    assert_equal 1, datagrams.size
-    assert_equal 'foo:12345|s', datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal('foo:12345|s', datagrams.first.source)
   end
 
   def test_histogram
     datagrams = @dogstatsd_client.capture { @dogstatsd_client.histogram('foo', 12.44) }
-    assert_equal 1, datagrams.size
-    assert_equal 'foo:12.44|h', datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal('foo:12.44|h', datagrams.first.source)
   end
 
   def test_distribution_with_value
     datagrams = @dogstatsd_client.capture { @dogstatsd_client.distribution('foo', 12.44) }
-    assert_equal 1, datagrams.size
-    assert_equal 'foo:12.44|d', datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal('foo:12.44|d', datagrams.first.source)
   end
 
   def test_distribution_with_block
@@ -132,8 +132,8 @@ class ClientTest < Minitest::Test
     datagrams = @dogstatsd_client.capture do
       @dogstatsd_client.distribution('foo') {}
     end
-    assert_equal 1, datagrams.size
-    assert_equal "foo:100.0|d", datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal("foo:100.0|d", datagrams.first.source)
   end
 
   def test_latency_emits_ms_metric
@@ -141,8 +141,8 @@ class ClientTest < Minitest::Test
     datagrams = @client.capture do
       @client.latency('foo') {}
     end
-    assert_equal 1, datagrams.size
-    assert_equal "foo:100.0|ms", datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal("foo:100.0|ms", datagrams.first.source)
   end
 
   def test_latency_on_dogstatsd_prefers_distribution_metric_type
@@ -150,8 +150,8 @@ class ClientTest < Minitest::Test
     datagrams = @dogstatsd_client.capture do
       @dogstatsd_client.latency('foo') {}
     end
-    assert_equal 1, datagrams.size
-    assert_equal "foo:100.0|d", datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal("foo:100.0|d", datagrams.first.source)
   end
 
   def test_latency_calls_block_even_when_not_sending_a_sample
@@ -159,19 +159,19 @@ class ClientTest < Minitest::Test
     @client.capture do
       @client.latency('foo', sample_rate: 0) { called = true }
     end
-    assert called, "The block should have been called"
+    assert(called, "The block should have been called")
   end
 
   def test_service_check
     datagrams = @dogstatsd_client.capture { @dogstatsd_client.service_check('service', :ok) }
-    assert_equal 1, datagrams.size
-    assert_equal "_sc|service|0", datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal("_sc|service|0", datagrams.first.source)
   end
 
   def test_event
     datagrams = @dogstatsd_client.capture { @dogstatsd_client.event('service', "event\ndescription") }
-    assert_equal 1, datagrams.size
-    assert_equal "_e{7,18}:service|event\\ndescription", datagrams.first.source
+    assert_equal(1, datagrams.size)
+    assert_equal("_e{7,18}:service|event\\ndescription", datagrams.first.source)
   end
 
   def test_no_prefix
@@ -181,9 +181,20 @@ class ClientTest < Minitest::Test
       client.increment('bar', no_prefix: true)
     end
 
-    assert_equal 2, datagrams.size
-    assert_equal "foo.bar", datagrams[0].name
-    assert_equal "bar", datagrams[1].name
+    assert_equal(2, datagrams.size)
+    assert_equal("foo.bar", datagrams[0].name)
+    assert_equal("bar", datagrams[1].name)
+  end
+
+  def test_default_tags_normalization
+    client = StatsD::Instrument::Client.new(default_tags: { first_tag: 'f|irst_value', second_tag: 'sec,ond_value' })
+    datagrams = client.capture do
+      client.increment('bar', tags: ['th|ird_#,tag'])
+    end
+
+    assert_includes(datagrams.first.tags, 'first_tag:first_value')
+    assert_includes(datagrams.first.tags, 'second_tag:second_value')
+    assert_includes(datagrams.first.tags, 'third_#tag')
   end
 
   def test_sampling