statsd-instrument 2.3.5 → 2.4.0

data/test/benchmark/metrics.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'statsd-instrument'
 require 'benchmark/ips'
 
-def helperFunction()
-    a = 10
-    a += a
-    a -= a
-    a *= a
+def helper_function
+  a = 10
+  a += a
+  a -= a
+  a * a
 end
 
 Benchmark.ips do |bench|
@@ -14,8 +16,8 @@ Benchmark.ips do |bench|
   end
 
   bench.report("measure metric benchmark") do
-    StatsD.measure('helperFunction') do
-        helperFunction()
+    StatsD.measure('helper_function') do
+      helper_function
     end
   end
 
@@ -34,5 +36,4 @@ Benchmark.ips do |bench|
   bench.report("service check metric benchmark") do
     StatsD.service_check('shipit.redis_connection', 'ok')
   end
-
 end

data/test/benchmark/tags.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'statsd-instrument'
 require 'benchmark/ips'
 
 Benchmark.ips do |bench|
   bench.report("normalized tags with simple hash") do
-    StatsD::Instrument::Metric.normalize_tags(:tag => 'value')
+    StatsD::Instrument::Metric.normalize_tags(tag: 'value')
   end
 
   bench.report("normalized tags with simple array") do
@@ -11,14 +13,14 @@ Benchmark.ips do |bench|
   end
 
   bench.report("normalized tags with large hash") do
-    StatsD::Instrument::Metric.normalize_tags({
+    StatsD::Instrument::Metric.normalize_tags(
       mobile: true,
       pod: "1",
       protocol: "https",
       country: "Langbortistan",
       complete: true,
       shop: "omg shop that has a longer name",
-    })
+    )
   end
 
   bench.report("normalized tags with large array") do

data/test/capture_backend_test.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class CaptureBackendTest < Minitest::Test
   def setup
     @backend = StatsD::Instrument::Backends::CaptureBackend.new
-    @metric1 = StatsD::Instrument::Metric::new(type: :c, name: 'mock.counter')
-    @metric2 = StatsD::Instrument::Metric::new(type: :ms, name: 'mock.measure', value: 123)
+    @metric1 = StatsD::Instrument::Metric.new(type: :c, name: 'mock.counter')
+    @metric2 = StatsD::Instrument::Metric.new(type: :ms, name: 'mock.measure', value: 123)
   end
 
   def test_collecting_metric

data/test/environment_test.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Rails; end
 
 class EnvironmentTest < Minitest::Test
-
   def setup
     ENV['STATSD_ADDR'] = nil
     ENV['IMPLEMENTATION'] = nil

data/test/helpers_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class HelpersTest < Minitest::Test
@@ -21,4 +23,3 @@ class HelpersTest < Minitest::Test
     assert_equal 12, metrics[1].value
   end
 end
-

data/test/integration_test.rb

@@ -1,20 +1,40 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class IntegrationTest < Minitest::Test
-
   def setup
-    @old_backend, StatsD.backend = StatsD.backend, StatsD::Instrument::Backends::UDPBackend.new("localhost:31798")
+    @server = UDPSocket.new
+    @server.bind('localhost', 0)
+    port = @server.addr[1]
+
+    @old_backend = StatsD.backend
+    StatsD.backend = StatsD::Instrument::Backends::UDPBackend.new("localhost:#{port}")
   end
-  
+
   def teardown
+    @server.close
     StatsD.backend = @old_backend
   end
 
   def test_live_local_udp_socket
-    server = UDPSocket.new
-    server.bind('localhost', 31798)
-
     StatsD.increment('counter')
-    assert_equal "counter:1|c", server.recvfrom(100).first
+    assert_equal "counter:1|c", @server.recvfrom(100).first
+  end
+
+  def test_synchronize_in_exit_handler_handles_thread_error_and_exits_cleanly
+    pid = fork do
+      Signal.trap('TERM') do
+        StatsD.increment('exiting')
+        Process.exit!(0)
+      end
+
+      sleep 100
+    end
+
+    Process.kill('TERM', pid)
+    Process.waitpid(pid)
+
+    assert_equal "exiting:1|c", @server.recvfrom(100).first
   end
 end

data/test/logger_backend_test.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class LoggerBackendTest < Minitest::Test
   def setup
     logger = Logger.new(@io = StringIO.new)
-    logger.formatter = lambda { |_,_,_, msg| "#{msg}\n" }
+    logger.formatter = lambda { |_, _, _, msg| "#{msg}\n" }
     @backend = StatsD::Instrument::Backends::LoggerBackend.new(logger)
-    @metric1 = StatsD::Instrument::Metric::new(type: :c, name: 'mock.counter', tags: { a: 'b', c: 'd'})
-    @metric2 = StatsD::Instrument::Metric::new(type: :ms, name: 'mock.measure', value: 123, sample_rate: 0.3)
+    @metric1 = StatsD::Instrument::Metric.new(type: :c, name: 'mock.counter', tags: { a: 'b', c: 'd' })
+    @metric2 = StatsD::Instrument::Metric.new(type: :ms, name: 'mock.measure', value: 123, sample_rate: 0.3)
   end
 
   def test_logs_metrics
     @backend.collect_metric(@metric1)
-    assert_equal @io.string, "[StatsD] increment mock.counter:1 #a:b #c:d\n"
-    @io.string = ""
-
     @backend.collect_metric(@metric2)
-    assert_equal @io.string, "[StatsD] measure mock.measure:123 @0.3\n"
+    assert_equal <<~LOG, @io.string
+      [StatsD] increment mock.counter:1 #a:b #c:d
+      [StatsD] measure mock.measure:123 @0.3
+    LOG
   end
-end
+end

data/test/matchers_test.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'statsd/instrument/matchers'
 
 class MatchersTest < Minitest::Test
   def test_statsd_increment_matched
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', {}).matches? lambda { StatsD.increment('counter') }
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', {})
+      .matches?(lambda { StatsD.increment('counter') })
   end
 
   def test_statsd_increment_not_matched
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', {}).matches? lambda { StatsD.increment('not_counter') }
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', {})
+      .matches?(lambda { StatsD.increment('not_counter') })
   end
 
   def test_statsd_increment_compound_matched
@@ -31,72 +35,82 @@ class MatchersTest < Minitest::Test
   end
 
   def test_statsd_increment_with_times_matched
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 1).matches? lambda { StatsD.increment('counter') }
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 1)
+      .matches?(lambda { StatsD.increment('counter') })
   end
 
   def test_statsd_increment_with_times_not_matched
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 2).matches? lambda { StatsD.increment('counter', times: 3) }
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 2)
+      .matches?(lambda { StatsD.increment('counter', times: 3) })
   end
 
   def test_statsd_increment_with_sample_rate_matched
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: 0.5).matches? lambda { StatsD.increment('counter', sample_rate: 0.5) }
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: 0.5)
+      .matches?(lambda { StatsD.increment('counter', sample_rate: 0.5) })
   end
 
   def test_statsd_increment_with_sample_rate_not_matched
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: 0.5).matches? lambda { StatsD.increment('counter', sample_rate: 0.7) }
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: 0.5)
+      .matches?(lambda { StatsD.increment('counter', sample_rate: 0.7) })
   end
 
   def test_statsd_increment_with_value_matched
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 1).matches? lambda { StatsD.increment('counter') }
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 1)
+      .matches?(lambda { StatsD.increment('counter') })
   end
 
   def test_statsd_increment_with_value_matched_when_multiple_metrics
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 1).matches? lambda {
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 1).matches?(lambda {
       StatsD.increment('counter', value: 2)
       StatsD.increment('counter', value: 1)
-    }
+    })
   end
 
   def test_statsd_increment_with_value_not_matched_when_multiple_metrics
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 1).matches? lambda {
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 1).matches?(lambda {
       StatsD.increment('counter', value: 2)
       StatsD.increment('counter', value: 3)
-    }
+    })
   end
 
   def test_statsd_increment_with_value_not_matched
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 3).matches? lambda { StatsD.increment('counter') }
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 3)
+      .matches?(lambda { StatsD.increment('counter') })
   end
 
   def test_statsd_increment_with_tags_matched
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['a', 'b']).matches? lambda { StatsD.increment('counter', tags: ['a', 'b']) }
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['a', 'b'])
+      .matches?(lambda { StatsD.increment('counter', tags: ['a', 'b']) })
   end
 
   def test_statsd_increment_with_tags_not_matched
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['a', 'b']).matches? lambda { StatsD.increment('counter', tags: ['c']) }
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['a', 'b'])
+      .matches?(lambda { StatsD.increment('counter', tags: ['c']) })
   end
 
   def test_statsd_increment_with_times_and_value_matched
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 2, value: 1).matches? lambda {
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 2, value: 1).matches?(lambda {
       StatsD.increment('counter', value: 1)
       StatsD.increment('counter', value: 1)
-    }
+    })
   end
 
   def test_statsd_increment_with_times_and_value_not_matched
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 2, value: 1).matches? lambda {
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 2, value: 1).matches?(lambda {
       StatsD.increment('counter', value: 1)
       StatsD.increment('counter', value: 2)
-    }
+    })
   end
 
   def test_statsd_increment_with_sample_rate_and_argument_matcher_matched
     between_matcher = RSpec::Matchers::BuiltIn::BeBetween.new(0.4, 0.6).inclusive
-    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: between_matcher).matches? lambda { StatsD.increment('counter', sample_rate: 0.5) }
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: between_matcher)
+      .matches?(lambda { StatsD.increment('counter', sample_rate: 0.5) })
   end
 
   def test_statsd_increment_with_sample_rate_and_argument_matcher_not_matched
     between_matcher = RSpec::Matchers::BuiltIn::BeBetween.new(0.4, 0.6).inclusive
-    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: between_matcher).matches? lambda { StatsD.increment('counter', sample_rate: 0.7) }
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: between_matcher)
+      .matches?(lambda { StatsD.increment('counter', sample_rate: 0.7) })
   end
 end

data/test/metric_test.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class MetricTest < Minitest::Test
-
   def test_required_arguments
     assert_raises(ArgumentError) { StatsD::Instrument::Metric.new(type: :c) }
     assert_raises(ArgumentError) { StatsD::Instrument::Metric.new(name: 'test') }
@@ -41,11 +42,21 @@ class MetricTest < Minitest::Test
 
   def test_handle_bad_tags
     assert_equal ['ignored'], StatsD::Instrument::Metric.normalize_tags(['igno|red'])
-    assert_equal ['lol::class:omg::lol'], StatsD::Instrument::Metric.normalize_tags({ :"lol::class" => "omg::lol" })
+    assert_equal ['lol::class:omg::lol'], StatsD::Instrument::Metric.normalize_tags("lol::class" => "omg::lol")
   end
 
   def test_rewrite_tags_provided_as_hash
-    assert_equal ['tag:value'], StatsD::Instrument::Metric.normalize_tags(:tag => 'value')
-    assert_equal ['tag:value', 'tag2:value2'], StatsD::Instrument::Metric.normalize_tags(:tag => 'value', :tag2 => 'value2')
+    assert_equal ['tag:value'], StatsD::Instrument::Metric.normalize_tags(tag: 'value')
+    assert_equal ['tag1:v1', 'tag2:v2'], StatsD::Instrument::Metric.normalize_tags(tag1: 'v1', tag2: 'v2')
+  end
+
+  def test_default_tags
+    StatsD.stubs(:default_tags).returns(['default_tag:default_value'])
+    m = StatsD::Instrument::Metric.new(type: :c, name: 'counter', tags: { tag: 'value' })
+    assert_equal ['tag:value', 'default_tag:default_value'], m.tags
+
+    StatsD.stubs(:default_tags).returns(['tag:value'])
+    m = StatsD::Instrument::Metric.new(type: :c, name: 'counter', tags: { tag: 'value' })
+    assert_equal ['tag:value', 'tag:value'], m.tags # we don't care about duplicates
   end
 end

data/test/statsd_instrumentation_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveMerchant; end
@@ -11,7 +13,7 @@ class ActiveMerchant::Base
   end
 
   def post_with_block(&block)
-    yield if block_given?
+    block.call if block_given?
   end
 end
 
@@ -34,7 +36,7 @@ end
 
 class ActiveMerchant::UniqueGateway < ActiveMerchant::Base
   def ssl_post(arg)
-    {:success => arg}
+    { success: arg }
   end
 
   def purchase(arg)
@@ -87,7 +89,7 @@ class StatsDInstrumentationTest < Minitest::Test
     end
 
     assert_statsd_increment('ActiveMerchant.Base.post_with_block') do
-      assert_equal 'true',  ActiveMerchant::Base.new.post_with_block { 'true' }
+      assert_equal 'true', ActiveMerchant::Base.new.post_with_block { 'true' }
       assert_equal 'false', ActiveMerchant::Base.new.post_with_block { 'false' }
     end
   ensure
@@ -265,7 +267,6 @@ class StatsDInstrumentationTest < Minitest::Test
     ActiveMerchant::UniqueGateway.statsd_remove_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
   end
 
-
   def test_statsd_distribution
     ActiveMerchant::UniqueGateway.statsd_distribution :ssl_post, 'ActiveMerchant.Gateway.ssl_post', sample_rate: 0.3
 
@@ -412,10 +413,9 @@ class StatsDInstrumentationTest < Minitest::Test
   private
 
   def assert_scope(klass, method, expected_scope)
-    method_scope = case
-    when klass.private_method_defined?(method)
+    method_scope = if klass.private_method_defined?(method)
       :private
-    when klass.protected_method_defined?(method)
+    elsif klass.protected_method_defined?(method)
       :protected
     else
       :public

data/test/statsd_test.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class StatsDTest < Minitest::Test
   include StatsD::Instrument::Assertions
 
+  def teardown
+    StatsD.default_tags = nil
+  end
+
   def test_statsd_passed_collections_to_backend
     StatsD.backend.expects(:collect_metric).with(instance_of(StatsD::Instrument::Metric))
     StatsD.increment('test')
@@ -18,7 +24,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_explicit_value_and_distribution_override
-    metric = capture_statsd_call { result = StatsD.measure('values.foobar', 42, as_dist: true) }
+    metric = capture_statsd_call { StatsD.measure('values.foobar', 42, as_dist: true) }
     assert_equal :d, metric.type
   end
 
@@ -32,7 +38,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_explicit_value_keyword_and_distribution_override
-    metric = capture_statsd_call { result = StatsD.measure('values.foobar', value: 42, as_dist: true) }
+    metric = capture_statsd_call { StatsD.measure('values.foobar', value: 42, as_dist: true) }
     assert_equal :d, metric.type
   end
 
@@ -41,7 +47,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_explicit_value_and_sample_rate
-    metric = capture_statsd_call { StatsD.measure('values.foobar', 42, :sample_rate => 0.1) }
+    metric = capture_statsd_call { StatsD.measure('values.foobar', 42, sample_rate: 0.1) }
     assert_equal 0.1, metric.sample_rate
   end
 
@@ -65,7 +71,7 @@ class StatsDTest < Minitest::Test
     assert_equal 'sarah', return_value
   end
 
-  def test_statsd_measure_returns_return_value_of_block_even_if_nil
+  def test_statsd_measure_as_distribution_returns_return_value_of_block_even_if_nil
     return_value = StatsD.measure('values.foobar', as_dist: true) { nil }
     assert_nil return_value
   end
@@ -75,7 +81,7 @@ class StatsDTest < Minitest::Test
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
-        StatsD.measure('values.foobar') { return 'from lambda'}
+        StatsD.measure('values.foobar') { return 'from lambda' }
       end
 
       result = lambda.call
@@ -90,14 +96,13 @@ class StatsDTest < Minitest::Test
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
-        StatsD.measure('values.foobar') { raise 'from lambda'}
+        StatsD.measure('values.foobar') { raise 'from lambda' }
       end
 
       begin
         result = lambda.call
-      rescue
+      rescue # rubocop:disable Lint/HandleExceptions:
       end
-
     end
 
     assert_nil result
@@ -114,14 +119,14 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_increment_with_hash_argument
-    metric = capture_statsd_call { StatsD.increment('values.foobar', :tags => ['test']) }
+    metric = capture_statsd_call { StatsD.increment('values.foobar', tags: ['test']) }
     assert_equal StatsD.default_sample_rate, metric.sample_rate
     assert_equal ['test'], metric.tags
     assert_equal 1, metric.value
   end
 
   def test_statsd_increment_with_value_as_keyword_argument
-    metric = capture_statsd_call { StatsD.increment('values.foobar', :value => 2) }
+    metric = capture_statsd_call { StatsD.increment('values.foobar', value: 2) }
     assert_equal StatsD.default_sample_rate, metric.sample_rate
     assert_equal 2, metric.value
   end
@@ -196,7 +201,7 @@ class StatsDTest < Minitest::Test
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
-        StatsD.distribution('values.foobar') { return 'from lambda'}
+        StatsD.distribution('values.foobar') { return 'from lambda' }
       end
 
       result = lambda.call
@@ -212,14 +217,13 @@ class StatsDTest < Minitest::Test
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
-        StatsD.distribution('values.foobar') { raise 'from lambda'}
+        StatsD.distribution('values.foobar') { raise 'from lambda' }
       end
 
       begin
         result = lambda.call
-      rescue
+      rescue # rubocop:disable Lint/HandleExceptions
       end
-
     end
 
     assert_nil result
@@ -230,7 +234,7 @@ class StatsDTest < Minitest::Test
   def test_statsd_distribution_with_block_and_options
     StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
     metric = capture_statsd_call do
-      StatsD.distribution('values.foobar', :tags => ['test'], :sample_rate => 0.9) { 'foo' }
+      StatsD.distribution('values.foobar', tags: ['test'], sample_rate: 0.9) { 'foo' }
     end
     assert_equal 1120.0, metric.value
     assert_equal 'values.foobar', metric.name
@@ -268,6 +272,11 @@ class StatsDTest < Minitest::Test
     end
   end
 
+  def test_statsd_default_tags_get_normalized
+    StatsD.default_tags = { first_tag: 'first_value', second_tag: 'second_value' }
+    assert_equal ['first_tag:first_value', 'second_tag:second_value'], StatsD.default_tags
+  end
+
   protected
 
   def capture_statsd_call(&block)