statsd-instrument 2.3.0.beta3 → 2.3.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fed77a70470567d6ed49c57a482ca7e7f89dc93
-  data.tar.gz: 007f5373e64aa4a4ff2b082430fe4a8f1f65a10d
+  metadata.gz: 3e554f96249614fda4598c73f8a374eb17d53aac
+  data.tar.gz: 0d2b774c6545501caf5a4e8a2c254a68fea40239
 SHA512:
-  metadata.gz: 6f2adb3365c37f6fb8a5abcea906b5f50e6f8cc7be751216680a1dcae0a453ddf39c36ee69066bccb995345b2102f7f68fdbd53284887a3d1d7f32ad46aa5133
-  data.tar.gz: 74948e391f080f3706bfb394f120f7eb3d9f9eabe410667257545426711ecef178162f666cd9f97a87365a32e382742a0bd48d0a79459461f4590757c8f7f0fd
+  metadata.gz: 35310f0da894755a60b5517d8d555169805eb2e27c789c79d8a36fe8f87a0e7e14183814f6c81d4734338f4384ed329c6a9041df21f573b95e9c1d1e60ec9f55
+  data.tar.gz: 4c146f7e47bd0b181c3844e126fa8b0760ad6f6dd91f979cf83be422ac58e89bc9cb9e43744aa5a6096e592d5a5b43ed56688bbbf921bd5b80fba06f2dc9029a

data/lib/statsd/instrument.rb

@@ -72,7 +72,7 @@ module StatsD
       end
     end
 
-    # Adds execution duration instrumentation to a method.
+    # Adds execution duration instrumentation to a method as a timing.
     #
     # @param method [Symbol] The name of the method to instrument.
     # @param name [String, #call] The name of the metric to use. You can also pass in a
@@ -87,6 +87,22 @@ module StatsD
       end
     end
 
+    # Adds execution duration instrumentation to a method as a distribution.
+    #
+    # @param method [Symbol] The name of the method to instrument.
+    # @param name [String, #call] The name of the metric to use. You can also pass in a
+    #    callable to dynamically generate a metric name
+    # @param metric_options (see StatsD#measure)
+    # @return [void]
+    # @note Supported by the datadog implementation only (in beta)
+    def statsd_distribution(method, name, *metric_options)
+      add_to_method(method, name, :distribution) do
+        define_method(method) do |*args, &block|
+          StatsD.distribution(StatsD::Instrument.generate_metric_name(name, self, *args), *metric_options) { super(*args, &block) }
+        end
+      end
+    end
+
     # Adds success and failure counter instrumentation to a method.
     #
     # A method call will be considered successful if it does not raise an exception, and the result is true-y.
@@ -206,6 +222,15 @@ module StatsD
       remove_from_method(method, name, :measure)
     end
 
+    # Removes StatsD distribution instrumentation from a method
+    # @param method (see #statsd_remove_count)
+    # @param name (see #statsd_remove_count)
+    # @return [void]
+    # @see #statsd_measure
+    def statsd_remove_distribution(method, name)
+      remove_from_method(method, name, :distribution)
+    end
+
     private
 
     def statsd_instrumentation_for(method, name, action)
@@ -282,17 +307,13 @@ module StatsD
   #        HTTP.get(url)
   #      end
   def measure(key, value = nil, *metric_options, &block)
-    if value.is_a?(Hash) && metric_options.empty?
-      metric_options = [value]
-      value = value.fetch(:value, nil)
-    end
+    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(hash_argument(metric_options).merge(type: type, name: key, value: value))
-    result = metric unless block_given?
-    result
+    metric = collect_metric(type, key, value, metric_options)
+    (result || metric)
   end
 
   # Emits a counter metric.
@@ -307,12 +328,7 @@ module StatsD
   # @param metric_options [Hash] (default: {}) Metric options
   # @return (see #collect_metric)
   def increment(key, value = 1, *metric_options)
-    if value.is_a?(Hash) && metric_options.empty?
-      metric_options = [value]
-      value = value.fetch(:value, 1)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :c, name: key, value: value))
+    collect_metric(:c, key, value, metric_options)
   end
 
   # Emits a gauge metric.
@@ -321,12 +337,7 @@ module StatsD
   # @param metric_options [Hash] (default: {}) Metric options
   # @return (see #collect_metric)
   def gauge(key, value, *metric_options)
-    if value.is_a?(Hash) && metric_options.empty?
-      metric_options = [value]
-      value = value.fetch(:value, nil)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :g, name: key, value: value))
+    collect_metric(:g, key, value, metric_options)
   end
 
   # Emits a histogram metric.
@@ -336,12 +347,7 @@ module StatsD
   # @return (see #collect_metric)
   # @note Supported by the datadog implementation only.
   def histogram(key, value, *metric_options)
-    if value.is_a?(Hash) && metric_options.empty?
-      metric_options = [value]
-      value = value.fetch(:value, nil)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :h, name: key, value: value))
+    collect_metric(:h, key, value, metric_options)
   end
 
   # Emits a distribution metric.
@@ -350,13 +356,26 @@ module StatsD
   # @param metric_options [Hash] (default: {}) Metric options
   # @return (see #collect_metric)
   # @note Supported by the datadog implementation only (in beta)
-  def distribution(key, value, *metric_options)
-    if value.is_a?(Hash) && metric_options.empty?
-      metric_options = [value]
-      value = value.fetch(:value, nil)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :d, name: key, value: value))
+  #
+  # @overload distribution(key, metric_options = {}, &block)
+  #   Emits a distribution metric, after measuring the execution duration of the
+  #   block passed to this method.
+  #   @param key [String] The name of the metric.
+  #   @param metric_options [Hash] Options for the metric
+  #   @yield The method will yield the block that was passed to this method to measure its duration.
+  #   @return The value that was returns by the block passed to this method.
+  #   @note Supported by the datadog implementation only.
+  #
+  #   @example
+  #      http_response = StatsD.distribution('HTTP.call.duration') do
+  #        HTTP.get(url)
+  #      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)
   end
 
   # Emits a key/value metric.
@@ -366,12 +385,7 @@ module StatsD
   # @return (see #collect_metric)
   # @note Supported by the statsite implementation only.
   def key_value(key, value, *metric_options)
-    if value.is_a?(Hash) && metric_options.empty?
-      metric_options = [value]
-      value = value.fetch(:value, nil)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :kv, name: key, value: value))
+    collect_metric(:kv, key, value, metric_options)
   end
 
   # Emits a set metric.
@@ -381,12 +395,7 @@ module StatsD
   # @return (see #collect_metric)
   # @note Supported by the datadog implementation only.
   def set(key, value, *metric_options)
-    if value.is_a?(Hash) && metric_options.empty?
-      metric_options = [value]
-      value = value.fetch(:value, nil)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :s, name: key, value: value))
+    collect_metric(:s, key, value, metric_options)
   end
 
   # Emits an event metric.
@@ -396,12 +405,7 @@ module StatsD
   # @return (see #collect_metric)
   # @note Supported by the datadog implementation only.
   def event(title, text, *metric_options)
-    if text.is_a?(Hash) && metric_options.empty?
-      metric_options = [text]
-      text = text.fetch(:text, nil)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :_e, name: title, value: text))
+    collect_metric(:_e, title, text, metric_options)
   end
 
   # Emits a service check metric.
@@ -411,12 +415,7 @@ module StatsD
   # @return (see #collect_metric)
   # @note Supported by the datadog implementation only.
   def service_check(name, status, *metric_options)
-    if status.is_a?(Hash) && metric_options.empty?
-      metric_options = [status]
-      status = status.fetch(:status, nil)
-    end
-
-    collect_metric(hash_argument(metric_options).merge(type: :_sc, name: name, value: status))
+    collect_metric(:_sc, name, status, metric_options)
   end
 
   private
@@ -437,10 +436,21 @@ module StatsD
     return hash
   end
 
+  def parse_options(value, metric_options)
+    if value.is_a?(Hash) && metric_options.empty?
+      metric_options = [value]
+      value = value.fetch(:value, nil)
+    end
+    [value, metric_options]
+  end
+
   # Instantiates a metric, and sends it to the backend for further processing.
   # @param options (see StatsD::Instrument::Metric#initialize)
   # @return [StatsD::Instrument::Metric] The meric that was sent to the backend.
-  def collect_metric(options)
+  def collect_metric(type, name, value, metric_options)
+    value, metric_options = parse_options(value, metric_options)
+
+    options = hash_argument(metric_options).merge(type: type, name: name, value: value)
     backend.collect_metric(metric = StatsD::Instrument::Metric.new(options))
     metric
   end

data/lib/statsd/instrument/version.rb

@@ -1,5 +1,5 @@
 module StatsD
   module Instrument
-    VERSION = "2.3.0.beta3"
+    VERSION = "2.3.0.beta4"
   end
 end

data/test/statsd_instrumentation_test.rb

@@ -265,6 +265,64 @@ class StatsDInstrumentationTest < Minitest::Test
     ActiveMerchant::UniqueGateway.statsd_remove_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
   end
 
+
+  def test_statsd_distribution
+    ActiveMerchant::UniqueGateway.statsd_distribution :ssl_post, 'ActiveMerchant.Gateway.ssl_post', sample_rate: 0.3
+
+    assert_statsd_distribution('ActiveMerchant.Gateway.ssl_post', sample_rate: 0.3) do
+      ActiveMerchant::UniqueGateway.new.purchase(true)
+    end
+  ensure
+    ActiveMerchant::UniqueGateway.statsd_remove_distribution :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+  end
+
+  def test_statsd_distribution_uses_normalized_metric_name
+    ActiveMerchant::UniqueGateway.statsd_distribution :ssl_post, 'ActiveMerchant::Gateway.ssl_post'
+
+    assert_statsd_distribution('ActiveMerchant.Gateway.ssl_post') do
+      ActiveMerchant::UniqueGateway.new.purchase(true)
+    end
+  ensure
+    ActiveMerchant::UniqueGateway.statsd_remove_distribution :ssl_post, 'ActiveMerchant::Gateway.ssl_post'
+  end
+
+  def test_statsd_distribution_yells_without_block
+    err = assert_raises(ArgumentError) do
+      assert_statsd_distribution('ActiveMerchant.Gateway.ssl_post')
+    end
+    assert_equal "block must be given", err.to_s
+  end
+
+  def test_statsd_distribution_with_method_receiving_block
+    ActiveMerchant::Base.statsd_distribution :post_with_block, 'ActiveMerchant.Base.post_with_block'
+
+    assert_statsd_distribution('ActiveMerchant.Base.post_with_block') do
+      assert_equal 'block called', ActiveMerchant::Base.new.post_with_block { 'block called' }
+    end
+  ensure
+    ActiveMerchant::Base.statsd_remove_distribution :post_with_block, 'ActiveMerchant.Base.post_with_block'
+  end
+
+  def test_statsd_distribution_with_value
+    ActiveMerchant::UniqueGateway.statsd_distribution :ssl_post, 'ActiveMerchant.Gateway.ssl_post', 1
+
+    assert_statsd_distribution('ActiveMerchant.Gateway.ssl_post') do
+      ActiveMerchant::UniqueGateway.new.purchase(true)
+    end
+  ensure
+    ActiveMerchant::UniqueGateway.statsd_remove_distribution :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+  end
+
+  def test_statsd_distribution_with_value_and_options
+    ActiveMerchant::UniqueGateway.statsd_distribution :ssl_post, 'ActiveMerchant.Gateway.ssl_post', 1, sample_rate: 0.45
+
+    assert_statsd_distribution('ActiveMerchant.Gateway.ssl_post', sample_rate: 0.45) do
+      ActiveMerchant::UniqueGateway.new.purchase(true)
+    end
+  ensure
+    ActiveMerchant::UniqueGateway.statsd_remove_distribution :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+  end
+
   def test_instrumenting_class_method
     ActiveMerchant::Gateway.singleton_class.extend StatsD::Instrument
     ActiveMerchant::Gateway.singleton_class.statsd_count :sync, 'ActiveMerchant.Gateway.sync'

data/test/statsd_test.rb

@@ -143,6 +143,31 @@ class StatsDTest < Minitest::Test
     assert_equal 42, metric.value
   end
 
+  def test_statsd_distribution_with_benchmarked_block_duration
+    StatsD::Instrument.stubs(:duration).returns(1.12)
+    metric = capture_statsd_call do
+      StatsD.distribution('values.foobar') { 'foo' }
+    end
+    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)
+    metric = capture_statsd_call do
+      StatsD.distribution('values.foobar', :tags => ['test'], :sample_rate => 0.9) { 'foo' }
+    end
+    assert_equal 1120.0, metric.value
+    assert_equal 'values.foobar', metric.name
+    assert_equal 0.9, metric.sample_rate
+    assert_equal ['test'], metric.tags
+  end
+
+  def test_statsd_distribution_returns_return_value_of_block
+    return_value = StatsD.distribution('values.foobar') { 'sarah' }
+    assert_equal 'sarah', return_value
+  end
+
   def test_statsd_key_value
     result = nil
     metric = capture_statsd_call { result = StatsD.key_value('values.foobar', 42) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.3.0.beta3
+  version: 2.3.0.beta4
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake