statsd-instrument 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8a68ce2f902140d3efb1526ae9295949002c0cf2c6922544e0215f58b2bfc7
-  data.tar.gz: 273baedb9f0446ec0919e707d858d6543d4a585331e15c683da04673a4e60cee
+  metadata.gz: 28a52ac92cfb09e796f1eb8af9fde1a701255e61ac7377d32a7f6e92569c0e05
+  data.tar.gz: bae7f0b29a3ce2ed62486a0866e592ca29ac5d18c11ad0815e7cb71991de50a8
 SHA512:
-  metadata.gz: 8b90db7e6b18013c889e5ecd1243f9035a8fa5781634daffbaa028157859a2a6d7652a3ef5d110ccb3fe2b28b91f5c7c434e0e086d62472c2175a0838009ff81
-  data.tar.gz: 0a694681d1dde4799f082bc515594d43da648d115571b0d5ab4456e2df4a1ab3973c7e99e90379fab6112f834e4f43cf5fdc3b593f82fe737e61d3e4a50c4f1d
+  metadata.gz: 87f9772a163d3ed4f400203f83db6c39dc946b75e21288fdd7a6ab7aa5b43646fcfa2fd3564d61b2795d192bcc82ae196dc1ec765d465b098620b9bcaf05c013
+  data.tar.gz: d74cc5375319064d64e23e8fd1a6bf7583781783d296c12fb1ae233e45ddaecff8dd4bbfa9c1bf912fcd48daacb8f47511b019d4bf26b74a2ca235267054012b

data/.github/workflows/ci.yml

@@ -9,17 +9,26 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        platform: [ubuntu-18.04, windows-2019, macOS-10.14]
+        # 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:
         # The Windows environment does not support older Ruby versions. We only test against the latest version
-        - platform: windows-2019
-          ruby: 2.3
-        - platform: windows-2019
-          ruby: 2.4
-        - platform: windows-2019
-          ruby: 2.5
+        # - platform: windows-2019
+        #   ruby: 2.3
+        # - platform: windows-2019
+        #   ruby: 2.4
+        # - platform: windows-2019
+        #   ruby: 2.5
 
         # On macOS, we only test against the Ruby version macOS ships with (2.3)
         - platform: macOS-10.14

data/.rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -819,13 +819,13 @@ Layout/TrailingWhitespace:
 Style/UnlessElse:
   Enabled: true
 
-Style/UnneededCapitalW:
+Style/RedundantCapitalW:
   Enabled: true
 
-Style/UnneededInterpolation:
+Style/RedundantInterpolation:
   Enabled: true
 
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: true
 
 Style/VariableInterpolation:
@@ -956,13 +956,13 @@ Lint/UnderscorePrefixedVariableName:
 Lint/UnifiedInteger:
   Enabled: true
 
-Lint/UnneededCopDisableDirective:
+Lint/RedundantCopDisableDirective:
   Enabled: true
 
-Lint/UnneededCopEnableDirective:
+Lint/RedundantCopEnableDirective:
   Enabled: true
 
-Lint/UnneededSplatExpansion:
+Lint/RedundantSplatExpansion:
   Enabled: true
 
 Lint/UnreachableCode:

data/CHANGELOG.md

@@ -6,7 +6,29 @@ section below.
 
 ### Unreleased changes
 
-_Nothing yet_
+- ⚠️ **DEPRECATION:**  The `StatsD.key_value` metric method is deprecated
+  and will be removed in version 3.0. The new client does not have StatSite
+  support. Due to the lack of active contributors that can port this metric
+  type to the new client, we have decided to drop it until somebody else
+  steps up and re-adds it to the new client.
+- Fix: metaprogramming methods will send metrics to the client assifgned to
+  `StatsD.singleton_client` when the metric is emitted, rather than the client
+  when the metaprogramming method was called.
+- Metric methods (e.g. `StatsD.increment`) on the new client will now return a
+  `VOID` object that evaluates to `true` rather than nil. This is for better
+  backwards compatibility with the legacy client.
+- Add support for variadic arguments to `assert_no_statsd_calls`. This allows
+  consolidation of assertions about specific metrics. For example:
+    ```diff
+    -assert_no_statsd_calls('foo') do
+    -  assert_no_statsd_calls('bar') do
+    -    assert_no_statsd_calls('biz.baz') do
+    +assert_no_statsd_calls('foo', 'bar', 'biz.baz') do
+           # do work...
+    -    end
+    -  end
+     end
+    ```
 
 ## Version 2.8.0
 
@@ -16,7 +38,7 @@ _Nothing yet_
   However, if you are, you can capture StatsD datagrams using the
   `capture_statsd_datagrams` method, and run your own assertions on the list.
 - ⚠️ Remove `StatsD.client`. This was added in version 2.6.0 in order to
-  experiment with the new client. However, at this point thereare better ways
+  experiment with the new client. However, at this point there are better ways
   to do this.
   - You can set `StatsD.singleton_client` to a new client, which causes the
     calls to the StatsD singleton to be handled by a new client. If you set
@@ -36,7 +58,7 @@ This release has some small fixes related to the new client only:
 - Make it easier to instantiate new clients by specifying an implementation
   (e.g. `datadog`) rather than a DatagramBuilder class.
 - Change `NullSink#sample?` to always return `true`, so it's easier to verify
-  business rules by using a different DatabagramBuilder in test suites.
+  business rules by using a different DatagramBuilder in test suites.
 
 ## Version 2.7.0
 
@@ -56,7 +78,7 @@ and fix deprecations in your code base.
   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 existing `STATD_*` environment variables,
+  client is configured using the existing `STATSD_*` environment variables,
   like `STATSD_ADDR` and `STATSD_IMPLEMENTATION`.
 - You can also assign a custom client to `StatsD.singleton_client`.
 
@@ -188,7 +210,7 @@ deprecated patterns. See below for more info.
 - Slight behaviour change when using the `assert_statsd_*` assertion methods in
   combination with `assert_raises`: we now do not allow the block passed to the
   `assert_statsd_` call to raise an exception. This may cause tests to fail that
-  previousloy were succeeding.
+  previously were succeeding.
 
   Consider the following example:
 
@@ -318,7 +340,7 @@ s
 
   ``` ruby
   # In your Gemfile
-  gem 'statd-instrument', require: 'statsd/instrument/strict'
+  gem 'statsd-instrument', require: 'statsd/instrument/strict'
 
   # Or, in your test helper:
   require 'statsd/instrument/strict'

data/CONTRIBUTING.md

@@ -4,7 +4,7 @@ This project is MIT licensed.
 
 > **Note**: this project is currently not actively maintained, but is heavily used in production.
 > As a result, pull requests and issues may not be responded to. Also, due to the limited time we have
-> avaibale to work on this library, we cannot accept PRs that do not maintain backwards compatibility,
+> available to work on this library, we cannot accept PRs that do not maintain backwards compatibility,
 > or PRs that would affect the performance of the hot code paths.
 
 ## Reporting issues
@@ -28,9 +28,9 @@ Some notes:
 - Make sure to follow to coding style. This is enforced by Rubocop
 - Make sure your changes are properly documented using [yardoc syntax](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md).
 - Add an entry to the "unreleased changes" section of [CHANGELOG.md](./CHANGELOG.md).
-- **Do not** update `StatsD::Instrument::VERSION`. This will be done during the release prodecure.
+- **Do not** update `StatsD::Instrument::VERSION`. This will be done during the release procedure.
 
-### On perfomance & benchmarking
+### On performance & benchmarking
 
 This gem is used in production at Shopify, and is used to instrument some of
 our hottest code paths. This means that we are very careful about not

data/README.md

@@ -15,7 +15,7 @@ project](http://github.com/etsy/statsd).
 
 ## Configuration
 
-It's recommended to configure this librray by setting environment variables.
+It's recommended to configure this library by setting environment variables.
 The following environment variables are supported:
 
 - `STATSD_ADDR`: (default `localhost:8125`) The address to send the StatsD UDP
@@ -27,7 +27,7 @@ The following environment variables are supported:
   explicitly, this will be determined based on other environment variables,
   like `RAILS_ENV` or `ENV`. The library will behave differently:
 
-  - In the **production** and **staging** environment, thre librray will
+  - In the **production** and **staging** environment, thre library will
     actually send UDP packets.
   - In the **test** environment, it will swallow all calls, but allows you to
     capture them for testing purposes. See below for notes on writing tests.
@@ -41,7 +41,7 @@ The following environment variables are supported:
 - `STATSD_PREFIX`: The prefix to apply to all metric names. This can be
   overridden in a metric method call.
 - `STATSD_DEFAULT_TAGS`: A comma-separated list of tags to apply to all metrics.
-  (Note: tags are not supported by all iomplementations.)
+  (Note: tags are not supported by all implementations.)
 
 ## StatsD keys
 
@@ -110,28 +110,28 @@ 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.
 
-*Note: This is only supported by the beta datadog implementatation.*
+*Note: This is only supported by the beta datadog implementation.*
 
 #### 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.
+A modified gauge that submits a distribution of values over a sample period. Arithmetic and statistical calculations (percentiles, average, etc.) on the data set are performed 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.*
+*Note: This is only supported by the beta datadog implementation.*
 
 #### StatsD.event
 
-An event is a (title, text) tuple that can be used to correlate metrics with something that occured within the system.
+An event is a (title, text) tuple that can be used to correlate metrics with something that occurred within the system.
 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)
 ```
 
-*Note: This is only supported by the [datadog implementatation](https://docs.datadoghq.com/guides/dogstatsd/#events).*
+*Note: This is only supported by the [datadog implementation](https://docs.datadoghq.com/guides/dogstatsd/#events).*
 
 Events support additional metadata such as `date_happened`, `hostname`, `aggregation_key`, `priority`, `source_type_name`, `alert_type`.
 
@@ -143,7 +143,7 @@ An event is a (check_name, status) tuple that can be used to monitor the status
 StatsD.service_check('shipit.redis_connection', 'ok')
 ```
 
-*Note: This is only supported by the [datadog implementatation](https://docs.datadoghq.com/guides/dogstatsd/#service-checks).*
+*Note: This is only supported by the [datadog implementation](https://docs.datadoghq.com/guides/dogstatsd/#service-checks).*
 
 Service checks support additional metadata such as `timestamp`, `hostname`, `message`.
 
@@ -272,12 +272,12 @@ class MyTestcase < Minitest::Test
   end
 
   def test_no_udp_traffic
-    # Verifies no StatsD calls occured at all.
+    # Verifies no StatsD calls occurred at all.
     assert_no_statsd_calls do
       do_some_work
     end
 
-    # Verifies no StatsD calls occured for the given metric.
+    # Verifies no StatsD calls occurred for the given metric.
     assert_no_statsd_calls('metric_name') do
       do_some_work
     end

data/lib/statsd/instrument.rb

@@ -89,7 +89,7 @@ module StatsD
   extend self
 
   # The StatsD::Instrument module provides metaprogramming methods to instrument your methods with
-  # StatsD metrics. E.g., yopu can create counters on how often a method is called, how often it is
+  # 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.
   module Instrument
     # @private
@@ -139,8 +139,9 @@ 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)
+    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
@@ -149,9 +150,10 @@ module StatsD
 
       add_to_method(method, name, :measure) do
         define_method(method) do |*args, &block|
-          prefix ||= StatsD.prefix unless no_prefix
+          client ||= StatsD.singleton_client
+          prefix ||= client.prefix unless no_prefix
           key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-          StatsD.measure(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
+          client.measure(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
             super(*args, &block)
           end
         end
@@ -167,13 +169,15 @@ module StatsD
     # @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)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
+      prefix: nil, no_prefix: false, client: nil)
 
       add_to_method(method, name, :distribution) do
         define_method(method) do |*args, &block|
-          prefix ||= StatsD.prefix unless no_prefix
+          client ||= StatsD.singleton_client
+          prefix ||= client.prefix unless no_prefix
           key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-          StatsD.distribution(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
+          client.distribution(key, sample_rate: sample_rate, tags: tags, no_prefix: true) do
             super(*args, &block)
           end
         end
@@ -192,11 +196,12 @@ module StatsD
     # @yield You can pass a block to this method if you want to define yourself what is a successful call
     #   based on the return value of the method.
     # @yieldparam result The return value of the instrumented method.
-    # @yieldreturn [Boolean] Return true iff the return value is consisered a success, false otherwise.
+    # @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)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
+      prefix: nil, no_prefix: false, client: nil)
 
       add_to_method(method, name, :count_success) do
         define_method(method) do |*args, &block|
@@ -215,10 +220,12 @@ module StatsD
             end
             result
           ensure
+            client ||= StatsD.singleton_client
             suffix = truthiness == false ? 'failure' : 'success'
-            prefix ||= StatsD.prefix unless no_prefix
+            prefix ||= client.prefix unless no_prefix
             key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-            StatsD.increment("#{key}.#{suffix}", sample_rate: sample_rate, tags: tags, no_prefix: true)
+            client.increment("#{key}.#{suffix}",
+              sample_rate: sample_rate, tags: tags, no_prefix: true)
           end
         end
       end
@@ -237,7 +244,8 @@ module StatsD
     # @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)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
+      prefix: nil, no_prefix: false, client: nil)
 
       add_to_method(method, name, :count_if) do
         define_method(method) do |*args, &block|
@@ -257,9 +265,10 @@ module StatsD
             result
           ensure
             if truthiness
-              prefix ||= StatsD.prefix unless no_prefix
+              client ||= StatsD.singleton_client
+              prefix ||= client.prefix unless no_prefix
               key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-              StatsD.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
+              client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
             end
           end
         end
@@ -276,13 +285,15 @@ module StatsD
     # @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)
+      sample_rate: deprecated_sample_rate_arg, tags: deprecated_tags_arg,
+      prefix: nil, no_prefix: false, client: nil)
 
       add_to_method(method, name, :count) do
         define_method(method) do |*args, &block|
-          prefix ||= StatsD.prefix unless no_prefix
+          client ||= StatsD.singleton_client
+          prefix ||= client.prefix unless no_prefix
           key = StatsD::Instrument.generate_metric_name(prefix, name, self, *args)
-          StatsD.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
+          client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: true)
           super(*args, &block)
         end
       end
@@ -333,6 +344,10 @@ module StatsD
       remove_from_method(method, name, :distribution)
     end
 
+    VoidClass = Class.new(BasicObject)
+    private_constant :VoidClass
+    VOID = VoidClass.new
+
     private
 
     def statsd_instrumentation_for(method, name, action)

data/lib/statsd/instrument/assertions.rb

@@ -5,7 +5,7 @@
 #
 # Every metric type has its own assertion method, like {#assert_statsd_increment}
 # to assert `StatsD.increment` calls. You can also assert other properties of the
-# metric that was emitted, lioke the sample rate or presence of tags.
+# metric that was emitted, like the sample rate or presence of tags.
 # To check for the absence of metrics, use {#assert_no_statsd_calls}.
 #
 # @example Check for metric properties:
@@ -44,21 +44,21 @@ module StatsD::Instrument::Assertions
 
   # Asserts no metric occurred during the execution of the provided block.
   #
-  # @param [String] metric_name (default: nil) The metric name that is not allowed
-  #   to happen inside the block. If this is set to `nil`, the assertion will fail
-  #   if any metric occurs.
+  # @param [Array<String>] metric_names (default: []) The metric names that are not
+  #   allowed to happen inside the block. If this is set to `[]`, the assertion
+  #   will fail if any metric occurs.
   # @yield A block in which the specified metric should not occur. This block
   #   should not raise any exceptions.
   # @return [void]
   # @raise [Minitest::Assertion] If an exception occurs, or if any metric (with the
-  #   provided name, or any), occurred during the execution of the provided block.
-  def assert_no_statsd_calls(metric_name = nil, datagrams: nil, client: nil, &block)
+  #   provided names, or any), occurred during the execution of the provided block.
+  def assert_no_statsd_calls(*metric_names, datagrams: nil, client: nil, &block)
     if datagrams.nil?
       raise LocalJumpError, "assert_no_statsd_calls requires a block" unless block_given?
       datagrams = capture_statsd_datagrams_with_exception_handling(client: client, &block)
     end
 
-    datagrams.select! { |m| m.name == metric_name } if metric_name
+    datagrams.select! { |metric| metric_names.include?(metric.name) } unless metric_names.empty?
     assert(datagrams.empty?, "No StatsD calls for metric #{datagrams.map(&:name).join(', ')} expected.")
   end
 

data/lib/statsd/instrument/backend.rb

@@ -8,7 +8,7 @@ class StatsD::Instrument::Backend
   # @param metric [StatsD::Instrument::Metric] The metric to collect
   # @return [void]
   def collect_metric(_metric)
-    raise NotImplementedError, "Use a concerete backend implementation"
+    raise NotImplementedError, "Use a concrete backend implementation"
   end
 end
 

data/lib/statsd/instrument/client.rb

@@ -1,6 +1,7 @@
 # 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'
@@ -105,7 +106,7 @@ class StatsD::Instrument::Client
   # @return [void]
   def increment(name, value = 1, sample_rate: nil, tags: nil, no_prefix: false)
     sample_rate ||= @default_sample_rate
-    return unless sample?(sample_rate)
+    return StatsD::Instrument::VOID unless sample?(sample_rate)
     emit(datagram_builder(no_prefix: no_prefix).c(name, value, sample_rate, tags))
   end
 
@@ -122,7 +123,7 @@ class StatsD::Instrument::Client
     end
 
     sample_rate ||= @default_sample_rate
-    return unless sample?(sample_rate)
+    return StatsD::Instrument::VOID unless sample?(sample_rate)
     emit(datagram_builder(no_prefix: no_prefix).ms(name, value, sample_rate, tags))
   end
 
@@ -141,7 +142,7 @@ class StatsD::Instrument::Client
   # @return [void]
   def gauge(name, value, sample_rate: nil, tags: nil, no_prefix: false)
     sample_rate ||= @default_sample_rate
-    return unless sample?(sample_rate)
+    return StatsD::Instrument::VOID unless sample?(sample_rate)
     emit(datagram_builder(no_prefix: no_prefix).g(name, value, sample_rate, tags))
   end
 
@@ -154,7 +155,7 @@ class StatsD::Instrument::Client
   # @return [void]
   def set(name, value, sample_rate: nil, tags: nil, no_prefix: false)
     sample_rate ||= @default_sample_rate
-    return unless sample?(sample_rate)
+    return StatsD::Instrument::VOID unless sample?(sample_rate)
     emit(datagram_builder(no_prefix: no_prefix).s(name, value, sample_rate, tags))
   end
 
@@ -162,7 +163,7 @@ class StatsD::Instrument::Client
   # values.
   #
   # @note The distribution metric type is not available on all implementations.
-  #   A `NotImplemetedError` will be raised if you call this method, but
+  #   A `NotImplementedError` will be raised if you call this method, but
   #   the active implementation does not support it.
   #
   # @param name (see #increment)
@@ -176,14 +177,14 @@ class StatsD::Instrument::Client
     end
 
     sample_rate ||= @default_sample_rate
-    return unless sample?(sample_rate)
+    return StatsD::Instrument::VOID unless sample?(sample_rate)
     emit(datagram_builder(no_prefix: no_prefix).d(name, value, sample_rate, tags))
   end
 
   # Emits a histogram metric, which builds a histogram of the reported values.
   #
   # @note The histogram metric type is not available on all implementations.
-  #   A `NotImplemetedError` will be raised if you call this method, but
+  #   A `NotImplementedError` will be raised if you call this method, but
   #   the active implementation does not support it.
   #
   # @param name (see #increment)
@@ -193,7 +194,7 @@ class StatsD::Instrument::Client
   # @return [void]
   def histogram(name, value, sample_rate: nil, tags: nil, no_prefix: false)
     sample_rate ||= @default_sample_rate
-    return unless sample?(sample_rate)
+    return StatsD::Instrument::VOID unless sample?(sample_rate)
     emit(datagram_builder(no_prefix: no_prefix).h(name, value, sample_rate, tags))
   end
 
@@ -208,7 +209,7 @@ class StatsD::Instrument::Client
   #   use the preferred metric type of the implementation. The default is `:ms`.
   #   Generally, you should not have to set this.
   # @yield The latency (execution time) of the block
-  # @return The return value of the proivded block will be passed through.
+  # @return The return value of the provided block will be passed through.
   def latency(name, sample_rate: nil, tags: nil, metric_type: nil, no_prefix: false)
     start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
     begin
@@ -342,6 +343,6 @@ class StatsD::Instrument::Client
 
   def emit(datagram)
     @sink << datagram
-    nil
+    StatsD::Instrument::VOID
   end
 end