statsd-instrument 2.3.2 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03ab2f74c3b653690d20eea1102515c64d901f739599816a0813cb9ab748d950
-  data.tar.gz: 528dee5c361d7080a16a6a4da64057cc81596bbd9906eeb220fc731b30feb4f2
+  metadata.gz: a8076b4d86af6ed043e664abf288c4d33a89d324017eeb1a8ae230266352cb9c
+  data.tar.gz: a56269d70cbca5d0788838f96e9515f92cf93b1330d3ef826620c1af5ae0ba72
 SHA512:
-  metadata.gz: 3c4ecdac1ee080fb1f92ca316f24669cccdc803fbb205ce577fbe45a58cb313cae98e9e7e04fc579ab230a99d1ae1353cfafe0d8d7c056ff7a98a3af35d1ea9e
-  data.tar.gz: d9f9161e46aa12696eeaabf9d975cac6a64118e608d2b16978a3528b50459014dbf1f50623a54e8021fba7b504067c6c8a942e4e36907830fa939338588cb60f
+  metadata.gz: 9e922ee94f9bcbf22390cc9ac2e740a539fb63b162d77529d4a32bb058de5e047de8519808457d86f744519fccd9ae639a6c20d022d67f6845add5769af10356
+  data.tar.gz: 50f3c7a81c69d5b26196f38d4716d03b24dbc52147c6c2894edf41dd4e7d7efa7fdc725d4f669213327121eca9d0e771469d3aa4d6b20bb86252d30b5a5b57e9

data/CHANGELOG.md

@@ -5,6 +5,34 @@ please at an entry to the "unreleased changes" section below.
 
 ### Unreleased changes
 
+## Version 2.3.4
+
+- Improve performance of `Metric#to_s` (#152)
+- Fix bug in escaping newlines for events with Datadog Backend (#153)
+
+## Version 2.3.3
+
+- Capture measure and distribution metrics on exception and early return (#134)
+
+NOTE: Now that exceptions are measured statistics may behave differently. An exception example:
+```
+StatsD.measure('myhttpcall') do
+  my_http_object.invoke
+end
+```
+Version 2.3.2 and below did not track metrics whenever a HTTP Timeout exception was raised.
+2.3.3 and above will include those metrics which may increase the values included.
+
+A return example:
+```
+StatsD.measure('myexpensivecalculation') do
+  return if expensive_calculation_disabled?
+  expensive_calculation
+end
+```
+If `expensive_calculation_disabled?` is true 50% of the time version 2.3.2 will drop the
+average metric considerably.
+
 ## Version 2.3.2
 
 - Add option to override global prefix for metrics (#148)

data/CONTRIBUTING.md

@@ -11,7 +11,7 @@ This project is MIT licensed.
 
 Report issues using the [Github issues tracker](https://github.com/Shopify/statsd-instrument/issues/new).
 
-When reporting issues, please incldue the following information:
+When reporting issues, please include the following information:
 
 - Your Ruby interpreter version.
 - The statsd-instrument version. **Note:** only the latest version is supported.

data/lib/statsd/instrument.rb

@@ -58,17 +58,13 @@ module StatsD
 
     if Process.respond_to?(:clock_gettime)
       # @private
-      def self.duration
-        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        yield
-        Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+      def self.current_timestamp
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
     else
       # @private
-      def self.duration
-        start = Time.now
-        yield
-        Time.now - start
+      def self.current_timestamp
+        Time.now
       end
     end
 
@@ -310,11 +306,16 @@ module StatsD
     value, metric_options = parse_options(value, metric_options)
     type = (!metric_options.empty? && metric_options.first[:as_dist] ? :d : :ms)
 
-    result = nil
-    value  = 1000 * StatsD::Instrument.duration { result = block.call } if block_given?
-    metric = collect_metric(type, key, value, metric_options)
-    result = metric unless block_given?
-    result
+    return collect_metric(type, key, value, metric_options) unless block_given?
+
+    start = StatsD::Instrument.current_timestamp
+    begin
+      block.call
+    ensure
+      # Ensure catches both a raised exception and a return in the invoked block
+      value = 1000 * (StatsD::Instrument.current_timestamp - start)
+      collect_metric(type, key, value, metric_options)
+    end
   end
 
   # Emits a counter metric.
@@ -373,11 +374,16 @@ module StatsD
   #      end
   def distribution(key, value=nil, *metric_options, &block)
     value, metric_options = parse_options(value, metric_options)
-    result = nil
-    value  = 1000 * StatsD::Instrument.duration { result = block.call } if block_given?
-    metric = collect_metric(:d, key, value, metric_options)
-    result = metric unless block_given?
-    result
+
+    return collect_metric(:d, key, value, metric_options) unless block_given?
+
+    start = StatsD::Instrument.current_timestamp
+    begin
+      block.call
+    ensure
+      value = 1000 * (StatsD::Instrument.current_timestamp - start)
+      collect_metric(:d, key, value, metric_options)
+    end
   end
 
   # Emits a key/value metric.

data/lib/statsd/instrument/backends/udp_backend.rb

@@ -27,8 +27,8 @@ module StatsD::Instrument::Backends
         packet = ""
 
         if metric.type == :_e
-          escaped_title = metric.name.tr('\n', '\\n')
-          escaped_text = metric.value.tr('\n', '\\n')
+          escaped_title = metric.name.gsub("\n", "\\n")
+          escaped_text = metric.value.gsub("\n", "\\n")
 
           packet << "_e{#{escaped_title.size},#{escaped_text.size}}:#{escaped_title}|#{escaped_text}"
           packet << generate_metadata(metric, EVENT_OPTIONS)

data/lib/statsd/instrument/metric.rb

@@ -83,7 +83,7 @@ class StatsD::Instrument::Metric
   def to_s
     str = "#{TYPES[type]} #{name}:#{value}"
     str << " @#{sample_rate}" if sample_rate != 1.0
-    str << " " << tags.map { |t| "##{t}"}.join(' ') if tags
+    tags.each { |tag| str << " ##{tag}" } if tags
     str
   end
 

data/lib/statsd/instrument/version.rb

@@ -1,5 +1,5 @@
 module StatsD
   module Instrument
-    VERSION = "2.3.2"
+    VERSION = "2.3.4"
   end
 end

data/test/statsd_test.rb

@@ -46,7 +46,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_measure_with_benchmarked_block_duration
-    StatsD::Instrument.stubs(:duration).returns(1.12)
+    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
     metric = capture_statsd_call do
       StatsD.measure('values.foobar') { 'foo' }
     end
@@ -70,6 +70,40 @@ class StatsDTest < Minitest::Test
     assert_nil return_value
   end
 
+  def test_statsd_measure_with_return_in_block_still_captures
+    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 6.12)
+    result = nil
+    metric = capture_statsd_call do
+      lambda = -> do
+        StatsD.measure('values.foobar') { return 'from lambda'}
+      end
+
+      result = lambda.call
+    end
+
+    assert_equal 'from lambda', result
+    assert_equal 1120.0, metric.value
+  end
+
+  def test_statsd_measure_with_exception_in_block_still_captures
+    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 6.12)
+    result = nil
+    metric = capture_statsd_call do
+      lambda = -> do
+        StatsD.measure('values.foobar') { raise 'from lambda'}
+      end
+
+      begin
+        result = lambda.call
+      rescue
+      end
+
+    end
+
+    assert_nil result
+    assert_equal 1120.0, metric.value
+  end
+
   def test_statsd_increment
     result = nil
     metric = capture_statsd_call { result = StatsD.increment('values.foobar', 3) }
@@ -149,7 +183,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_distribution_with_benchmarked_block_duration
-    StatsD::Instrument.stubs(:duration).returns(1.12)
+    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
     metric = capture_statsd_call do
       StatsD.distribution('values.foobar') { 'foo' }
     end
@@ -157,8 +191,44 @@ class StatsDTest < Minitest::Test
     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)
+    result = nil
+    metric = capture_statsd_call do
+      lambda = -> do
+        StatsD.distribution('values.foobar') { return 'from lambda'}
+      end
+
+      result = lambda.call
+    end
+
+    assert_equal 'from lambda', result
+    assert_equal :d, metric.type
+    assert_equal 1120.0, metric.value
+  end
+
+  def test_statsd_distribution_with_exception_in_block_still_captures
+    StatsD::Instrument.stubs(:current_timestamp).returns(5.0, 5.0 + 1.12)
+    result = nil
+    metric = capture_statsd_call do
+      lambda = -> do
+        StatsD.distribution('values.foobar') { raise 'from lambda'}
+      end
+
+      begin
+        result = lambda.call
+      rescue
+      end
+
+    end
+
+    assert_nil result
+    assert_equal :d, metric.type
+    assert_equal 1120.0, metric.value
+  end
+
   def test_statsd_distribution_with_block_and_options
-    StatsD::Instrument.stubs(:duration).returns(1.12)
+    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' }
     end

data/test/udp_backend_test.rb

@@ -90,8 +90,8 @@ class UDPBackendTest < Minitest::Test
 
   def test_event_on_datadog_escapes_newlines
     @backend.implementation = :datadog
-    @backend.expects(:write_packet).with('_e{8,5}:fooh\\n\\n|baz\\n')
-    StatsD.event('fooh\n\n', 'baz\n')
+    @backend.expects(:write_packet).with("_e{8,5}:fooh\\n\\n|baz\\n")
+    StatsD.event("fooh\n\n", "baz\n")
   end
 
   def test_event_on_datadog_ignores_invalid_metadata

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.4
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -163,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A StatsD client for Ruby apps