statsd-instrument 2.2.1 → 2.3.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c90b5a926408cac6e7ddb08b2828626eabb890f3
-  data.tar.gz: b006fad637fb15c07f9167e9fbe06bc889ec539f
+  metadata.gz: 23dbeea8c2ad9492a763224eebc870d68d3ec115
+  data.tar.gz: b5dc664058c39b461fcd96600f3175aca88d7195
 SHA512:
-  metadata.gz: 89b66de0c70a829a3d5e884ac93b4885958c50a0e84dd157230bc798afe4b014fa836b47af5fe8cae099cd56b15b6751b20d262c453a507b70e9ee9ca858eca5
-  data.tar.gz: 2754ba8ae91ced3221bbabc16b97b6272d8cbc269888caed3e9842a5ac69433b4f444cc57cc92cd61aa7bf4becd07bffba68af6df905da1f4c4db67fd1383678
+  metadata.gz: e564fd57696fcf3ea78351ad54dc566b0cddd6ead6d18005168c482dc22ba636fed9357a3804bc1a676f6953c48a706f4b4a7f583d97acf74b24c919882e7362
+  data.tar.gz: 51928197842090a75ffa25c6d1837d307f90408e645b801cdab05ad0b05ba3775ec471b0e1b1cef05f250891389a84205259f5d4459ab0d43031ad038d91c0c8

data/CHANGELOG.md

@@ -5,6 +5,10 @@ please at an entry to the "unreleased changes" section below.
 
 ### Unreleased changes
 
+### Version 2.3.0.beta
+
+- Add support for beta, datadog specifc distribution metrics
+
 ### Version 2.2.1
 
 - Fix performance regression from v2.2.0

data/lib/statsd/instrument/assertions.rb

@@ -23,6 +23,10 @@ module StatsD::Instrument::Assertions
     assert_statsd_call(:h, metric_name, options, &block)
   end
 
+  def assert_statsd_distribution(metric_name, options = {}, &block)
+    assert_statsd_call(:d, metric_name, options, &block)
+  end
+
   def assert_statsd_set(metric_name, options = {}, &block)
     assert_statsd_call(:s, metric_name, options, &block)
   end

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

@@ -21,7 +21,7 @@ module StatsD::Instrument::Backends
         message: 'm',
       }
 
-      SUPPORTED_METRIC_TYPES = BASE_SUPPORTED_METRIC_TYPES.merge(h: true, _e: true, _sc: true)
+      SUPPORTED_METRIC_TYPES = BASE_SUPPORTED_METRIC_TYPES.merge(h: true, _e: true, _sc: true, d: true)
 
       def generate_packet(metric)
         packet = ""

data/lib/statsd/instrument/matchers.rb

@@ -7,6 +7,7 @@ module StatsD::Instrument::Matchers
     measure: :ms,
     gauge: :g,
     histogram: :h,
+    distribution: :d,
     set: :s,
     key_value: :kv
   }

data/lib/statsd/instrument/metric.rb

@@ -91,6 +91,7 @@ class StatsD::Instrument::Metric
     ms: 'measure',
     g:  'gauge',
     h:  'histogram',
+    d:  'distribution',
     kv: 'key/value',
     s:  'set',
   }

data/lib/statsd/instrument/metric_expectation.rb

@@ -49,6 +49,7 @@ class StatsD::Instrument::MetricExpectation
       ms: 'measure',
       g:  'gauge',
       h:  'histogram',
+      d:  'distribution',
       kv: 'key/value',
       s:  'set',
   }
@@ -64,4 +65,4 @@ class StatsD::Instrument::MetricExpectation
   def inspect
     "#<StatsD::Instrument::MetricExpectation #{self.to_s}>"
   end
-end
+end

data/lib/statsd/instrument/version.rb

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

data/lib/statsd/instrument.rb

@@ -339,6 +339,21 @@ module StatsD
     collect_metric(hash_argument(metric_options).merge(type: :h, name: key, value: value))
   end
 
+   # 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
+  # @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))
+  end
+
   # Emits a key/value metric.
   # @param key [String] The name of the metric.
   # @param value [Numeric] The value to record.

data/test/statsd_test.rb

@@ -117,6 +117,15 @@ class StatsDTest < Minitest::Test
     assert_equal 42, metric.value
   end
 
+  def test_statsd_distribution
+    result = nil
+    metric = capture_statsd_call { result = StatsD.distribution('values.foobar', 42) }
+    assert_equal metric, result
+    assert_equal :d, metric.type
+    assert_equal 'values.foobar', metric.name
+    assert_equal 42, metric.value
+  end
+
   def test_statsd_key_value
     result = nil
     metric = capture_statsd_call { result = StatsD.key_value('values.foobar', 42) }

data/test/udp_backend_test.rb

@@ -76,6 +76,12 @@ class UDPBackendTest < Minitest::Test
     StatsD.histogram('fooh', 42.4)
   end
 
+   def test_distribution_syntax_on_datadog
+    @backend.implementation = :datadog
+    @backend.expects(:write_packet).with('fooh:42.4|d')
+    StatsD.distribution('fooh', 42.4)
+  end
+
   def test_event_on_datadog
     @backend.implementation = :datadog
     @backend.expects(:write_packet).with('_e{4,3}:fooh|baz|h:localhost:3000|@0.01|#foo')
@@ -127,6 +133,13 @@ class UDPBackendTest < Minitest::Test
     StatsD.histogram('fooh', 42.4)
   end
 
+  def test_distribution_warns_if_not_using_datadog
+    @backend.implementation = :other
+    @backend.expects(:write_packet).never
+    @logger.expects(:warn)
+    StatsD.distribution('fooh', 42.4)
+  end
+
   def test_supports_key_value_syntax_on_statsite
     @backend.implementation = :statsite
     @backend.expects(:write_packet).with("fooy:42|kv\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0.beta
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -158,9 +158,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14