statsd-instrument 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3929918b255f6be82e1fa81b2f996dbef0f51cabc3fa374c0386bb37cd53f58f
-  data.tar.gz: 322b93e4298c2a5bb2a32934d2c8d6ffb580248a229d5956053ea02aafa0934e
+  metadata.gz: 94982ff8dbf8c0e2b32a7ffdadbf683253b621c1acb40c1a87c3f02d1fa9f516
+  data.tar.gz: b13215159f2f939e5afa426a9fecaf9bdd03227d670bca6299140cfb3102f780
 SHA512:
-  metadata.gz: b7a72b5b53f07719d207a91d37b30eb78d13f6c06f26566f8450c4e14b50bc9095498c19c12cb440484292f31e9a890d97ab478c4fced766ff55f0c2b32b8ea8
-  data.tar.gz: fb2d2484b3dd9c6533fd6c445ab7871400d3fa5e06545303ef373f3d566ad0dcf1638a40228f84fb321b0a52c60e687a119e13b08664f385aaa03695604f339e
+  metadata.gz: 2a699f95247928c560a4cdf4af97eee07053bff488f969ccf1b269c1fcdb3973221127f116a5c97901bf9c2ac7f46d3f2fddd02dd2db3fdc1aa8ccaafe0cf3cd
+  data.tar.gz: 9c536d216d5a016971744490e4f92c8bcb563a53c0efbd01cae08201a20c15b744cee9097a7d34d4d64c6aea0af9dc8653843ba54af9fa9af96837399f159dea

data/CHANGELOG.md

@@ -8,6 +8,17 @@ section below.
 
 _Nothing yet!_
 
+## Version 2.7.1
+
+This release has some small fixes related to the new client only:
+
+- Bugfix: Fix the metaprogramming methods so they work with a new client when
+  strict mode is _not_ enabled.
+- Make it easier to instantiate new clients by specifying an implementation
+  (e.g. `datadog`) rather than a DatagramBuilder class.
+- Change `NullSink#sample?` to always return `true`, so it's easier to verify
+  business rules by using a different DatabagramBuilder in test suites.
+
 ## Version 2.7.0
 
 This release allows you to switch the StatsD singleton to use the new, more
@@ -26,7 +37,7 @@ and fix deprecations in your code base.
   calls on the `StatsD` singleton will be delegated to this legacy client.
 - By setting `STATSD_USE_NEW_CLIENT` as environment variable, these method
   calls will be delegated to an instance of the new client instead. This
-  client is configured using the xisting `STATD_*` environment variables,
+  client is configured using the existing `STATD_*` environment variables,
   like `STATSD_ADDR` and `STATSD_IMPLEMENTATION`.
 - You can also assign a custom client to `StatsD.singleton_client`.
 
@@ -57,6 +68,11 @@ datagrams coming from a legacy client, or from a new client.
   This makes it easy to run multiple assertions on the set of metrics that
   was emitted without having to nest calls.
 
+- **⚠️ DEPRECATION** The `assert_statsd_*`-family of methods now use keyword
+  arguments, rather than option hashes. This means that calls that use
+  unsupported arguments will raise an `ArgumentError` now, rather than silently
+  ignoring unknown keys.
+
 - **⚠️ DEPRECATION**: The following methods to configure the legacy client
   are deprecated:
 
@@ -201,7 +217,7 @@ s
 
   See #193, #184, and #166 for more information.
 
-## Verison 2.5.1
+## Version 2.5.1
 
 - **Bugfix:** when using metaprogramming methods, changes to `StatsD.prefix` after
   the metaprogramming method was evaluated would not be respected. This

data/lib/statsd/instrument.rb

@@ -104,8 +104,10 @@ module StatsD
     end
 
     # @private
-    def self.generate_metric_name(metric_name, callee, *args)
-      metric_name.respond_to?(:call) ? metric_name.call(callee, args).gsub('::', '.') : metric_name.gsub('::', '.')
+    def self.generate_metric_name(prefix, key, callee, *args)
+      name = key.respond_to?(:call) ? key.call(callee, args).gsub('::', '.') : key.gsub('::', '.')
+      name = "#{prefix}.#{name}" if prefix
+      name
     end
 
     # Even though this method is considered private, and is no longer used internally,
@@ -140,13 +142,16 @@ module StatsD
     def statsd_measure(method, name, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil, as_dist: false,
       sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: nil, no_prefix: false)
 
+      if as_dist
+        return statsd_distribution(method, name, # rubocop:disable StatsD/MetricPrefixArgument
+          sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
+      end
+
       add_to_method(method, name, :measure) do
         define_method(method) do |*args, &block|
-          key = StatsD::Instrument.generate_metric_name(name, self, *args)
-          prefix ||= StatsD.prefix
-          StatsD.measure( # rubocop:disable StatsD/MeasureAsDistArgument, StatsD/MetricPrefixArgument
-            key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix, as_dist: as_dist
-          ) do
+          prefix ||= StatsD.prefix unless no_prefix
+          key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
+          StatsD.measure(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
             super(*args, &block)
           end
         end
@@ -166,11 +171,9 @@ module StatsD
 
       add_to_method(method, name, :distribution) do
         define_method(method) do |*args, &block|
-          key = StatsD::Instrument.generate_metric_name(name, self, *args)
-          prefix ||= StatsD.prefix
-          StatsD.distribution( # rubocop:disable StatsD/MetricPrefixArgument
-            key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix
-          ) do
+          prefix ||= StatsD.prefix unless no_prefix
+          key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
+          StatsD.distribution(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
             super(*args, &block)
           end
         end
@@ -213,10 +216,9 @@ module StatsD
             result
           ensure
             suffix = truthiness == false ? 'failure' : 'success'
-            key = "#{StatsD::Instrument.generate_metric_name(name, self, *args)}.#{suffix}"
-            prefix ||= StatsD.prefix
-            StatsD.increment(key, prefix: prefix, # rubocop:disable StatsD/MetricPrefixArgument
-              sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
+            prefix ||= StatsD.prefix unless no_prefix
+            key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
+            StatsD.increment("#{key}.#{suffix}", sample_rate: sample_rate, tags: tags, no_prefix: true)
           end
         end
       end
@@ -255,10 +257,9 @@ module StatsD
             result
           ensure
             if truthiness
-              key = StatsD::Instrument.generate_metric_name(name, self, *args)
-              prefix ||= StatsD.prefix
-              StatsD.increment(key, prefix: prefix, # rubocop:disable StatsD/MetricPrefixArgument
-                sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
+              prefix ||= StatsD.prefix unless no_prefix
+              key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
+              StatsD.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
             end
           end
         end
@@ -279,10 +280,9 @@ module StatsD
 
       add_to_method(method, name, :count) do
         define_method(method) do |*args, &block|
-          key = StatsD::Instrument.generate_metric_name(name, self, *args)
-          prefix ||= StatsD.prefix
-          StatsD.increment(key, prefix: prefix, # rubocop:disable StatsD/MetricPrefixArgument
-            sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
+          prefix ||= StatsD.prefix unless no_prefix
+          key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
+          StatsD.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
           super(*args, &block)
         end
       end

data/lib/statsd/instrument/client.rb

@@ -22,7 +22,8 @@ class StatsD::Instrument::Client
     prefix: nil,
     default_sample_rate: 1,
     default_tags: nil,
-    datagram_builder_class: StatsD::Instrument::StatsDDatagramBuilder
+    implementation: 'datadog',
+    datagram_builder_class: datagram_builder_class_from_implementation(implementation)
   )
     @sink = sink
     @datagram_builder_class = datagram_builder_class
@@ -34,6 +35,17 @@ class StatsD::Instrument::Client
     @datagram_builder = { false => nil, true => nil }
   end
 
+  def datagram_builder_class_from_implementation(implementation)
+    case implementation.to_s
+    when 'statsd'
+      StatsD::Instrument::StatsDDatagramBuilder
+    when 'datadog', 'dogstatsd'
+      StatsD::Instrument::DogStatsDDatagramBuilder
+    else
+      raise NotImplementedError, "No implementation for #{statsd_implementation}"
+    end
+  end
+
   # @!group Metric Methods
 
   # Emits a counter metric.
@@ -96,7 +108,7 @@ class StatsD::Instrument::Client
   #
   # You should use a gauge if you are reporting the current value of
   # something that can only have one value at the time. E.g., the
-  # speed of your car. A newly reported value will repla e the previously
+  # speed of your car. A newly reported value will replace the previously
   # reported value.
   #
   #
@@ -271,7 +283,7 @@ class StatsD::Instrument::Client
   def capture_sink
     StatsD::Instrument::CaptureSink.new(
       parent: @sink,
-      datagram_class: datagram_builder(no_prefix: false).datagram_class,
+      datagram_class: datagram_builder_class.datagram_class,
     )
   end
 

data/lib/statsd/instrument/datagram_builder.rb

@@ -23,6 +23,10 @@ class StatsD::Instrument::DatagramBuilder
     end
   end
 
+  def self.datagram_class
+    StatsD::Instrument::Datagram
+  end
+
   def initialize(prefix: nil, default_tags: nil)
     @prefix = prefix.nil? ? "" : "#{normalize_name(prefix)}."
     @default_tags = normalize_tags(default_tags)
@@ -56,10 +60,6 @@ class StatsD::Instrument::DatagramBuilder
     generate_generic_datagram(name, value, 'kv', sample_rate, tags)
   end
 
-  def datagram_class
-    StatsD::Instrument::Datagram
-  end
-
   def latency_metric_type
     :ms
   end

data/lib/statsd/instrument/environment.rb

@@ -106,24 +106,13 @@ class StatsD::Instrument::Environment
   def default_client
     @default_client ||= StatsD::Instrument::Client.new(
       sink: default_sink_for_environment,
-      datagram_builder_class: default_datagram_builder_class_for_implementation,
+      implementation: statsd_implementation,
       default_sample_rate: statsd_sample_rate,
       prefix: statsd_prefix,
       default_tags: statsd_default_tags,
     )
   end
 
-  def default_datagram_builder_class_for_implementation
-    case statsd_implementation
-    when 'statsd'
-      StatsD::Instrument::StatsDDatagramBuilder
-    when 'datadog', 'dogstatsd'
-      StatsD::Instrument::DogStatsDDatagramBuilder
-    else
-      raise NotImplementedError, "No implementation for #{statsd_implementation}"
-    end
-  end
-
   def default_sink_for_environment
     case environment
     when 'production', 'staging'

data/lib/statsd/instrument/null_sink.rb

@@ -4,7 +4,7 @@
 #   to become the new default in the next major release of this library.
 class StatsD::Instrument::NullSink
   def sample?(_sample_rate)
-    false
+    true
   end
 
   def <<(_datagram)

data/lib/statsd/instrument/strict.rb

@@ -114,7 +114,7 @@ module StatsD
         # Stats.measure call to not use the `as_dist` and `prefix` arguments.
         add_to_method(method, name, :measure) do
           define_method(method) do |*args, &block|
-            key = StatsD::Instrument.generate_metric_name(name, self, *args)
+            key = StatsD::Instrument.generate_metric_name(nil, name, self, *args)
             StatsD.measure(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix) do
               super(*args, &block)
             end
@@ -130,7 +130,7 @@ module StatsD
 
         add_to_method(method, name, :distribution) do
           define_method(method) do |*args, &block|
-            key = StatsD::Instrument.generate_metric_name(name, self, *args)
+            key = StatsD::Instrument.generate_metric_name(nil, name, self, *args)
             StatsD.distribution(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix) do
               super(*args, &block)
             end
@@ -162,7 +162,7 @@ module StatsD
               result
             ensure
               suffix = truthiness == false ? 'failure' : 'success'
-              key = "#{StatsD::Instrument.generate_metric_name(name, self, *args)}.#{suffix}"
+              key = "#{StatsD::Instrument.generate_metric_name(nil, name, self, *args)}.#{suffix}"
               StatsD.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
             end
           end
@@ -193,7 +193,7 @@ module StatsD
               result
             ensure
               if truthiness
-                key = StatsD::Instrument.generate_metric_name(name, self, *args)
+                key = StatsD::Instrument.generate_metric_name(nil, name, self, *args)
                 StatsD.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
               end
             end
@@ -209,7 +209,7 @@ module StatsD
 
         add_to_method(method, name, :count) do
           define_method(method) do |*args, &block|
-            key = StatsD::Instrument.generate_metric_name(name, self, *args)
+            key = StatsD::Instrument.generate_metric_name(nil, name, self, *args)
             StatsD.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
             super(*args, &block)
           end

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "2.7.0"
+    VERSION = "2.7.1"
   end
 end

data/test/client_test.rb

@@ -5,9 +5,7 @@ require 'test_helper'
 class ClientTest < Minitest::Test
   def setup
     @client = StatsD::Instrument::Client.new(datagram_builder_class: StatsD::Instrument::StatsDDatagramBuilder)
-    @dogstatsd_client = StatsD::Instrument::Client.new(
-      datagram_builder_class: StatsD::Instrument::DogStatsDDatagramBuilder,
-    )
+    @dogstatsd_client = StatsD::Instrument::Client.new(implementation: 'datadog')
   end
 
   def test_capture

data/test/null_sink_test.rb

@@ -8,4 +8,10 @@ class NullSinktest < Minitest::Test
     null_sink << 'foo:1|c' << 'bar:1|c'
     pass # We don't have anything to assert, except that no exception was raised
   end
+
+  def test_null_sink_sample
+    null_sink = StatsD::Instrument::NullSink.new
+    assert null_sink.sample?(0), "The null sink should always sample"
+    assert null_sink.sample?(1), "The null sink should always sample"
+  end
 end

data/test/statsd_instrumentation_test.rb

@@ -417,6 +417,32 @@ class StatsDInstrumentationTest < Minitest::Test
     end
   end
 
+  def test_statsd_measure_with_new_client
+    old_client = StatsD.singleton_client
+    StatsD.singleton_client = StatsD::Instrument::Client.new
+
+    ActiveMerchant::UniqueGateway.statsd_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post', sample_rate: 0.3
+    assert_statsd_measure('ActiveMerchant.Gateway.ssl_post', sample_rate: 0.3) do
+      ActiveMerchant::UniqueGateway.new.purchase(true)
+    end
+  ensure
+    ActiveMerchant::UniqueGateway.statsd_remove_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+    StatsD.singleton_client = old_client
+  end
+
+  def test_statsd_count_with_new_client
+    old_client = StatsD.singleton_client
+    StatsD.singleton_client = StatsD::Instrument::Client.new
+
+    ActiveMerchant::Gateway.statsd_count :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+    assert_statsd_increment('ActiveMerchant.Gateway.ssl_post') do
+      ActiveMerchant::Gateway.new.purchase(true)
+    end
+  ensure
+    ActiveMerchant::Gateway.statsd_remove_count :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+    StatsD.singleton_client = old_client
+  end
+
   private
 
   def assert_scope(klass, method, expected_scope)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake