statsd-instrument 2.9.2 → 3.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50951cc1d5be4659f87b7a6b4b2b820250b768a8a888bad19f85beb30cf77acd
-  data.tar.gz: 2dc9c84774e437ba6e64b221197b228d36ece95c42428f70eb43262028cca2b5
+  metadata.gz: ec03c4f1452d2b5bca53c83faf68955d8095ad75ed0484103091789764e02233
+  data.tar.gz: 6037bd8e41bfc3b7d726c9f1120d10ce202a206dbfdd1e3368d550ed90f0bcc9
 SHA512:
-  metadata.gz: eabe89b8d4184ade826b5e68bb3fcf27a10330a454cefb4b9ecbb7583d4e5ab919878e7faa6e8a8e702bdcbe09c35fa4a4b6b37048f52f8970753c6225830632
-  data.tar.gz: a0a3f0a646c9669918faf6e4f5f6a0b8a0cfeb9db6128cb0350bafbd9f78ab778add4fe01cbab6a43bccc2ad91eac93721b9bd46cfe8d877cff43e5bec762e67
+  metadata.gz: f282acf3e05dac8b66eddc5b2fb8e11501543bc2125c92d7154835bd832304d706e35dc831c7c4ea879f05f4f1b0568b67bd19e4a657ef45c8272c81aa29b0af
+  data.tar.gz: 65546513cc2e0fb9ea06ab220d63102ba354963397c96ae8d81983d3b9178ca8ca03ed1536c29a8d2938b125e7644a37cdc40c0707d9eab1ccca2298bd3b6ad1

data/CHANGELOG.md

@@ -8,17 +8,6 @@ section below.
 
 _Nothing yet_
 
-## Version 2.9.2
-
-- Allow providing a value as second positional argument to `assert_statsd_*`
-  methods, rather than as keyword argument. This matches the arguments to the
-  StatsD metric call.
-  ``` ruby
-    assert_statsd_increment('batch_size', 10) do
-      StatsD.increment('batch_size', 10)
-    end
-  ```
-
 ## Version 2.9.1
 
 - The `VOID` object being returned by metric methods (e.g. `StatsD.increment`)

data/benchmark/send-metrics-to-dev-null-log

@@ -25,8 +25,10 @@ report = Benchmark.ips do |bench|
     StatsD.measure('StatsD.measure') { 1 + 1 }
     StatsD.gauge('StatsD.gauge', 12.0, tags: ["foo:bar", "quc"])
     StatsD.set('StatsD.set', 'value', tags: { foo: 'bar', baz: 'quc' })
-    StatsD.event('StasD.event', "12345")
-    StatsD.service_check("StatsD.service_check", "ok")
+    if StatsD.singleton_client.datagram_builder_class == StatsD::Instrument::DogStatsDDatagramBuilder
+      StatsD.event('StasD.event', "12345")
+      StatsD.service_check("StatsD.service_check", "ok")
+    end
   end
 
   # Store the results in between runs

data/benchmark/send-metrics-to-local-udp-receiver

@@ -4,6 +4,7 @@
 require 'bundler/setup'
 require 'benchmark/ips'
 require 'socket'
+require 'statsd-instrument'
 
 revision = %x(git rev-parse HEAD).rstrip
 master_revision = %x(git rev-parse origin/master).rstrip
@@ -20,11 +21,11 @@ FileUtils.mkdir_p(File.dirname(intermediate_results_filename))
 receiver = UDPSocket.new
 receiver.bind('localhost', 0)
 
-ENV['ENV'] = "production"
-ENV['STATSD_ADDR'] = "#{receiver.addr[2]}:#{receiver.addr[1]}"
-ENV['STATSD_IMPLEMENTATION'] ||= 'datadog'
-
-require 'statsd-instrument'
+StatsD.singleton_client = StatsD::Instrument::Environment.new(
+  'STATSD_ADDR' => "#{receiver.addr[2]}:#{receiver.addr[1]}",
+  'STATSD_IMPLEMENTATION' => 'dogstatsd',
+  'STATSD_ENV' => 'production',
+).client
 
 report = Benchmark.ips do |bench|
   bench.report("StatsD metrics to local UDP receiver (branch: #{branch}, sha: #{revision[0, 7]})") do
@@ -32,7 +33,7 @@ report = Benchmark.ips do |bench|
     StatsD.measure('StatsD.measure') { 1 + 1 }
     StatsD.gauge('StatsD.gauge', 12.0, tags: ["foo:bar", "quc"])
     StatsD.set('StatsD.set', 'value', tags: { foo: 'bar', baz: 'quc' })
-    if StatsD.backend.implementation == :datadog
+    if StatsD.singleton_client.datagram_builder_class == StatsD::Instrument::DogStatsDDatagramBuilder
       StatsD.event('StasD.event', "12345")
       StatsD.service_check("StatsD.service_check", "ok")
     end

data/lib/statsd/instrument.rb

@@ -48,40 +48,36 @@ require 'forwardable'
 #   @return [Array<String>, Hash<String, String>, nil] The default tags, or <tt>nil</tt> when no default tags is used
 #   @deprecated
 #
-# @!attribute legacy_singleton_client
-#   @nodoc
-#   @deprecated
-#
 # @!attribute singleton_client
 #   @nodoc
 #   @deprecated
 #
 # @!method measure(name, value = nil, sample_rate: nil, tags: nil, &block)
-#   (see StatsD::Instrument::LegacyClient#measure)
+#   (see StatsD::Instrument::Client#measure)
 #
 # @!method increment(name, value = 1, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#increment)
+#   (see StatsD::Instrument::Client#increment)
 #
 # @!method gauge(name, value, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#gauge)
+#   (see StatsD::Instrument::Client#gauge)
 #
 # @!method set(name, value, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#set)
+#   (see StatsD::Instrument::Client#set)
 #
 # @!method histogram(name, value, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#histogram)
+#   (see StatsD::Instrument::Client#histogram)
 #
 # @!method distribution(name, value = nil, sample_rate: nil, tags: nil, &block)
-#   (see StatsD::Instrument::LegacyClient#distribution)
+#   (see StatsD::Instrument::Client#distribution)
 #
 # @!method key_value(name, value)
-#   (see StatsD::Instrument::LegacyClient#key_value)
+#   (see StatsD::Instrument::Client#key_value)
 #
 # @!method event(title, text, tags: nil, hostname: nil, timestamp: nil, aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil) # rubocop:disable Metrics/LineLength
-#   (see StatsD::Instrument::LegacyClient#event)
+#   (see StatsD::Instrument::Client#event)
 #
 # @!method service_check(name, status, tags: nil, hostname: nil, timestamp: nil, message: nil)
-#   (see StatsD::Instrument::LegacyClient#service_check)
+#   (see StatsD::Instrument::Client#service_check)
 #
 # @see StatsD::Instrument <tt>StatsD::Instrument</tt> contains module to instrument
 #    existing methods with StatsD metrics
@@ -104,10 +100,8 @@ module StatsD
     end
 
     # @private
-    def self.generate_metric_name(prefix, key, callee, *args)
-      name = key.respond_to?(:call) ? key.call(callee, args).gsub('::', '.') : key.gsub('::', '.')
-      name = "#{prefix}.#{name}" if prefix
-      name
+    def self.generate_metric_name(name, callee, *args)
+      name.respond_to?(:call) ? name.call(callee, args).gsub('::', '.') : name.gsub('::', '.')
     end
 
     # Even though this method is considered private, and is no longer used internally,
@@ -139,21 +133,12 @@ module StatsD
     #    callable to dynamically generate a metric name
     # @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: nil, no_prefix: false, client: nil)
-
-      if as_dist
-        return statsd_distribution(method, name, # rubocop:disable StatsD/MetricPrefixArgument
-          sample_rate: sample_rate, tags: tags, prefix: prefix, no_prefix: no_prefix)
-      end
-
+    def statsd_measure(method, name, sample_rate: nil, tags: nil, no_prefix: false, client: nil)
       add_to_method(method, name, :measure) do
         define_method(method) do |*args, &block|
           client ||= StatsD.singleton_client
-          prefix ||= client.prefix unless no_prefix
-          key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-          client.measure(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
+          key = StatsD::Instrument.generate_metric_name(name, self, *args)
+          client.measure(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix) do
             super(*args, &block)
           end
         end
@@ -168,16 +153,12 @@ module StatsD
     # @param metric_options (see StatsD#measure)
     # @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: nil, no_prefix: false, client: nil)
-
+    def statsd_distribution(method, name, sample_rate: nil, tags: nil, no_prefix: false, client: nil)
       add_to_method(method, name, :distribution) do
         define_method(method) do |*args, &block|
           client ||= StatsD.singleton_client
-          prefix ||= client.prefix unless no_prefix
-          key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-          client.distribution(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
+          key = StatsD::Instrument.generate_metric_name(name, self, *args)
+          client.distribution(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix) do
             super(*args, &block)
           end
         end
@@ -199,10 +180,7 @@ module StatsD
     # @yieldreturn [Boolean] Return true iff the return value is considered a success, false otherwise.
     # @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: nil, no_prefix: false, client: nil)
-
+    def statsd_count_success(method, name, sample_rate: nil, tags: nil, no_prefix: false, client: nil)
       add_to_method(method, name, :count_success) do
         define_method(method) do |*args, &block|
           begin
@@ -222,10 +200,8 @@ module StatsD
           ensure
             client ||= StatsD.singleton_client
             suffix = truthiness == false ? 'failure' : 'success'
-            prefix ||= client.prefix unless no_prefix
-            key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-            client.increment("#{key}.#{suffix}",
-              sample_rate: sample_rate, tags: tags, no_prefix: true)
+            key = StatsD::Instrument.generate_metric_name(name, self, *args)
+            client.increment("#{key}.#{suffix}", sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
           end
         end
       end
@@ -243,10 +219,7 @@ module StatsD
     # @yieldreturn (see #statsd_count_success)
     # @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: nil, no_prefix: false, client: nil)
-
+    def statsd_count_if(method, name, sample_rate: nil, tags: nil, no_prefix: false, client: nil)
       add_to_method(method, name, :count_if) do
         define_method(method) do |*args, &block|
           begin
@@ -266,9 +239,8 @@ module StatsD
           ensure
             if truthiness
               client ||= StatsD.singleton_client
-              prefix ||= client.prefix unless no_prefix
-              key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-              client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
+              key = StatsD::Instrument.generate_metric_name(name, self, *args)
+              client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
             end
           end
         end
@@ -284,16 +256,12 @@ module StatsD
     # @param name (see #statsd_measure)
     # @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: nil, no_prefix: false, client: nil)
-
+    def statsd_count(method, name, sample_rate: nil, tags: nil, no_prefix: false, client: nil)
       add_to_method(method, name, :count) do
         define_method(method) do |*args, &block|
           client ||= StatsD.singleton_client
-          prefix ||= client.prefix unless no_prefix
-          key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-          client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
+          key = StatsD::Instrument.generate_metric_name(name, self, *args)
+          client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
           super(*args, &block)
         end
       end
@@ -400,10 +368,6 @@ module StatsD
 
   extend Forwardable
 
-  def legacy_singleton_client
-    StatsD::Instrument::LegacyClient.singleton
-  end
-
   def singleton_client
     @singleton_client ||= StatsD::Instrument::Environment.current.client
   end
@@ -411,17 +375,19 @@ module StatsD
   # Singleton methods will be delegated to the singleton client.
   def_delegators :singleton_client, :increment, :gauge, :set, :measure,
     :histogram, :distribution, :key_value, :event, :service_check
-
-  # Deprecated methods will be delegated to the legacy client
-  def_delegators :legacy_singleton_client, :default_tags, :default_tags=,
-    :default_sample_rate, :default_sample_rate=, :prefix, :prefix=, :backend, :backend=
 end
 
 require 'statsd/instrument/version'
-require 'statsd/instrument/metric'
-require 'statsd/instrument/legacy_client'
-require 'statsd/instrument/backend'
 require 'statsd/instrument/client'
+require 'statsd/instrument/datagram'
+require 'statsd/instrument/dogstatsd_datagram'
+require 'statsd/instrument/datagram_builder'
+require 'statsd/instrument/statsd_datagram_builder'
+require 'statsd/instrument/dogstatsd_datagram_builder'
+require 'statsd/instrument/null_sink'
+require 'statsd/instrument/udp_sink'
+require 'statsd/instrument/capture_sink'
+require 'statsd/instrument/log_sink'
 require 'statsd/instrument/environment'
 require 'statsd/instrument/helpers'
 require 'statsd/instrument/assertions'

data/lib/statsd/instrument/assertions.rb

@@ -71,8 +71,8 @@ module StatsD::Instrument::Assertions
   # @return [void]
   # @raise [Minitest::Assertion] If an exception occurs, or if the metric did
   #   not occur as specified during the execution the block.
-  def assert_statsd_increment(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-    expectation = StatsD::Instrument::Expectation.increment(metric_name, value, **options)
+  def assert_statsd_increment(metric_name, datagrams: nil, client: nil, **options, &block)
+    expectation = StatsD::Instrument::Expectation.increment(metric_name, **options)
     assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
   end
 
@@ -83,8 +83,8 @@ module StatsD::Instrument::Assertions
   # @yield (see #assert_statsd_increment)
   # @return [void]
   # @raise (see #assert_statsd_increment)
-  def assert_statsd_measure(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-    expectation = StatsD::Instrument::Expectation.measure(metric_name, value, **options)
+  def assert_statsd_measure(metric_name, datagrams: nil, client: nil, **options, &block)
+    expectation = StatsD::Instrument::Expectation.measure(metric_name, **options)
     assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
   end
 
@@ -95,8 +95,8 @@ module StatsD::Instrument::Assertions
   # @yield (see #assert_statsd_increment)
   # @return [void]
   # @raise (see #assert_statsd_increment)
-  def assert_statsd_gauge(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-    expectation = StatsD::Instrument::Expectation.gauge(metric_name, value, **options)
+  def assert_statsd_gauge(metric_name, datagrams: nil, client: nil, **options, &block)
+    expectation = StatsD::Instrument::Expectation.gauge(metric_name, **options)
     assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
   end
 
@@ -107,8 +107,8 @@ module StatsD::Instrument::Assertions
   # @yield (see #assert_statsd_increment)
   # @return [void]
   # @raise (see #assert_statsd_increment)
-  def assert_statsd_histogram(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-    expectation = StatsD::Instrument::Expectation.histogram(metric_name, value, **options)
+  def assert_statsd_histogram(metric_name, datagrams: nil, client: nil, **options, &block)
+    expectation = StatsD::Instrument::Expectation.histogram(metric_name, **options)
     assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
   end
 
@@ -119,8 +119,8 @@ module StatsD::Instrument::Assertions
   # @yield (see #assert_statsd_increment)
   # @return [void]
   # @raise (see #assert_statsd_increment)
-  def assert_statsd_distribution(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-    expectation = StatsD::Instrument::Expectation.distribution(metric_name, value, **options)
+  def assert_statsd_distribution(metric_name, datagrams: nil, client: nil, **options, &block)
+    expectation = StatsD::Instrument::Expectation.distribution(metric_name, **options)
     assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
   end
 
@@ -131,8 +131,8 @@ module StatsD::Instrument::Assertions
   # @yield (see #assert_statsd_increment)
   # @return [void]
   # @raise (see #assert_statsd_increment)
-  def assert_statsd_set(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-    expectation = StatsD::Instrument::Expectation.set(metric_name, value, **options)
+  def assert_statsd_set(metric_name, datagrams: nil, client: nil, **options, &block)
+    expectation = StatsD::Instrument::Expectation.set(metric_name, **options)
     assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
   end
 
@@ -143,8 +143,8 @@ module StatsD::Instrument::Assertions
   # @yield (see #assert_statsd_increment)
   # @return [void]
   # @raise (see #assert_statsd_increment)
-  def assert_statsd_key_value(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-    expectation = StatsD::Instrument::Expectation.key_value(metric_name, value, **options)
+  def assert_statsd_key_value(metric_name, datagrams: nil, client: nil, **options, &block)
+    expectation = StatsD::Instrument::Expectation.key_value(metric_name, **options)
     assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
   end
 

data/lib/statsd/instrument/client.rb

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require 'statsd/instrument/datagram'
-require 'statsd/instrument/dogstatsd_datagram'
-require 'statsd/instrument/datagram_builder'
-require 'statsd/instrument/statsd_datagram_builder'
-require 'statsd/instrument/dogstatsd_datagram_builder'
-require 'statsd/instrument/null_sink'
-require 'statsd/instrument/udp_sink'
-require 'statsd/instrument/capture_sink'
-require 'statsd/instrument/log_sink'
-
 # The Client is the main interface for using StatsD.
 #
 # @note This new Client implementation is intended to become the new default in the

data/lib/statsd/instrument/environment.rb

@@ -19,21 +19,6 @@ class StatsD::Instrument::Environment
       current.environment
     end
 
-    # Instantiates a default backend for the current environment.
-    #
-    # @return [StatsD::Instrument::Backend]
-    # @see #environment
-    def default_backend
-      case environment
-      when 'production', 'staging'
-        StatsD::Instrument::Backends::UDPBackend.new(current.statsd_addr, current.statsd_implementation)
-      when 'test'
-        StatsD::Instrument::Backends::NullBackend.new
-      else
-        StatsD::Instrument::Backends::LoggerBackend.new(StatsD.logger)
-      end
-    end
-
     # Sets default values for sample rate and logger.
     #
     # - Default sample rate is set to the value in the STATSD_SAMPLE_RATE environment variable,
@@ -45,9 +30,6 @@ class StatsD::Instrument::Environment
     #
     # @return [void]
     def setup
-      StatsD.prefix = current.statsd_prefix
-      StatsD.default_tags = current.statsd_default_tags
-      StatsD.default_sample_rate = current.statsd_sample_rate
       StatsD.logger = Logger.new($stderr)
     end
   end
@@ -96,11 +78,7 @@ class StatsD::Instrument::Environment
   end
 
   def client
-    if env.key?('STATSD_USE_NEW_CLIENT')
-      StatsD::Instrument::Client.from_env(self)
-    else
-      StatsD::Instrument::LegacyClient.singleton
-    end
+    StatsD::Instrument::Client.from_env(self)
   end
 
   def default_sink_for_environment

data/lib/statsd/instrument/expectation.rb

@@ -3,32 +3,32 @@
 # @private
 class StatsD::Instrument::Expectation
   class << self
-    def increment(name, value = nil, **options)
-      new(type: :c, name: name, value: value, **options)
+    def increment(name, **options)
+      new(type: :c, name: name, **options)
     end
 
-    def measure(name, value = nil, **options)
-      new(type: :ms, name: name, value: value, **options)
+    def measure(name, **options)
+      new(type: :ms, name: name, **options)
     end
 
-    def gauge(name, value = nil, **options)
-      new(type: :g, name: name, value: value, **options)
+    def gauge(name, **options)
+      new(type: :g, name: name, **options)
     end
 
-    def set(name, value = nil, **options)
-      new(type: :s, name: name, value: value, **options)
+    def set(name, **options)
+      new(type: :s, name: name, **options)
     end
 
-    def key_value(name, value = nil, **options)
-      new(type: :kv, name: name, value: value, **options)
+    def key_value(name, **options)
+      new(type: :kv, name: name, **options)
     end
 
-    def distribution(name, value = nil, **options)
-      new(type: :d, name: name, value: value, **options)
+    def distribution(name, **options)
+      new(type: :d, name: name, **options)
     end
 
-    def histogram(name, value = nil, **options)
-      new(type: :h, name: name, value: value, **options)
+    def histogram(name, **options)
+      new(type: :h, name: name, **options)
     end
   end