statsd-instrument 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0581a0deec7cbdfae1ca0b03d336b3e08cf1d14599087678f1a6a6ec35b321
-  data.tar.gz: f10c0f102d13bb71a8365a1cc9707c848af954adb02eea3b8bbb95a9bbc2f0b7
+  metadata.gz: 3929918b255f6be82e1fa81b2f996dbef0f51cabc3fa374c0386bb37cd53f58f
+  data.tar.gz: 322b93e4298c2a5bb2a32934d2c8d6ffb580248a229d5956053ea02aafa0934e
 SHA512:
-  metadata.gz: 0fc4c808a257a72bf0d86edb1e9ec9ae6c700f80408f83d574e466e1ce7cf2d627aee5e71dc5fdbb998850395881421cba97172db446fc102d04314546d55f60
-  data.tar.gz: 748ffe0481def020345c33029a630b266f033d84dcf80429316e0ec95a7394b82e20f82e9ee568efa3f455ac853fcbb3fec99243da482f8af3967069dffae13e
+  metadata.gz: b7a72b5b53f07719d207a91d37b30eb78d13f6c06f26566f8450c4e14b50bc9095498c19c12cb440484292f31e9a890d97ab478c4fced766ff55f0c2b32b8ea8
+  data.tar.gz: fb2d2484b3dd9c6533fd6c445ab7871400d3fa5e06545303ef373f3d566ad0dcf1638a40228f84fb321b0a52c60e687a119e13b08664f385aaa03695604f339e

data/CHANGELOG.md

@@ -8,6 +8,76 @@ section below.
 
 _Nothing yet!_
 
+## Version 2.7.0
+
+This release allows you to switch the StatsD singleton to use the new, more
+performant client. By setting `STATSD_USE_NEW_CLIENT` as environment variable
+methods called on the StatsD singleton (e.g. `StatsD.increment`) will be
+delegated to an instance of the new client, configured using environment
+variables.
+
+The new client should be mostly compatible with the legacy client, but some
+deprecated functionality will no longer work. See the changelog for version
+2.6.0 and 2.5.0 for more information about the deprecations, and how to find
+and fix deprecations in your code base.
+
+- The old legacy client that was implemented on the `StatsD` singleton has
+  been moved to `StatsD::LegacyClient.singleton`. By default, all method
+  calls on the `StatsD` singleton will be delegated to this legacy client.
+- By setting `STATSD_USE_NEW_CLIENT` as environment variable, these method
+  calls will be delegated to an instance of the new client instead. This
+  client is configured using the xisting `STATD_*` environment variables,
+  like `STATSD_ADDR` and `STATSD_IMPLEMENTATION`.
+- You can also assign a custom client to `StatsD.singleton_client`.
+
+The `assert_statsd_*` methods have been reworked to support asserting StatsD
+datagrams coming from a legacy client, or from a new client.
+
+- By default, the assertion methods will capture metrics emitted from
+  `StatsD.singleton_client`.
+- You can provide a `client` argument if you want to assert metrics being
+  emitted by a different client. E.g.
+
+  ``` ruby
+    assert_statsd_increment('foo', client: my_custom_client) do
+      my_custom_client.increment('foo')
+    end
+  ```
+
+- You can also capture metrics yourself, and then run assertions on them
+  by providing a `datagrams` argument:
+
+  ``` ruby
+    datagrams = my_custom_client.capture do
+      my_custom_client.increment('foo')
+    end
+    assert_statsd_increment('foo', datagrams: datagrams)
+  ```
+
+  This makes it easy to run multiple assertions on the set of metrics that
+  was emitted without having to nest calls.
+
+- **⚠️ DEPRECATION**: The following methods to configure the legacy client
+  are deprecated:
+
+  - `Statsd.backend`
+  - `StatsD.default_sample_rate`
+  - `StatsD.default_tags`
+  - `StatsD.prefix`
+
+  We recommend configuring StatsD using environment variables, which will be
+  picked up by the new client as well. You can also instantiate a new client
+  yourself; you can provide similar configuration options to
+  `StatsD::Instrument::Client.new`.
+
+  You can use the following Rubocop invocation to find any occurrences of
+  these deprecated method calls:
+
+  ``` sh
+    rubocop --require `bundle show statsd-instrument`/lib/statsd/instrument/rubocop.rb \
+      --only StatsD/SingletonConfiguration
+  ```
+
 ## Version 2.6.0
 
 This release contains a new `StatsD::Instrument::Client` class, which is
@@ -49,7 +119,7 @@ deprecated patterns. See below for more info.
 - **⚠️ DEPRECATION**: Using the `as_dist: true` argument for `StatsD.measure`
   and `statsd_measure` methods is deprecated. This argument was only available
   for internal use, but was exposed in the public API. It is unlikely that you
-  are usijng this argumenr, but you can check to make sure using this Rubocop
+  are using this argument, but you can check to make sure using this Rubocop
   invocation:
 
   ``` sh
@@ -104,9 +174,9 @@ deprecated patterns. See below for more info.
   emitted. However, this would hide the the exception from the assertion message,
   complicating debugging efforts.
 
-  Now, we fail the test because an unexpected exception occured inside the block.
+  Now, we fail the test because an unexpected exception occurred inside the block.
   This means that the following test will fail:
-
+s
   ``` ruby
   assert_raises(RuntimeError) do
     assert_statsd_increment('foo') do
@@ -137,7 +207,7 @@ deprecated patterns. See below for more info.
   the metaprogramming method was evaluated would not be respected. This
   unfortunately is quite common when you set the StatsD prefix inside an
   initializer. This issue is now addressed: the prefix is evaluated at the
-  mopment the metric is emitted, not when the metaprogramming method is being
+  moment the metric is emitted, not when the metaprogramming method is being
   evaluated. (#202)
 
 ## Version 2.5.0
@@ -223,7 +293,7 @@ deprecated patterns. See below for more info.
   in production because enabling it comes with a performance penalty.
 
 - **Performance improvements 🎉**: Several internal changes have made the
-  library run singificantly faster. The changes:
+  library run significantly faster. The changes:
 
   - Improve performance of duration calculations. (#168)
   - Early exit when no changes are needed to bring tags and metric names to
@@ -261,7 +331,7 @@ deprecated patterns. See below for more info.
 
 ## Version 2.3.5
 
-- Re-add `StatsD::Instrument.duration`, which was accidentally removed since verison 2.5.3 (#157)
+- Re-add `StatsD::Instrument.duration`, which was accidentally removed since version 2.5.3 (#157)
 
 ## Version 2.3.4
 
@@ -301,7 +371,7 @@ average metric considerably.
 
 ### Version 2.3.0
 
-- No changes from `beta6`, distribtions are GA at DataDog so making the distribution changes GA in gem
+- No changes from `beta6`, distributions are GA at DataDog so making the distribution changes GA in gem
 
 ### Version 2.3.0.beta6
 
@@ -327,7 +397,7 @@ average metric considerably.
 
 ### Version 2.3.0.beta
 
-- Add support for beta, datadog specifc distribution metrics
+- Add support for beta, Datadog specific distribution metrics
 - Invalidate socket on connectivity issues
 
 ### Version 2.2.1
@@ -336,7 +406,7 @@ average metric considerably.
 
 ### Version 2.2.0
 
-- Add support for two new datadog specific metric types: events and service checks.
+- Add support for two new Datadog specific metric types: events and service checks.
 
 ### Version 2.1.3
 

data/benchmark/datagram-client

@@ -14,7 +14,6 @@ ENV['STATSD_ADDR'] = "#{legacy_receiver.addr[2]}:#{legacy_receiver.addr[1]}"
 ENV['STATSD_IMPLEMENTATION'] ||= 'datadog'
 
 require 'statsd-instrument'
-require 'statsd/instrument/client'
 
 legacy_client = StatsD
 

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

@@ -3,7 +3,6 @@
 
 require 'bundler/setup'
 require 'benchmark/ips'
-require 'logger'
 
 revision = %x(git rev-parse HEAD).rstrip
 master_revision = %x(git rev-parse origin/master).rstrip

data/lib/statsd/instrument.rb

@@ -2,15 +2,24 @@
 
 require 'socket'
 require 'logger'
+require 'forwardable'
 
 # 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
@@ -21,10 +30,12 @@ require 'logger'
 #
 #   @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
@@ -35,9 +46,45 @@ require '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
-#    existing methods with StatsD metrics.
+#    existing methods with StatsD metrics
 module StatsD
   extend self
 
@@ -333,314 +380,41 @@ module StatsD
     end
   end
 
-  attr_accessor :logger, :default_sample_rate, :prefix
-  attr_writer :backend, :client
-  attr_reader :default_tags
-
-  def default_tags=(tags)
-    @default_tags = StatsD::Instrument::Metric.normalize_tags(tags)
-  end
-
-  def backend
-    @backend ||= StatsD::Instrument::Environment.default_backend
-  end
+  attr_accessor :logger
+  attr_writer :client, :singleton_client
 
-  def client
-    @client ||= begin
-      require 'statsd/instrument/client'
-      StatsD::Instrument::Environment.from_env.default_client
-    end
-  end
+  extend Forwardable
 
-  # @!method measure(name, value = nil, sample_rate: nil, tags: nil, &block)
-  #
-  # Emits a timing metric
-  #
-  # @param [String] key The name of the metric.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  #
-  # @example Providing a value directly
-  #    start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
-  #    do_something
-  #    stop = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
-  #    http_response = StatsD.measure('HTTP.call.duration', stop - start)
-  #
-  # @example Providing a block to measure the duration of its execution
-  #    http_response = StatsD.measure('HTTP.call.duration') do
-  #      Net::HTTP.get(url)
-  #    end
-  #
-  # @overload measure(key, value, sample_rate: nil, tags: nil)
-  #   Emits a timing metric, by providing a duration in milliseconds.
-  #
-  #   @param [Float] value The measured duration in milliseconds
-  #   @return [void]
-  #
-  # @overload measure(key, sample_rate: nil, tags: nil, &block)
-  #   Emits a timing metric, after measuring the execution duration of the
-  #   block passed to this method.
-  #
-  #   @yield `StatsD.measure` will yield the block and measure the duration. After the block
-  #     returns, the duration in millisecond will be emitted as metric.
-  #   @return The value that was returned by the block passed through.
-  def measure(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false, as_dist: false,
-    &block
-  )
-    # TODO: in the next version, hardcode this to :ms when the as_dist argument is dropped.
-    type = as_dist ? :d : :ms
-    prefix = nil if no_prefix
-    if block_given?
-      measure_latency(type, key, sample_rate: sample_rate, tags: tags, prefix: prefix, &block)
-    else
-      collect_metric(type, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-    end
+  def legacy_singleton_client
+    StatsD::Instrument::LegacyClient.singleton
   end
 
-  # @!method increment(name, value = 1, sample_rate: nil, tags: nil)
-  # Emits a counter metric.
-  #
-  # @param key [String] The name of the metric.
-  # @param value [Integer] The value to increment the counter by.
-  #
-  #   You should not compensate for the sample rate using the counter increment. E.g., if
-  #   your sample rate is 0.01, you should <b>not</b> use 100 as increment to compensate for it.
-  #   The sample rate is part of the packet that is being sent to the server, and the server
-  #   should know how to handle it.
-  #
-  # @param sample_rate [Float] (default: `StatsD.default_sample_rate`) The rate at which to sample
-  #   this metric call. This value should be between 0 and 1. This value can be used to reduce
-  #   the amount of network I/O (and CPU cycles) used for very frequent metrics.
-  #
-  #   - A value of `0.1` means that only 1 out of 10 calls will be emitted; the other 9 will
-  #     be short-circuited.
-  #   - When set to `1`, every metric will be emitted.
-  #   - If this parameter is not set, the default sample rate for this client will be used.
-  # @param tags [Array<String>, Hash<Symbol, String>] The tags to associate with this measurement.
-  #   They can be provided as an array of strings, or a hash of key/value pairs.
-  #   _Note:_ Tags are not supported by all implementations.
-  # @return [void]
-  def increment(
-    key, value_arg = 1, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:c, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
+  def singleton_client
+    @singleton_client ||= StatsD::Instrument::Environment.from_env.client
   end
 
-  # @!method gauge(name, value, sample_rate: nil, tags: nil)
-  #
-  # Emits a gauge metric.
-  #
-  # @param key The name of the metric.
-  # @param value [Numeric] The current value to record.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  # @return [void]
-  def gauge(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:g, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # @!method set(name, value, sample_rate: nil, tags: nil)
-  #
-  # Emits a set metric, which counts the number of distinct values that have occurred.
-  #
-  # @example Couning the number of unique visitors
-  #   StatsD.set('visitors.unique', Current.user.id)
-  #
-  # @param key [String] The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  # @return [void]
-  def set(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:s, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # @!method histogram(name, value, sample_rate: nil, tags: nil)
-  #
-  # Emits a histogram metric.
-  #
-  # @param key The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  # @return (see #collect_metric)
-  # @note Supported by the datadog implementation only.
-  def histogram(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:h, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-  end
-
-  # @!method distribution(name, value = nil, sample_rate: nil, tags: nil, &block)
-  #
-  # Emits a distribution metric.
-  #
-  # @param [String] key The name of the metric.
-  # @param sample_rate (see #increment)
-  # @param tags (see #increment)
-  #
-  # @note Supported by the datadog implementation only.
-  # @example
-  #    http_response = StatsD.distribution('HTTP.call.duration') do
-  #      Net::HTTP.get(url)
-  #    end
-  #
-  # @overload distribution(name, value, sample_rate: nil, tags: nil)
-  #
-  #   Emits a distribution metric, given a provided value to record.
-  #
-  #   @param [Numeric] value The value to record.
-  #   @return [void]
-  #
-  # @overload distribution(key, metric_options = {}, &block)
-  #
-  #   Emits a distribution metric for the duration of the provided block, in milliseconds.
-  #
-  #   @yield `StatsD.distribution` will yield the block and measure the duration. After
-  #     the block returns, the duration in millisecond will be emitted as metric.
-  #   @return The value that was returned by the block passed through.
-  def distribution(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false,
-    &block
-  )
-    prefix = nil if no_prefix
-    if block_given?
-      measure_latency(:d, key, sample_rate: sample_rate, tags: tags, prefix: prefix, &block)
-    else
-      collect_metric(:d, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-    end
-  end
-
-  # @!method key_value(name, value)
-  #
-  # Emits a key/value metric.
-  #
-  # @param key [String] The name of the metric.
-  # @param value [Numeric] The value to record.
-  # @return [void]
-  #
-  # @note Supported by the statsite implementation only.
-  def key_value(
-    key, value_arg = nil, deprecated_sample_rate_arg = nil,
-    value: value_arg, sample_rate: deprecated_sample_rate_arg, no_prefix: false
-  )
-    prefix = nil if no_prefix
-    collect_metric(:kv, key, value, sample_rate: sample_rate, prefix: prefix)
-  end
-
-  # @!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
-  #
-  # Emits an event.
-  #
-  # @param title [String] Title of the event. A configured prefix may be applied to this title.
-  # @param text [String] Body of the event. Can contain newlines.
-  # @param [String] hostname The hostname to associate with the event.
-  # @param [Time] timestamp The moment the status of the service was checkes. Defaults to now.
-  # @param [String] aggregation_key A key to aggregate similar events into groups.
-  # @param [String] priority The event's priority, either `"low"` or `"normal"` (default).
-  # @param [String] source_type_name The source type.
-  # @param [String] alert_type The type of alert. Either `"info"` (default), `"warning"`, `"error"`, or `"success"`.
-  # @param tags (see #increment)
-  # @return [void]
-  #
-  # @note Supported by the Datadog implementation only.
-  def event(
-    title, text,
-    deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false,
-    hostname: nil, date_happened: nil, timestamp: date_happened,
-    aggregation_key: nil, priority: nil, source_type_name: nil, alert_type: nil,
-    **_ignored
-  )
-    prefix = nil if no_prefix
-    collect_metric(:_e, title, text, sample_rate: sample_rate, tags: tags, prefix: prefix, metadata: {
-      hostname: hostname, timestamp: timestamp, aggregation_key: aggregation_key,
-      priority: priority, source_type_name: source_type_name, alert_type: alert_type
-    })
-  end
-
-  # @!method service_check(name, status, tags: nil, hostname: nil, timestamp: nil, message: nil)
-  #
-  # Emits a service check.
-  #
-  # @param [String] name Name of the service. A configured prefix may be applied to this title.
-  # @param [Symbol] status Current status of the service. Either `:ok`, `:warning`, `:critical`, or `:unknown`.
-  # @param [String] hostname The hostname to associate with the event.
-  # @param [Time] timestamp The moment the status of the service was checkes. Defaults to now.
-  # @param [String] message A message that describes the current status.
-  # @param tags (see #increment)
-  # @return [void]
-  #
-  # @note Supported by the Datadog implementation only.
-  def service_check(
-    name, status,
-    deprecated_sample_rate_arg = nil, deprecated_tags_arg = nil,
-    sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
-    prefix: StatsD.prefix, no_prefix: false,
-    hostname: nil, timestamp: nil, message: nil, **_ignored
-  )
-    prefix = nil if no_prefix
-    collect_metric(:_sc, name, status, sample_rate: sample_rate, prefix: prefix, tags: tags, metadata: {
-      hostname: hostname, timestamp: timestamp, message: message
-    })
+  def client
+    @client ||= StatsD::Instrument::Environment.from_env.default_client
   end
 
-  private
+  # Singleton methods will be delegated to the singleton client.
+  def_delegators :singleton_client, :increment, :gauge, :set, :measure,
+    :histogram, :distribution, :key_value, :event, :service_check
 
-  def measure_latency(type, key, sample_rate:, tags:, prefix:)
-    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    begin
-      yield
-    ensure
-      # Ensure catches both a raised exception and a return in the invoked block
-      value = 1000.0 * (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start)
-      collect_metric(type, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
-    end
-  end
-
-  # Instantiates a metric, and sends it to the backend for further processing.
-  # @param options (see StatsD::Instrument::Metric#initialize)
-  # @return [void]
-  def collect_metric(type, name, value, sample_rate:, tags: nil, prefix:, metadata: nil)
-    sample_rate ||= default_sample_rate
-    name = "#{prefix}.#{name}" if prefix
-
-    metric = StatsD::Instrument::Metric.new(type: type, name: name, value: value,
-      sample_rate: sample_rate, tags: tags, metadata: metadata)
-    backend.collect_metric(metric)
-    metric # TODO: return `nil` in the next major version
-  end
+  # 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/environment'
 require 'statsd/instrument/helpers'
 require 'statsd/instrument/assertions'
-require 'statsd/instrument/metric_expectation'
+require 'statsd/instrument/expectation'
 require 'statsd/instrument/matchers' if defined?(::RSpec)
 require 'statsd/instrument/railtie' if defined?(::Rails::Railtie)
 require 'statsd/instrument/strict' if ENV['STATSD_STRICT_MODE']