statsd-instrument 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94982ff8dbf8c0e2b32a7ffdadbf683253b621c1acb40c1a87c3f02d1fa9f516
-  data.tar.gz: b13215159f2f939e5afa426a9fecaf9bdd03227d670bca6299140cfb3102f780
+  metadata.gz: 9a8a68ce2f902140d3efb1526ae9295949002c0cf2c6922544e0215f58b2bfc7
+  data.tar.gz: 273baedb9f0446ec0919e707d858d6543d4a585331e15c683da04673a4e60cee
 SHA512:
-  metadata.gz: 2a699f95247928c560a4cdf4af97eee07053bff488f969ccf1b269c1fcdb3973221127f116a5c97901bf9c2ac7f46d3f2fddd02dd2db3fdc1aa8ccaafe0cf3cd
-  data.tar.gz: 9c536d216d5a016971744490e4f92c8bcb563a53c0efbd01cae08201a20c15b744cee9097a7d34d4d64c6aea0af9dc8653843ba54af9fa9af96837399f159dea
+  metadata.gz: 8b90db7e6b18013c889e5ecd1243f9035a8fa5781634daffbaa028157859a2a6d7652a3ef5d110ccb3fe2b28b91f5c7c434e0e086d62472c2175a0838009ff81
+  data.tar.gz: 0a694681d1dde4799f082bc515594d43da648d115571b0d5ab4456e2df4a1ab3973c7e99e90379fab6112f834e4f43cf5fdc3b593f82fe737e61d3e4a50c4f1d

data/CHANGELOG.md

@@ -6,7 +6,26 @@ section below.
 
 ### Unreleased changes
 
-_Nothing yet!_
+_Nothing yet_
+
+## Version 2.8.0
+
+- ⚠️ Remove support for `assert_statsd_*(..., ignore_tags: ...)`. This feature
+  was never documented, and the only use case we were aware of has been
+  addressed since. It's highly unlikely that you are using this feature.
+  However, if you are, you can capture StatsD datagrams using the
+  `capture_statsd_datagrams` method, and run your own assertions on the list.
+- ⚠️ Remove `StatsD.client`. This was added in version 2.6.0 in order to
+  experiment with the new client. However, at this point thereare better ways
+  to do this.
+  - You can set `StatsD.singleton_client` to a new client, which causes the
+    calls to the StatsD singleton to be handled by a new client. If you set
+    `STATSD_USE_NEW_CLIENT`, it will be initialized to a new client.
+  - If that doesn't work for you, you can instantiate a client using
+    `StatsD::Instrument::Client.from_env` and assign it to a variable of your
+    own choosing.
+- Fix some compatibility issues when using `assert_statsd_*` methods when
+  using a new client with prefix.
 
 ## Version 2.7.1
 

data/lib/statsd/instrument.rb

@@ -381,7 +381,7 @@ module StatsD
   end
 
   attr_accessor :logger
-  attr_writer :client, :singleton_client
+  attr_writer :singleton_client
 
   extend Forwardable
 
@@ -390,11 +390,7 @@ module StatsD
   end
 
   def singleton_client
-    @singleton_client ||= StatsD::Instrument::Environment.from_env.client
-  end
-
-  def client
-    @client ||= StatsD::Instrument::Environment.from_env.default_client
+    @singleton_client ||= StatsD::Instrument::Environment.current.client
   end
 
   # Singleton methods will be delegated to the singleton client.

data/lib/statsd/instrument/client.rb

@@ -15,15 +15,48 @@ require 'statsd/instrument/log_sink'
 #   next major release of this library. While this class may already be functional,
 #   we provide no guarantees about the API and the behavior may change.
 class StatsD::Instrument::Client
+  class << self
+    def from_env(
+      env = StatsD::Instrument::Environment.current,
+      prefix: env.statsd_prefix,
+      default_sample_rate: env.statsd_sample_rate,
+      default_tags: env.statsd_default_tags,
+      implementation: env.statsd_implementation,
+      sink: env.default_sink_for_environment,
+      datagram_builder_class: datagram_builder_class_for_implementation(implementation)
+    )
+      new(
+        prefix: prefix,
+        default_sample_rate: default_sample_rate,
+        default_tags: default_tags,
+        implementation: implementation,
+        sink: sink,
+        datagram_builder_class: datagram_builder_class,
+      )
+    end
+
+    # @private
+    def datagram_builder_class_for_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
+  end
+
   attr_reader :sink, :datagram_builder_class, :prefix, :default_tags, :default_sample_rate
 
   def initialize(
-    sink: StatsD::Instrument::NullSink.new,
     prefix: nil,
-    default_sample_rate: 1,
+    default_sample_rate: 1.0,
     default_tags: nil,
     implementation: 'datadog',
-    datagram_builder_class: datagram_builder_class_from_implementation(implementation)
+    sink: StatsD::Instrument::NullSink.new,
+    datagram_builder_class: self.class.datagram_builder_class_for_implementation(implementation)
   )
     @sink = sink
     @datagram_builder_class = datagram_builder_class
@@ -35,17 +68,6 @@ 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.

data/lib/statsd/instrument/environment.rb

@@ -4,8 +4,8 @@
 # which this library is active. It will use different default values based on the environment.
 class StatsD::Instrument::Environment
   class << self
-    def from_env
-      @from_env ||= StatsD::Instrument::Environment.new(ENV)
+    def current
+      @current ||= StatsD::Instrument::Environment.new(ENV)
     end
 
     # Detects the current environment, either by asking Rails, or by inspecting environment variables.
@@ -16,7 +16,7 @@ class StatsD::Instrument::Environment
     #
     # @return [String] The detected environment.
     def environment
-      from_env.environment
+      current.environment
     end
 
     # Instantiates a default backend for the current environment.
@@ -26,7 +26,7 @@ class StatsD::Instrument::Environment
     def default_backend
       case environment
       when 'production', 'staging'
-        StatsD::Instrument::Backends::UDPBackend.new(from_env.statsd_addr, from_env.statsd_implementation)
+        StatsD::Instrument::Backends::UDPBackend.new(current.statsd_addr, current.statsd_implementation)
       when 'test'
         StatsD::Instrument::Backends::NullBackend.new
       else
@@ -45,9 +45,9 @@ class StatsD::Instrument::Environment
     #
     # @return [void]
     def setup
-      StatsD.prefix = from_env.statsd_prefix
-      StatsD.default_tags = from_env.statsd_default_tags
-      StatsD.default_sample_rate = from_env.statsd_sample_rate
+      StatsD.prefix = current.statsd_prefix
+      StatsD.default_tags = current.statsd_default_tags
+      StatsD.default_sample_rate = current.statsd_sample_rate
       StatsD.logger = Logger.new($stderr)
     end
   end
@@ -97,22 +97,12 @@ class StatsD::Instrument::Environment
 
   def client
     if env.key?('STATSD_USE_NEW_CLIENT')
-      default_client
+      StatsD::Instrument::Client.from_env(self)
     else
       StatsD::Instrument::LegacyClient.singleton
     end
   end
 
-  def default_client
-    @default_client ||= StatsD::Instrument::Client.new(
-      sink: default_sink_for_environment,
-      implementation: statsd_implementation,
-      default_sample_rate: statsd_sample_rate,
-      prefix: statsd_prefix,
-      default_tags: statsd_default_tags,
-    )
-  end
-
   def default_sink_for_environment
     case environment
     when 'production', 'staging'

data/lib/statsd/instrument/expectation.rb

@@ -33,15 +33,15 @@ class StatsD::Instrument::Expectation
   end
 
   attr_accessor :times, :type, :name, :value, :sample_rate, :tags
-  attr_reader :ignore_tags
 
-  def initialize(type:, name:, value: nil, sample_rate: nil, tags: nil, ignore_tags: nil, no_prefix: false, times: 1)
+  def initialize(client: StatsD.singleton_client, type:, name:, value: nil,
+    sample_rate: nil, tags: nil, no_prefix: false, times: 1)
+
     @type = type
-    @name = StatsD.prefix ? "#{StatsD.prefix}.#{name}" : name unless no_prefix
+    @name = client.prefix ? "#{client.prefix}.#{name}" : name unless no_prefix
     @value = normalized_value_for_type(type, value) if value
     @sample_rate = sample_rate
     @tags = StatsD::Instrument::Metric.normalize_tags(tags)
-    @ignore_tags = StatsD::Instrument::Metric.normalize_tags(ignore_tags)
     @times = times
   end
 
@@ -61,16 +61,6 @@ class StatsD::Instrument::Expectation
     if tags
       expected_tags = Set.new(tags)
       actual_tags = Set.new(actual_metric.tags)
-
-      if ignore_tags
-        ignored_tags = Set.new(ignore_tags) - expected_tags
-        actual_tags -= ignored_tags
-
-        if ignore_tags.is_a?(Array)
-          actual_tags.delete_if { |key| ignore_tags.include?(key.split(":").first) }
-        end
-      end
-
       return expected_tags.subset?(actual_tags)
     end
     true

data/lib/statsd/instrument/version.rb

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

data/test/assertions_on_legacy_client_test.rb

@@ -98,38 +98,6 @@ class AssertionsOnLegacyClientTest < Minitest::Test
       StatsD.increment('counter', sample_rate: 0.5, tags: ['a', 'b'])
     end
 
-    assert_raises(Minitest::Assertion) do
-      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a', 'b'], ignore_tags: ['b']) do
-        StatsD.increment('counter', sample_rate: 0.5, tags: ['a'])
-      end
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a'], ignore_tags: ['b']) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: ['a', 'b'])
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a'], ignore_tags: ['b']) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: ['a'])
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: { b: 2 }) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: { b: 2 }) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 3 })
-    end
-
-    assert_raises(Minitest::Assertion) do
-      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1, b: 3 }, ignore_tags: ['b']) do
-        StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
-      end
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: ['b']) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
-    end
-
     assert_raises(Minitest::Assertion) do
       @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a', 'b']) do
         StatsD.increment('counter', sample_rate: 0.2, tags: ['c'])

data/test/assertions_test.rb

@@ -6,7 +6,7 @@ class AssertionsTest < Minitest::Test
   def setup
     @old_client = StatsD.singleton_client
     env = StatsD::Instrument::Environment.new('STATSD_IMPLEMENTATION' => 'datadog')
-    StatsD.singleton_client = env.default_client
+    StatsD.singleton_client = StatsD::Instrument::Client.from_env(env)
 
     test_class = Class.new(Minitest::Test)
     test_class.send(:include, StatsD::Instrument::Assertions)
@@ -99,38 +99,6 @@ class AssertionsTest < Minitest::Test
       StatsD.increment('counter', sample_rate: 0.5, tags: ['a', 'b'])
     end
 
-    assert_raises(Minitest::Assertion) do
-      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a', 'b'], ignore_tags: ['b']) do
-        StatsD.increment('counter', sample_rate: 0.5, tags: ['a'])
-      end
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a'], ignore_tags: ['b']) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: ['a', 'b'])
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a'], ignore_tags: ['b']) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: ['a'])
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: { b: 2 }) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: { b: 2 }) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 3 })
-    end
-
-    assert_raises(Minitest::Assertion) do
-      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1, b: 3 }, ignore_tags: ['b']) do
-        StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
-      end
-    end
-
-    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: ['b']) do
-      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
-    end
-
     assert_raises(Minitest::Assertion) do
       @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a', 'b']) do
         StatsD.increment('counter', sample_rate: 0.2, tags: ['c'])

data/test/client_test.rb

@@ -8,6 +8,57 @@ class ClientTest < Minitest::Test
     @dogstatsd_client = StatsD::Instrument::Client.new(implementation: 'datadog')
   end
 
+  def test_client_from_env
+    env = StatsD::Instrument::Environment.new(
+      'STATSD_ENV' => 'production',
+      'STATSD_SAMPLE_RATE' => '0.1',
+      'STATSD_PREFIX' => 'foo',
+      'STATSD_DEFAULT_TAGS' => 'shard:1,env:production',
+      'STATSD_IMPLEMENTATION' => 'statsd',
+      'STATSD_ADDR' => '1.2.3.4:8125',
+    )
+    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_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
+  end
+
+  def test_client_from_env_with_overrides
+    env = StatsD::Instrument::Environment.new(
+      'STATSD_SAMPLE_RATE' => '0.1',
+      'STATSD_PREFIX' => 'foo',
+      'STATSD_DEFAULT_TAGS' => 'shard:1,env:production',
+      'STATSD_IMPLEMENTATION' => 'statsd',
+      'STATSD_ADDR' => '1.2.3.4:8125',
+    )
+    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_kind_of StatsD::Instrument::NullSink, client.sink
+  end
+
   def test_capture
     inner_datagrams = nil
 

data/test/environment_test.rb

@@ -62,52 +62,33 @@ class EnvironmentTest < Minitest::Test
     assert_equal 'development', env.environment
   end
 
-  def test_default_client_uses_log_sink_in_development_environment
-    env = StatsD::Instrument::Environment.new('STATSD_ENV' => 'development')
-    assert_kind_of StatsD::Instrument::LogSink, env.default_client.sink
+  def test_legacy_client_is_default_client
+    env = StatsD::Instrument::Environment.new({})
+    assert_kind_of StatsD::Instrument::LegacyClient, env.client
   end
 
-  def test_default_client_uses_null_sink_in_test_environment
-    env = StatsD::Instrument::Environment.new('STATSD_ENV' => 'test')
-    assert_kind_of StatsD::Instrument::NullSink, env.default_client.sink
+  def test_client_returns_new_client_if_envcironment_asks_for_it
+    env = StatsD::Instrument::Environment.new('STATSD_USE_NEW_CLIENT' => '1')
+    assert_kind_of StatsD::Instrument::Client, env.client
   end
 
-  def test_default_client_uses_udp_sink_in_staging_environment
-    env = StatsD::Instrument::Environment.new('STATSD_ENV' => 'staging')
-    assert_kind_of StatsD::Instrument::UDPSink, env.default_client.sink
+  def test_client_from_env_uses_log_sink_in_development_environment
+    env = StatsD::Instrument::Environment.new('STATSD_USE_NEW_CLIENT' => '1', 'STATSD_ENV' => 'development')
+    assert_kind_of StatsD::Instrument::LogSink, env.client.sink
   end
 
-  def test_default_client_uses_udp_sink_in_production_environment
-    env = StatsD::Instrument::Environment.new('STATSD_ENV' => 'production')
-    assert_kind_of StatsD::Instrument::UDPSink, env.default_client.sink
+  def test_client_from_env_uses_null_sink_in_test_environment
+    env = StatsD::Instrument::Environment.new('STATSD_USE_NEW_CLIENT' => '1', 'STATSD_ENV' => 'test')
+    assert_kind_of StatsD::Instrument::NullSink, env.client.sink
   end
 
-  def test_default_client_respects_statsd_environment_variables
-    env = StatsD::Instrument::Environment.new(
-      'STATSD_ENV' => 'production',
-      'STATSD_IMPLEMENTATION' => 'datadog',
-      'STATSD_ADDR' => 'foo:8125',
-      'STATSD_SAMPLE_RATE' => "0.1",
-      'STATSD_PREFIX' => "foo",
-      'STATSD_DEFAULT_TAGS' => "foo,bar:baz",
-    )
-
-    assert_equal StatsD::Instrument::DogStatsDDatagramBuilder, env.default_client.datagram_builder_class
-    assert_equal 'foo', env.default_client.sink.host
-    assert_equal 8125, env.default_client.sink.port
-    assert_equal 0.1, env.default_client.default_sample_rate
-    assert_equal "foo", env.default_client.prefix
-    assert_equal ["foo", "bar:baz"], env.default_client.default_tags
+  def test_client_from_env_uses_udp_sink_in_staging_environment
+    env = StatsD::Instrument::Environment.new('STATSD_USE_NEW_CLIENT' => '1', 'STATSD_ENV' => 'staging')
+    assert_kind_of StatsD::Instrument::UDPSink, env.client.sink
   end
 
-  def test_default_client_has_sensible_defaults
-    env = StatsD::Instrument::Environment.new('STATSD_ENV' => 'production')
-
-    assert_equal StatsD::Instrument::DogStatsDDatagramBuilder, env.default_client.datagram_builder_class
-    assert_equal 'localhost', env.default_client.sink.host
-    assert_equal 8125, env.default_client.sink.port
-    assert_equal 1.0, env.default_client.default_sample_rate
-    assert_nil env.default_client.prefix
-    assert_nil env.default_client.default_tags
+  def test_client_from_env_uses_udp_sink_in_production_environment
+    env = StatsD::Instrument::Environment.new('STATSD_USE_NEW_CLIENT' => '1', 'STATSD_ENV' => 'production')
+    assert_kind_of StatsD::Instrument::UDPSink, env.client.sink
   end
 end

data/test/helpers_test.rb

@@ -25,7 +25,7 @@ class HelpersTest < Minitest::Test
 
   def test_capture_metrics_with_new_client
     @old_client = StatsD.singleton_client
-    StatsD.singleton_client = StatsD.client
+    StatsD.singleton_client = StatsD::Instrument::Client.new
 
     StatsD.increment('counter')
     metrics = @test_case.capture_statsd_datagrams do

metadata

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