statsd-instrument 2.3.0.beta → 2.3.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23dbeea8c2ad9492a763224eebc870d68d3ec115
-  data.tar.gz: b5dc664058c39b461fcd96600f3175aca88d7195
+  metadata.gz: 3ae635ca926c0f41f78f0662748672144020ff7f
+  data.tar.gz: 9e9c9023f4d1d874923ee9dd25f968c8110a0d90
 SHA512:
-  metadata.gz: e564fd57696fcf3ea78351ad54dc566b0cddd6ead6d18005168c482dc22ba636fed9357a3804bc1a676f6953c48a706f4b4a7f583d97acf74b24c919882e7362
-  data.tar.gz: 51928197842090a75ffa25c6d1837d307f90408e645b801cdab05ad0b05ba3775ec471b0e1b1cef05f250891389a84205259f5d4459ab0d43031ad038d91c0c8
+  metadata.gz: eca4c77bf05934fcac13b5e43e15d9d8faa1780a1767d4338273c90b60dfb598938647a9c530a01c1bb0cd954acf8460c1d765248843f55000ceed69b545cfae
+  data.tar.gz: 947142a1db455251acc2cbc9a265f979b46a782d53267d361c3d7cee648b7d53ac9130ca84afa91c24f7a182a72aeb3797fee380eb41d2a8ac8d7e4a264fb769

data/README.md

@@ -106,6 +106,16 @@ StatsD.set('GoogleBase.customers', "12345", sample_rate: 1.0)
 
 Because you are counting unique values, the results of using a sampling value less than 1.0 can lead to unexpected, hard to interpret results.
 
+#### StatsD.distribution
+
+A modified gauge that submits a distribution of values over a sample period. Arithmetic and statistical calculations (percetiles, average, etc.) on the data set are peformed server side rather than client side like a histogram.
+
+```ruby
+StatsD.distribution('shipit.redis_connection', 3)
+```
+
+*Note: This is only supported by the beta datadog implementatation.*
+
 #### StatsD.event
 
 An event is a (title, text) tuple that can be used to correlate metrics with something that occured within the system.

data/lib/statsd/instrument.rb

@@ -263,6 +263,8 @@ module StatsD
   #   @param key [String] The name of the metric.
   #   @param value [Float] The measured duration in milliseconds
   #   @param metric_options [Hash] Options for the metric
+  #     the key :as_dist will submit the value as a distribution instead of a timing
+  #     (only supported by DataDog's implementation)
   #   @return [StatsD::Instrument::Metric] The metric that was sent to the backend.
   #
   # @overload measure(key, metric_options = {}, &block)
@@ -270,7 +272,9 @@ module StatsD
   #   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 emthod to measure its duration.
+  #     the key :as_dist sets the metric type to a 'distribution' instead of a 'timing'
+  #     (only supported by DataDog's implementation)
+  #   @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.
   #
   #   @example
@@ -282,10 +286,11 @@ module StatsD
       metric_options = [value]
       value = value.fetch(:value, nil)
     end
+    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: :ms, name: key, value: value))
+    metric = collect_metric(hash_argument(metric_options).merge(type: type, name: key, value: value))
     result = metric unless block_given?
     result
   end
@@ -339,7 +344,7 @@ module StatsD
     collect_metric(hash_argument(metric_options).merge(type: :h, name: key, value: value))
   end
 
-   # Emits a distribution metric.
+  # Emits a distribution metric.
   # @param key [String] The name of the metric.
   # @param value [Numeric] The value to record.
   # @param metric_options [Hash] (default: {}) Metric options

data/lib/statsd/instrument/version.rb

@@ -1,5 +1,5 @@
 module StatsD
   module Instrument
-    VERSION = "2.3.0.beta"
+    VERSION = "2.3.0.beta2"
   end
 end

data/test/statsd_test.rb

@@ -17,6 +17,11 @@ class StatsDTest < Minitest::Test
     assert_equal :ms, metric.type
   end
 
+  def test_statsd_measure_with_explicit_value_and_distribution_override
+    metric = capture_statsd_call { result = StatsD.measure('values.foobar', 42, as_dist: true) }
+    assert_equal :d, metric.type
+  end
+
   def test_statsd_measure_with_explicit_value_as_keyword_argument
     result = nil
     metric = capture_statsd_call { result = StatsD.measure('values.foobar', value: 42) }
@@ -26,6 +31,11 @@ class StatsDTest < Minitest::Test
     assert_equal :ms, metric.type
   end
 
+  def test_statsd_measure_with_explicit_value_keyword_and_distribution_override
+    metric = capture_statsd_call { result = StatsD.measure('values.foobar', value: 42, as_dist: true) }
+    assert_equal :d, metric.type
+  end
+
   def test_statsd_measure_without_value_or_block
     assert_raises(ArgumentError) { StatsD.measure('values.foobar', tags: 123) }
   end
@@ -43,6 +53,13 @@ class StatsDTest < Minitest::Test
     assert_equal 1120.0, metric.value
   end
 
+  def test_statsd_measure_use_distribution_override_for_a_block
+    metric = capture_statsd_call do
+      StatsD.measure('values.foobar', as_dist: true) { 'foo' }
+    end
+    assert_equal :d, metric.type
+  end
+
   def test_statsd_measure_returns_return_value_of_block
     return_value = StatsD.measure('values.foobar') { 'sarah' }
     assert_equal 'sarah', return_value

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.3.0.beta
+  version: 2.3.0.beta2
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake