statsd-instrument 2.9.2 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50951cc1d5be4659f87b7a6b4b2b820250b768a8a888bad19f85beb30cf77acd
-  data.tar.gz: 2dc9c84774e437ba6e64b221197b228d36ece95c42428f70eb43262028cca2b5
+  metadata.gz: 032db29a498269753044a778380369fc44d3f87b3143e051df69f1d8a480595a
+  data.tar.gz: 10d0ccc0cb4039d8846862e82283de004a7fb2b770648fb165281dd5e2d5f68c
 SHA512:
-  metadata.gz: eabe89b8d4184ade826b5e68bb3fcf27a10330a454cefb4b9ecbb7583d4e5ab919878e7faa6e8a8e702bdcbe09c35fa4a4b6b37048f52f8970753c6225830632
-  data.tar.gz: a0a3f0a646c9669918faf6e4f5f6a0b8a0cfeb9db6128cb0350bafbd9f78ab778add4fe01cbab6a43bccc2ad91eac93721b9bd46cfe8d877cff43e5bec762e67
+  metadata.gz: 61b4c7cf6c84144767201dea7491cfa217dbd48b45821e6f1173eac8d45de6c9ddd9239ce50491839425d8cbe672f69c9ebfc9263916ec2b8a027fab43824f41
+  data.tar.gz: e726adb888e41bdfc8c9049c36b3df9b0f6ee2328a7a9e04f871652483dd57ade4ec04bd11e7010b275d77c733917c10441481c588c58bc9cb573b9364648dac

data/.github/workflows/ci.yml

@@ -4,24 +4,17 @@ on: push
 
 jobs:
   test:
-    name: Ruby ${{ matrix.ruby }} on ${{ matrix.platform }}
-    runs-on: ${{ matrix.platform }}
+    name: Ruby ${{ matrix.ruby }} on ubuntu-18.04
+    runs-on: ubuntu-18.04
     strategy:
       fail-fast: false
       matrix:
-        # Windows started failing on the following command for some reason.
-        #
-        #     gem install bundler && bundle install --jobs 4 --retry 3
-        #                         ~~
-        #     The token '&&' is not a valid statement separator in this version.
-        #
-        # Temporarily disable Windows builds to unblock CI.
-        #
-        # platform: [ubuntu-18.04, windows-2019, macOS-10.14]
-        platform: [ubuntu-18.04, macOS-10.14]
-        ruby: [2.3, 2.4, 2.5, 2.6]
-
-        exclude:
+        # Windows on macOS builds started failing, so they are disabled for noew
+
+        ruby: [2.4, 2.5, 2.6, 2.7]
+        # platform: [windows-2019, macOS-10.14, ubuntu-18.04]
+
+        # exclude:
         # The Windows environment does not support older Ruby versions. We only test against the latest version
         # - platform: windows-2019
         #   ruby: 2.3
@@ -31,12 +24,12 @@ jobs:
         #   ruby: 2.5
 
         # On macOS, we only test against the Ruby version macOS ships with (2.3)
-        - platform: macOS-10.14
-          ruby: 2.4
-        - platform: macOS-10.14
-          ruby: 2.5
-        - platform: macOS-10.14
-          ruby: 2.6
+        # - platform: macOS-10.14
+        #   ruby: 2.4
+        # - platform: macOS-10.14
+        #   ruby: 2.5
+        # - platform: macOS-10.14
+        #   ruby: 2.6
 
     steps:
     - uses: actions/checkout@v1
@@ -50,7 +43,7 @@ jobs:
       run: gem install bundler && bundle install --jobs 4 --retry 3
 
     - name: Run test suite
-      run: bundle exec rake
+      run: rake test
 
     - name: Run Rubocop
-      run: bundle exec rubocop
+      run: bin/rubocop

data/.rubocop.yml

@@ -1,11 +1,11 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 require:
   - ./lib/statsd/instrument/rubocop.rb
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   UseCache: true
   CacheRootDirectory: tmp/rubocop
   Exclude:
@@ -16,16 +16,6 @@ Naming/FileName:
   Exclude:
     - lib/statsd-instrument.rb
 
-Style/ClassAndModuleChildren:
-  Enabled: false # TODO: enable later
-
-
-Style/MethodCallWithArgsParentheses:
-  Enabled: false # TODO: enable later
-
-Lint/UnusedMethodArgument:
-  AllowUnusedKeywordArguments: true
-
 # Enable our own cops on our own repo
 
 StatsD/MetricReturnValue:

data/CHANGELOG.md

@@ -8,6 +8,39 @@ section below.
 
 _Nothing yet_
 
+## Version 3.0.2
+
+- Properly handle no_prefix when using StatsD assertions.
+
+## Version 3.0.1
+
+- Fix metaprograming methods to not print keyword argument warnings on
+  Ruby 2.7.
+- Fix the gemspec to no longer register `rake` and `rubocop` as executables.
+
+## Version 3.0.0
+
+This version makes the new client that was added in version 2.6+ the default
+client, and removes the legacy client.
+
+- All previously deprecated functionality has been removed (since version 2.5,
+  see below).
+- Support for the StatSite implementation has been dropped.
+- Support for Ruby version older than 2.4 has been dropped.
+- The default implementation has been changed to DataDog. To use the standard
+  StatsD implementation (which was the default in v2), set the
+  `STATSD_IMPLEMENTATION` environment variable to `statsd`.
+
+To upgrade, follow the following process:
+
+1. Upgrade to version 2.9.2.
+2. Switch to the new client by setting the `STATSD_USE_NEW_CLIENT` environment
+   variable to 1.
+   - You may want to use the Rubocop rules that ship with this library, and
+     strict mode to find and fix deprecated usage patterns. See below for more
+     information about strict mode and the available Rubocop rules.
+3. Upgrade to version 3.0.0, and unset `STATSD_USE_NEW_CLIENT`.
+
 ## Version 2.9.2
 
 - Allow providing a value as second positional argument to `assert_statsd_*`

data/Gemfile

@@ -3,5 +3,13 @@
 source "https://rubygems.org"
 gemspec
 
+gem 'rake'
+gem 'minitest'
+gem 'rspec'
+gem 'mocha'
+gem 'yard'
+gem 'rubocop', '>= 1.0'
+gem 'rubocop-shopify', require: false
+
 # benchmark-ips save! method is not part of a released version yet.
 gem 'benchmark-ips', git: 'https://github.com/evanphx/benchmark-ips', branch: 'master'

data/README.md

@@ -20,7 +20,7 @@ The following environment variables are supported:
 
 - `STATSD_ADDR`: (default `localhost:8125`) The address to send the StatsD UDP
   datagrams to.
-- `STATSD_IMPLEMENTATION`: (default: `statsd`). The StatsD implementation you
+- `STATSD_IMPLEMENTATION`: (default: `datadog`). The StatsD implementation you
   are using. `statsd`, `statsite` and `datadog` are supported. Some features
   are only available on certain implementations,
 - `STATSD_ENV`: The environment StatsD will run in. If this is not set
@@ -105,7 +105,7 @@ Because you are counting unique values, the results of using a sampling value le
 Builds a histogram of numeric values.
 ``` ruby
 
-StatsD.histogram('Order.value', order.value_in_usd.to_f tags: { source: 'POS' })
+StatsD.histogram('Order.value', order.value_in_usd.to_f, tags: { source: 'POS' })
 ```
 
 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.
@@ -128,7 +128,7 @@ An event is a (title, text) tuple that can be used to correlate metrics with som
 This is a good fit for instance to correlate response time variation with a deploy of the new code.
 
 ```ruby
-StatsD.event('shipit.deploy', 'started', sample_rate: 1.0)
+StatsD.event('shipit.deploy', 'started')
 ```
 
 *Note: This is only supported by the [datadog implementation](https://docs.datadoghq.com/guides/dogstatsd/#events).*

data/Rakefile

@@ -9,4 +9,4 @@ Rake::TestTask.new('test') do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: :test
+task(default: :test)

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

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
+require 'tmpdir'
 require 'benchmark/ips'
 
 revision = %x(git rev-parse HEAD).rstrip
@@ -25,8 +26,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

@@ -3,7 +3,9 @@
 
 require 'bundler/setup'
 require 'benchmark/ips'
+require 'tmpdir'
 require 'socket'
+require 'statsd-instrument'
 
 revision = %x(git rev-parse HEAD).rstrip
 master_revision = %x(git rev-parse origin/master).rstrip
@@ -20,11 +22,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 +34,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/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("rake", "rake"))

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("rubocop", "rubocop"))

data/lib/statsd/instrument.rb

@@ -4,90 +4,14 @@ require 'socket'
 require 'logger'
 require 'forwardable'
 
-# The StatsD module contains low-level metrics for collecting metrics and sending them to the backend.
+# The `StatsD` module contains low-level metrics for collecting metrics and
+# sending them to the backend.
 #
-# @!attribute client
-#   @return [StatsD::Instrument::Backend] The client that will handle singleton method calls in the next
-#     major version of this library.
-#   @note This new Client implementation is intended to become the new default in
-#     the next major release of this library. While this class may already be functional,
-#     we provide no guarantees about the API and the behavior may change.
-#
-# @!attribute backend
-#   The backend that is being used to emit the metrics.
-#   @return [StatsD::Instrument::Backend] the currently active backend. If there is no active backend
-#     yet, it will call {StatsD::Instrument::Environment#default_backend} to obtain a
-#     default backend for the environment.
-#   @see StatsD::Instrument::Environment#default_backend
-#   @deprecated
-#
-# @!attribute prefix
-#   The prefix to apply to metric names. This can be useful to group all the metrics
-#   for an application in a shared StatsD server.
-#
-#   When using a prefix a dot will be included automatically to separate the prefix
-#   from the metric name.
-#
-#   @return [String, nil] The prefix, or <tt>nil</tt> when no prefix is used
-#   @see StatsD::Instrument::Metric#name
-#   @deprecated
-#
-# @!attribute default_sample_rate
-#   The sample rate to use if the sample rate is unspecified for a metric call.
-#   @return [Float] Default is 1.0.
-#   @deprecated
-#
-# @!attribute logger
-#   The logger to use in case of any errors. The logger is also used as default logger
-#   for the LoggerBackend (although this can be overwritten).
-#   @see StatsD::Instrument::Backends::LoggerBackend
-#   @return [Logger]
-#
-# @!attribute default_tags
-#   The tags to apply to all metrics.
-#   @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)
-#
-# @!method increment(name, value = 1, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#increment)
-#
-# @!method gauge(name, value, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#gauge)
-#
-# @!method set(name, value, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#set)
-#
-# @!method histogram(name, value, sample_rate: nil, tags: nil)
-#   (see StatsD::Instrument::LegacyClient#histogram)
-#
-# @!method distribution(name, value = nil, sample_rate: nil, tags: nil, &block)
-#   (see StatsD::Instrument::LegacyClient#distribution)
-#
-# @!method key_value(name, value)
-#   (see StatsD::Instrument::LegacyClient#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)
-#
-# @!method service_check(name, status, tags: nil, hostname: nil, timestamp: nil, message: nil)
-#   (see StatsD::Instrument::LegacyClient#service_check)
-#
-# @see StatsD::Instrument <tt>StatsD::Instrument</tt> contains module to instrument
+# @see .singleton_client Metric method calls on the `StatsD` singleton will
+#   be handled by the client assigned to `StatsD.singleton_client`.
+# @see StatsD::Instrument `StatsD::Instrument` contains module to instrument
 #    existing methods with StatsD metrics
 module StatsD
-  extend self
-
   # The StatsD::Instrument module provides metaprogramming methods to instrument your methods with
   # StatsD metrics. E.g., you can create counters on how often a method is called, how often it is
   # successful, the duration of the methods call, etc.
@@ -103,11 +27,11 @@ module StatsD
       end
     end
 
+    # Generates a metric name for an instrumented method.
     # @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
+    # @return [String]
+    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 +63,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 +83,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 +110,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 +130,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 +149,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 +169,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 +186,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
@@ -377,6 +275,9 @@ module StatsD
 
       instrumentation_module.module_eval(&block)
       instrumentation_module.send(method_scope, method)
+      if instrumentation_module.respond_to?(:ruby2_keywords, true)
+        instrumentation_module.send(:ruby2_keywords, method)
+      end
       prepend(instrumentation_module) unless self < instrumentation_module
     end
 
@@ -395,33 +296,68 @@ module StatsD
     end
   end
 
-  attr_accessor :logger
-  attr_writer :singleton_client
+  class << self
+    extend Forwardable
 
-  extend Forwardable
+    # The logger to use in case of any errors.
+    #
+    # @return [Logger]
+    # @see StatsD::Instrument::LogSink
+    attr_accessor :logger
 
-  def legacy_singleton_client
-    StatsD::Instrument::LegacyClient.singleton
-  end
+    # The StatsD client that handles method calls on the StatsD singleton.
+    #
+    # E.g. a call to `StatsD.increment` will be handled by this client.
+    #
+    # @return [StatsD::Instrument::Client]
+    attr_writer :singleton_client
 
-  def singleton_client
-    @singleton_client ||= StatsD::Instrument::Environment.current.client
-  end
+    # The StatsD client that handles method calls on the StatsD singleton
+    # @return [StatsD::Instrument::Client]
+    def singleton_client
+      @singleton_client ||= StatsD::Instrument::Environment.current.client
+    end
 
-  # Singleton methods will be delegated to the singleton client.
-  def_delegators :singleton_client, :increment, :gauge, :set, :measure,
-    :histogram, :distribution, :key_value, :event, :service_check
+    # @!method measure(name, value = nil, sample_rate: nil, tags: nil, &block)
+    #   (see StatsD::Instrument::Client#measure)
+    #
+    # @!method increment(name, value = 1, sample_rate: nil, tags: nil)
+    #   (see StatsD::Instrument::Client#increment)
+    #
+    # @!method gauge(name, value, sample_rate: nil, tags: nil)
+    #   (see StatsD::Instrument::Client#gauge)
+    #
+    # @!method set(name, value, sample_rate: nil, tags: nil)
+    #   (see StatsD::Instrument::Client#set)
+    #
+    # @!method histogram(name, value, sample_rate: nil, tags: nil)
+    #   (see StatsD::Instrument::Client#histogram)
+    #
+    # @!method distribution(name, value = nil, sample_rate: nil, tags: nil, &block)
+    #   (see StatsD::Instrument::Client#distribution)
+    #
+    # @!method event(title, text, tags: nil, hostname: nil, timestamp: nil, aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil) # rubocop:disable Layout/LineLength
+    #   (see StatsD::Instrument::Client#event)
+    #
+    # @!method service_check(name, status, tags: nil, hostname: nil, timestamp: nil, message: nil)
+    #   (see StatsD::Instrument::Client#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=
+    def_delegators :singleton_client, :increment, :gauge, :set, :measure,
+      :histogram, :distribution, :event, :service_check
+  end
 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'