statsd-instrument 2.4.0 → 2.5.0

data/test/statsd_test.rb

@@ -15,9 +15,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_explicit_value
-    result = nil
-    metric = capture_statsd_call { result = StatsD.measure('values.foobar', 42) }
-    assert_equal metric, result
+    metric = capture_statsd_call { StatsD.measure('values.foobar', 42) }
     assert_equal 'values.foobar', metric.name
     assert_equal 42, metric.value
     assert_equal :ms, metric.type
@@ -28,20 +26,6 @@ class StatsDTest < Minitest::Test
     assert_equal :d, metric.type
   end
 
-  def test_statsd_measure_with_explicit_value_as_keyword_argument
-    result = nil
-    metric = capture_statsd_call { result = StatsD.measure('values.foobar', value: 42) }
-    assert_equal metric, result
-    assert_equal 'values.foobar', metric.name
-    assert_equal 42, metric.value
-    assert_equal :ms, metric.type
-  end
-
-  def test_statsd_measure_with_explicit_value_keyword_and_distribution_override
-    metric = capture_statsd_call { StatsD.measure('values.foobar', value: 42, as_dist: true) }
-    assert_equal :d, metric.type
-  end
-
   def test_statsd_measure_without_value_or_block
     assert_raises(ArgumentError) { StatsD.measure('values.foobar', tags: 123) }
   end
@@ -52,7 +36,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_benchmarked_block_duration
-    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
+    Process.stubs(:clock_gettime).returns(5.0, 5.0 + 1.12)
     metric = capture_statsd_call do
       StatsD.measure('values.foobar') { 'foo' }
     end
@@ -77,7 +61,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_return_in_block_still_captures
-    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 6.12)
+    Process.stubs(:clock_gettime).returns(5.0, 6.12)
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
@@ -92,7 +76,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_exception_in_block_still_captures
-    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 6.12)
+    Process.stubs(:clock_gettime).returns(5.0, 6.12)
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
@@ -110,9 +94,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_increment
-    result = nil
-    metric = capture_statsd_call { result = StatsD.increment('values.foobar', 3) }
-    assert_equal metric, result
+    metric = capture_statsd_call { StatsD.increment('values.foobar', 3) }
     assert_equal :c, metric.type
     assert_equal 'values.foobar', metric.name
     assert_equal 3, metric.value
@@ -125,83 +107,55 @@ class StatsDTest < Minitest::Test
     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) }
-    assert_equal StatsD.default_sample_rate, metric.sample_rate
-    assert_equal 2, metric.value
-  end
-
-  def test_statsd_increment_with_multiple_arguments
-    metric = capture_statsd_call { StatsD.increment('values.foobar', 12, nil, ['test']) }
-    assert_equal StatsD.default_sample_rate, metric.sample_rate
-    assert_equal ['test'], metric.tags
-    assert_equal 12, metric.value
-  end
-
   def test_statsd_gauge
-    result = nil
-    metric = capture_statsd_call { result = StatsD.gauge('values.foobar', 12) }
-    assert_equal metric, result
+    metric = capture_statsd_call { StatsD.gauge('values.foobar', 12) }
     assert_equal :g, metric.type
     assert_equal 'values.foobar', metric.name
     assert_equal 12, metric.value
   end
 
-  def test_statsd_gauge_with_keyword_argument
-    result = nil
-    metric = capture_statsd_call { result = StatsD.gauge('values.foobar', value: 13) }
-    assert_equal metric, result
-    assert_equal :g, metric.type
-    assert_equal 'values.foobar', metric.name
-    assert_equal 13, metric.value
-  end
-
   def test_statsd_gauge_without_value
     assert_raises(ArgumentError) { StatsD.gauge('values.foobar', tags: 123) }
   end
 
   def test_statsd_set
-    result = nil
-    metric = capture_statsd_call { result = StatsD.set('values.foobar', 'unique_identifier') }
-    assert_equal metric, result
+    metric = capture_statsd_call { StatsD.set('values.foobar', 'unique_identifier') }
     assert_equal :s, metric.type
     assert_equal 'values.foobar', metric.name
     assert_equal 'unique_identifier', metric.value
   end
 
   def test_statsd_histogram
-    result = nil
-    metric = capture_statsd_call { result = StatsD.histogram('values.foobar', 42) }
-    assert_equal metric, result
+    metric = capture_statsd_call { StatsD.histogram('values.foobar', 42) }
     assert_equal :h, metric.type
     assert_equal 'values.foobar', metric.name
     assert_equal 42, metric.value
   end
 
   def test_statsd_distribution
-    result = nil
-    metric = capture_statsd_call { result = StatsD.distribution('values.foobar', 42) }
-    assert_equal metric, result
+    metric = capture_statsd_call { StatsD.distribution('values.foobar', 42) }
     assert_equal :d, metric.type
     assert_equal 'values.foobar', metric.name
     assert_equal 42, metric.value
   end
 
   def test_statsd_distribution_with_benchmarked_block_duration
-    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
+    Process.stubs(:clock_gettime).returns(5.0, 5.0 + 1.12)
     metric = capture_statsd_call do
-      StatsD.distribution('values.foobar') { 'foo' }
+      result = StatsD.distribution('values.foobar') { 'foo' }
+      assert_equal 'foo', result
     end
     assert_equal :d, metric.type
     assert_equal 1120.0, metric.value
   end
 
   def test_statsd_distribution_with_return_in_block_still_captures
-    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
+    Process.stubs(:clock_gettime).returns(5.0, 5.0 + 1.12)
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
         StatsD.distribution('values.foobar') { return 'from lambda' }
+        flunk("This code should not be reached")
       end
 
       result = lambda.call
@@ -213,7 +167,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_distribution_with_exception_in_block_still_captures
-    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
+    Process.stubs(:clock_gettime).returns(5.0, 5.0 + 1.12)
     result = nil
     metric = capture_statsd_call do
       lambda = -> do
@@ -232,7 +186,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_distribution_with_block_and_options
-    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
+    Process.stubs(:clock_gettime).returns(5.0, 5.0 + 1.12)
     metric = capture_statsd_call do
       StatsD.distribution('values.foobar', tags: ['test'], sample_rate: 0.9) { 'foo' }
     end
@@ -253,9 +207,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_key_value
-    result = nil
-    metric = capture_statsd_call { result = StatsD.key_value('values.foobar', 42) }
-    assert_equal metric, result
+    metric = capture_statsd_call { StatsD.key_value('values.foobar', 42) }
     assert_equal :kv, metric.type
     assert_equal 'values.foobar', metric.name
     assert_equal 42, metric.value
@@ -277,6 +229,21 @@ class StatsDTest < Minitest::Test
     assert_equal ['first_tag:first_value', 'second_tag:second_value'], StatsD.default_tags
   end
 
+  def test_name_prefix
+    StatsD.stubs(:prefix).returns('prefix')
+    m = capture_statsd_call { StatsD.increment('counter') }
+    assert_equal 'prefix.counter', m.name
+
+    m = capture_statsd_call { StatsD.increment('counter', no_prefix: true) }
+    assert_equal 'counter', m.name
+
+    m = capture_statsd_call { StatsD.increment('counter', prefix: "foobar") }
+    assert_equal 'foobar.counter', m.name
+
+    m = capture_statsd_call { StatsD.increment('counter', prefix: "foobar", no_prefix: true) }
+    assert_equal 'counter', m.name
+  end
+
   protected
 
   def capture_statsd_call(&block)

data/test/test_helper.rb

@@ -9,4 +9,15 @@ require 'set'
 require 'logger'
 require 'statsd-instrument'
 
-StatsD.logger = Logger.new('/dev/null')
+require_relative 'helpers/rubocop_helper'
+
+require 'statsd/instrument/strict' if ENV['STATSD_STRICT_MODE']
+
+module StatsD::Instrument
+  def self.strict_mode_enabled?
+    StatsD::Instrument.const_defined?(:Strict) &&
+      StatsD.singleton_class.ancestors.include?(StatsD::Instrument::Strict)
+  end
+end
+
+StatsD.logger = Logger.new(File::NULL)

data/test/udp_backend_test.rb

@@ -148,11 +148,19 @@ class UDPBackendTest < Minitest::Test
     StatsD.key_value('fooy', 42)
   end
 
+  # For key_value metrics (only supported by statsite), the sample rate
+  # part of the datagram format is (ab)used to be set to a timestamp instead.
+  # Changing that to `sample_rate: timestamp` does not make sense, so we
+  # disable the rubocop rule for positional arguments for now,
+  # until we figure out how we want to handle this.
+
+  # rubocop:disable StatsD/PositionalArguments
   def test_supports_key_value_with_timestamp_on_statsite
     @backend.implementation = :statsite
     @backend.expects(:write_packet).with("fooy:42|kv|@123456\n")
     StatsD.key_value('fooy', 42, 123456)
   end
+  # rubocop:enable StatsD/PositionalArguments
 
   def test_warn_when_using_key_value_and_not_on_statsite
     @backend.implementation = :other

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -120,6 +120,7 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/probots.yml"
+- ".github/workflows/benchmark.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml"
@@ -130,6 +131,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark/README.md
+- benchmark/send-metrics-to-dev-null-log
+- benchmark/send-metrics-to-local-udp-receiver
 - lib/statsd-instrument.rb
 - lib/statsd/instrument.rb
 - lib/statsd/instrument/assertions.rb
@@ -144,20 +148,34 @@ files:
 - lib/statsd/instrument/metric.rb
 - lib/statsd/instrument/metric_expectation.rb
 - lib/statsd/instrument/railtie.rb
+- lib/statsd/instrument/rubocop/metaprogramming_positional_arguments.rb
+- lib/statsd/instrument/rubocop/metric_return_value.rb
+- lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
+- lib/statsd/instrument/rubocop/positional_arguments.rb
+- lib/statsd/instrument/rubocop/splat_arguments.rb
+- lib/statsd/instrument/strict.rb
 - lib/statsd/instrument/version.rb
 - shipit.rubygems.yml
 - statsd-instrument.gemspec
 - test/assertions_test.rb
+- test/benchmark/clock_gettime.rb
 - test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
 - test/capture_backend_test.rb
+- test/deprecations_test.rb
 - test/environment_test.rb
+- test/helpers/rubocop_helper.rb
 - test/helpers_test.rb
 - test/integration_test.rb
 - test/logger_backend_test.rb
 - test/matchers_test.rb
 - test/metric_test.rb
+- test/rubocop/metaprogramming_positional_arguments_test.rb
+- test/rubocop/metric_return_value_test.rb
+- test/rubocop/metric_value_keyword_argument_test.rb
+- test/rubocop/positional_arguments_test.rb
+- test/rubocop/splat_arguments_test.rb
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb
 - test/test_helper.rb
@@ -187,16 +205,24 @@ specification_version: 4
 summary: A StatsD client for Ruby apps
 test_files:
 - test/assertions_test.rb
+- test/benchmark/clock_gettime.rb
 - test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
 - test/capture_backend_test.rb
+- test/deprecations_test.rb
 - test/environment_test.rb
+- test/helpers/rubocop_helper.rb
 - test/helpers_test.rb
 - test/integration_test.rb
 - test/logger_backend_test.rb
 - test/matchers_test.rb
 - test/metric_test.rb
+- test/rubocop/metaprogramming_positional_arguments_test.rb
+- test/rubocop/metric_return_value_test.rb
+- test/rubocop/metric_value_keyword_argument_test.rb
+- test/rubocop/positional_arguments_test.rb
+- test/rubocop/splat_arguments_test.rb
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb
 - test/test_helper.rb