statsd-instrument 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c798557b1db75029e1efded949cee656fe0b33b77e3c1c13edde73be5e4957
-  data.tar.gz: 46b43c2589e9d0628cab7d070a4163e6bfa6d54e7b03b8d85681e0bf29d2c733
+  metadata.gz: 921e9b4ecf3a6a74cfb1460767ba4374121723d9ef2a7bd76b747904a25a7b48
+  data.tar.gz: b62df176782d7aca1f24608015db7b68b610af386c7c30309517e39de3551dfe
 SHA512:
-  metadata.gz: 6b09c458ef308d1afbf8264a44f1399a00863e607afd0ad3bd43b297976130e50663e9c4cd9fa17490ad4f283faef9f15b41fc9283bac7500b87dbd21af89a5a
-  data.tar.gz: d52f9d40110e812ece11a3d87d52013df1f18e96f0a88ea8c1411950d17926a7936954839cb5e6d374c63745499e3f9e379607bf5432880643bb03b32b7eabb2
+  metadata.gz: 3d1ff5390d8cd5dc611e42dc4667894a0c82e406d92cd51d6a71ff4cd7ffa1e747e56f8f19d483c28335a4b5a616848356fc23f50787276883aafe17b043316d
+  data.tar.gz: 542ad17d646c28b691287db6debc18a6386a332aa148d2549c60602aaab0427bb836bd755e701495aec9db856a7fa387ddbea5de3e85f7d5c973ec9d52d3c008

data/CHANGELOG.md

@@ -6,7 +6,70 @@ section below.
 
 ### Unreleased changes
 
-_Nothing yet_
+- Several improvements to `StatsD.event` and `StatsD.service_check` (both are
+  Datadog-only). The previous implementation would sometimes construct invalid
+  datagrams based on the input. The method signatures have been made more
+  explicit, and documentation of these methods is now also more clear.
+
+- Slight behaviour change when using the `assert_statsd_*` assertion methods in
+  combination with `assert_raises`: we now do not allow the block passed to the
+  `assert_statsd_` call to raise an exception. This may cause tests to fail that
+  previousloy were succeeding.
+
+  Consider the following example:
+
+  ``` ruby
+  assert_raises(RuntimeError)
+    assert_statsd_increment('foo') do
+      raise 'something unexpected'
+    end
+  end
+  ```
+
+  In versions before 2.3.3, the assert `assert_statsd_*` calls would silently
+  pass when an exception would occur, which would later be handled by
+  `assert_raises`. So the test would pass, even though no `foo` metric would be
+  emitted.
+
+  Version 2.3.3 changed this by failing the test because no metric was being
+  emitted. However, this would hide the the exception from the assertion message,
+  complicating debugging efforts.
+
+  Now, we fail the test because an unexpected exception occured inside the block.
+  This means that the following test will fail:
+
+  ``` ruby
+  assert_raises(RuntimeError)
+    assert_statsd_increment('foo') do
+      StatsD.increment('foo')
+      raise 'something unexpected'
+    end
+  end
+  ```
+
+  To fix, you will need to nest the `assert_raises` inside the block passed to
+  `assert_statsd_instrument` so that `assert_statsd_increment` will not see any
+  exceptions:
+
+  ``` ruby
+  assert_statsd_increment('foo') do
+    assert_raises(RuntimeError)
+      StatsD.increment('foo')
+      raise 'something unexpected'
+    end
+  end
+  ```
+
+  See #193, #184, and #166 for more information.
+
+## Version 2.5.1
+
+- **Bugfix:** when using metaprogramming methods, changes to `StatsD.prefix` after
+  the metaprogramming method was evaluated would not be respected. This
+  unfortunately is quite common when you set the StatsD prefix inside an
+  initializer. This issue is now addressed: the prefix is evaluated at the
+  mopment the metric is emitted, not when the metaprogramming method is being
+  evaluated. (#202)
 
 ## Version 2.5.0
 

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "2.5.0"
+    VERSION = "2.5.1"
   end
 end

data/lib/statsd/instrument.rb

@@ -92,11 +92,12 @@ module StatsD
     # @param metric_options (see StatsD#measure)
     # @return [void]
     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: StatsD.prefix, no_prefix: false)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: nil, no_prefix: false)
 
       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(
             key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix, as_dist: as_dist
           ) do
@@ -115,11 +116,12 @@ module StatsD
     # @return [void]
     # @note Supported by the datadog implementation only (in beta)
     def statsd_distribution(method, name, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: StatsD.prefix, no_prefix: false)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: nil, no_prefix: false)
 
       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(key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix) do
             super(*args, &block)
           end
@@ -143,7 +145,7 @@ module StatsD
     # @return [void]
     # @see #statsd_count_if
     def statsd_count_success(method, name, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: StatsD.prefix, no_prefix: false)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: nil, no_prefix: false)
 
       add_to_method(method, name, :count_success) do
         define_method(method) do |*args, &block|
@@ -164,6 +166,7 @@ module StatsD
           ensure
             suffix = truthiness == false ? 'failure' : 'success'
             key = "#{StatsD::Instrument.generate_metric_name(name, self, *args)}.#{suffix}"
+            prefix ||= StatsD.prefix
             StatsD.increment(key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
           end
         end
@@ -183,7 +186,7 @@ module StatsD
     # @return [void]
     # @see #statsd_count_success
     def statsd_count_if(method, name, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: StatsD.prefix, no_prefix: false)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: nil, no_prefix: false)
 
       add_to_method(method, name, :count_if) do
         define_method(method) do |*args, &block|
@@ -204,6 +207,7 @@ module StatsD
           ensure
             if truthiness
               key = StatsD::Instrument.generate_metric_name(name, self, *args)
+              prefix ||= StatsD.prefix
               StatsD.increment(key, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
             end
           end
@@ -221,11 +225,12 @@ module StatsD
     # @param metric_options (see #statsd_measure)
     # @return [void]
     def statsd_count(method, name, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: StatsD.prefix, no_prefix: false)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg, prefix: nil, no_prefix: false)
 
       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, sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
           super(*args, &block)
         end

data/test/statsd_instrumentation_test.rb

@@ -337,6 +337,48 @@ class StatsDInstrumentationTest < Minitest::Test
     ActiveMerchant::Gateway.singleton_class.statsd_remove_count :sync, 'ActiveMerchant.Gateway.sync'
   end
 
+  def test_statsd_respects_global_prefix_changes
+    StatsD.prefix = 'Foo'
+    ActiveMerchant::Gateway.singleton_class.extend StatsD::Instrument
+    ActiveMerchant::Gateway.singleton_class.statsd_count :sync, 'ActiveMerchant.Gateway.sync'
+    StatsD.prefix = 'Quc'
+
+    statsd_calls = capture_statsd_calls { ActiveMerchant::Gateway.sync }
+    assert_equal 1, statsd_calls.length
+    assert_equal "Quc.ActiveMerchant.Gateway.sync", statsd_calls.first.name
+  ensure
+    StatsD.prefix = nil
+    ActiveMerchant::Gateway.singleton_class.statsd_remove_count :sync, 'ActiveMerchant.Gateway.sync'
+  end
+
+  def test_statsd_macro_can_overwrite_prefix
+    StatsD.prefix = 'Foo'
+    ActiveMerchant::Gateway.singleton_class.extend StatsD::Instrument
+    ActiveMerchant::Gateway.singleton_class.statsd_measure :sync, 'ActiveMerchant.Gateway.sync', prefix: 'Bar'
+    StatsD.prefix = 'Quc'
+
+    statsd_calls = capture_statsd_calls { ActiveMerchant::Gateway.sync }
+    assert_equal 1, statsd_calls.length
+    assert_equal "Bar.ActiveMerchant.Gateway.sync", statsd_calls.first.name
+  ensure
+    StatsD.prefix = nil
+    ActiveMerchant::Gateway.singleton_class.statsd_remove_measure :sync, 'ActiveMerchant.Gateway.sync'
+  end
+
+  def test_statsd_macro_can_disable_prefix
+    StatsD.prefix = 'Foo'
+    ActiveMerchant::Gateway.singleton_class.extend StatsD::Instrument
+    ActiveMerchant::Gateway.singleton_class.statsd_count_success :sync, 'ActiveMerchant.Gateway.sync', no_prefix: true
+    StatsD.prefix = 'Quc'
+
+    statsd_calls = capture_statsd_calls { ActiveMerchant::Gateway.sync }
+    assert_equal 1, statsd_calls.length
+    assert_equal "ActiveMerchant.Gateway.sync.success", statsd_calls.first.name
+  ensure
+    StatsD.prefix = nil
+    ActiveMerchant::Gateway.singleton_class.statsd_remove_count_success :sync, 'ActiveMerchant.Gateway.sync'
+  end
+
   def test_statsd_doesnt_change_method_scope_of_public_method
     assert_scope InstrumentedClass, :public_and_instrumented, :public
 

metadata

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