statsd-instrument 2.6.0 → 2.7.0

data/lib/statsd/instrument/legacy_client.rb

@@ -0,0 +1,301 @@
+# frozen_string_literal: true
+
+class StatsD::Instrument::LegacyClient
+  def self.singleton
+    @singleton ||= new
+  end
+
+  attr_accessor :default_sample_rate, :prefix
+  attr_writer :backend
+  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
+
+  # @!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: self.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
+  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: self.prefix, no_prefix: false
+  )
+    prefix = nil if no_prefix
+    collect_metric(:c, key, value, sample_rate: sample_rate, tags: tags, prefix: prefix)
+  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: self.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: self.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: self.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: self.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: self.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: self.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
+    })
+  end
+
+  private
+
+  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
+end

data/lib/statsd/instrument/metric.rb

@@ -43,9 +43,9 @@ class StatsD::Instrument::Metric
     using RubyBackports
   end
 
-  def self.new(
-    type:, name:, value: default_value(type), sample_rate: StatsD.default_sample_rate, tags: nil, metadata: nil
-  )
+  def self.new(type:, name:, value: default_value(type), tags: nil, metadata: nil,
+    sample_rate: StatsD.legacy_singleton_client.default_sample_rate)
+
     # pass keyword arguments as positional arguments for performance reasons,
     # since MRI's C implementation of new turns keyword arguments into a hash
     super(type, name, value, sample_rate, tags, metadata)
@@ -92,8 +92,8 @@ class StatsD::Instrument::Metric
     @value = value
     @sample_rate = sample_rate
     @tags = StatsD::Instrument::Metric.normalize_tags(tags)
-    if StatsD.default_tags
-      @tags = Array(@tags) + StatsD.default_tags
+    if StatsD.legacy_singleton_client.default_tags
+      @tags = Array(@tags) + StatsD.legacy_singleton_client.default_tags
     end
     @metadata = metadata
   end
@@ -101,9 +101,9 @@ class StatsD::Instrument::Metric
   # @private
   # @return [String]
   def to_s
-    str = +"#{TYPES[type]} #{name}:#{value}"
-    str << " @#{sample_rate}" if sample_rate != 1.0
-    tags&.each { |tag| str << " ##{tag}" }
+    str = +"#{name}:#{value}|#{type}"
+    str << "|@#{sample_rate}" if sample_rate && sample_rate != 1.0
+    str << "|#" << tags.join(',') if tags && !tags.empty?
     str
   end
 

data/lib/statsd/instrument/rubocop.rb

@@ -21,6 +21,17 @@ module RuboCop
         statsd_count
       }
 
+      SINGLETON_CONFIGURATION_METHODS = %i{
+        backend
+        backend=
+        prefix
+        prefix=
+        default_tags
+        default_tags=
+        default_sample_rate
+        default_sample_rate=
+      }
+
       private
 
       def metaprogramming_method?(node)
@@ -33,6 +44,12 @@ module RuboCop
           METRIC_METHODS.include?(node.method_name)
       end
 
+      def singleton_configuration_method?(node)
+        node.receiver&.type == :const &&
+          node.receiver&.const_name == "StatsD" &&
+          SINGLETON_CONFIGURATION_METHODS.include?(node.method_name)
+      end
+
       def has_keyword_argument?(node, sym)
         if (kwargs = keyword_arguments(node))
           kwargs.child_nodes.detect do |pair|
@@ -62,3 +79,4 @@ require_relative 'rubocop/positional_arguments'
 require_relative 'rubocop/splat_arguments'
 require_relative 'rubocop/measure_as_dist_argument'
 require_relative 'rubocop/metric_prefix_argument'
+require_relative 'rubocop/singleton_configuration'

data/lib/statsd/instrument/rubocop/singleton_configuration.rb

@@ -0,0 +1,53 @@
+# frozen-string-literal: true
+
+require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+
+module RuboCop
+  module Cop
+    module StatsD
+      # This Rubocop will check for calls to StatsD singleton congfiguration methods
+      # (e.g. `StatsD.prefix`). The library is moving away from having just a single
+      # singleton client, so these methods are deprecated.
+      #
+      # Use the following Rubocop invocation to check your project's codebase:
+      #
+      #     rubocop --require `bundle show statsd-instrument`/lib/statsd/instrument/rubocop.rb \
+      #       --only StatsD/SingletonConfiguration
+      #
+      # This cop will not autocorrect violations. There are several ways of fixing the violation.
+      #
+      # - The best option is to configure the library using environment variables, like
+      #   `STATSD_ADDR`, `STATSD_IMPLEMENTATION`, `STATSD_PREFIX`, and `STATSD_DEFAULT_TAGS`.
+      #   Metric methods called on the StatsD singleton (e.g. `StatsD.increment`) will by default
+      #   be delegated to a client that is configured using these environment variables.
+      # - Alternatively, you can instantiate your own client using `StatsD::Instrument::Client.new`,
+      #   and assign it to `StatsD.singleton_client`. The client constructor accepts many of the
+      #   same options.
+      # - If you have to, you can call the old methods on `StatsD.legacy_singleton_client`. Note
+      #   that this option will go away in the next major version.
+      class SingletonConfiguration < Cop
+        include RuboCop::Cop::StatsD
+
+        MSG = <<~MESSAGE
+          Singleton methods to configure StatsD are deprecated.
+
+          - The best option is to configure the library using environment variables, like
+            `STATSD_ADDR`, `STATSD_IMPLEMENTATION`, `STATSD_PREFIX`, and `STATSD_DEFAULT_TAGS`.
+            Metric methods called on the StatsD singleton (e.g. `StatsD.increment`) will by default
+            be delegated to a client that is configured using these environment variables.
+          - Alternatively, you can instantiate your own client using `StatsD::Instrument::Client.new`,
+            and assign it to `StatsD.singleton_client`. The client constructor accepts many of the
+            same options.
+          - If you have to, you can call the old methods on `StatsD.legacy_singleton_client`. Note
+            that this option will go away in the next major version.
+        MESSAGE
+
+        def on_send(node)
+          if singleton_configuration_method?(node)
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "2.6.0"
+    VERSION = "2.7.0"
   end
 end

data/test/assertions_on_legacy_client_test.rb

@@ -0,0 +1,376 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class AssertionsOnLegacyClientTest < Minitest::Test
+  def setup
+    @old_client = StatsD.singleton_client
+    StatsD.singleton_client = StatsD.legacy_singleton_client
+
+    test_class = Class.new(Minitest::Test)
+    test_class.send(:include, StatsD::Instrument::Assertions)
+    @test_case = test_class.new('fake')
+  end
+
+  def teardown
+    StatsD.singleton_client = @old_client
+  end
+
+  def test_assert_no_statsd_calls
+    @test_case.assert_no_statsd_calls('counter') do
+      # noop
+    end
+
+    @test_case.assert_no_statsd_calls('counter') do
+      StatsD.increment('other')
+    end
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls('counter') do
+        StatsD.increment('counter')
+      end
+    end
+    assert_equal assertion.message, "No StatsD calls for metric counter expected."
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls do
+        StatsD.increment('other')
+      end
+    end
+    assert_equal assertion.message, "No StatsD calls for metric other expected."
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls do
+        StatsD.increment('other')
+        StatsD.increment('another')
+      end
+    end
+    assert_equal assertion.message, "No StatsD calls for metric other, another expected."
+  end
+
+  def test_assert_statsd_call
+    @test_case.assert_statsd_increment('counter') do
+      StatsD.increment('counter')
+    end
+
+    @test_case.assert_statsd_increment('counter') do
+      StatsD.increment('counter')
+      StatsD.increment('other')
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter') do
+        StatsD.increment('other')
+      end
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter') do
+        StatsD.gauge('counter', 42)
+      end
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter') do
+        StatsD.increment('counter')
+        StatsD.increment('counter')
+      end
+    end
+
+    @test_case.assert_statsd_increment('counter', times: 2) do
+      StatsD.increment('counter')
+      StatsD.increment('counter')
+    end
+
+    @test_case.assert_statsd_increment('counter', times: 2, tags: ['foo:1']) do
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 1 })
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter', times: 2, tags: ['foo:1']) do
+        StatsD.increment('counter', tags: { foo: 1 })
+        StatsD.increment('counter', tags: { foo: 2 })
+      end
+    end
+
+    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a', 'b']) do
+      StatsD.increment('counter', sample_rate: 0.5, tags: ['a', 'b'])
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a', 'b'], ignore_tags: ['b']) do
+        StatsD.increment('counter', sample_rate: 0.5, tags: ['a'])
+      end
+    end
+
+    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a'], ignore_tags: ['b']) do
+      StatsD.increment('counter', sample_rate: 0.5, tags: ['a', 'b'])
+    end
+
+    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a'], ignore_tags: ['b']) do
+      StatsD.increment('counter', sample_rate: 0.5, tags: ['a'])
+    end
+
+    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: { b: 2 }) do
+      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
+    end
+
+    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: { b: 2 }) do
+      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 3 })
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1, b: 3 }, ignore_tags: ['b']) do
+        StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
+      end
+    end
+
+    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }, ignore_tags: ['b']) do
+      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: ['a', 'b']) do
+        StatsD.increment('counter', sample_rate: 0.2, tags: ['c'])
+      end
+    end
+  end
+
+  def test_assert_statsd_gauge_call_with_numeric_value
+    @test_case.assert_statsd_gauge('gauge', value: 42) do
+      StatsD.gauge('gauge', 42)
+    end
+
+    @test_case.assert_statsd_gauge('gauge', value: '42') do
+      StatsD.gauge('gauge', 42)
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_gauge('gauge', value: 42) do
+        StatsD.gauge('gauge', 45)
+      end
+    end
+  end
+
+  def test_assert_statsd_set_call_with_string_value
+    @test_case.assert_statsd_set('set', value: 12345) do
+      StatsD.set('set', '12345')
+    end
+
+    @test_case.assert_statsd_set('set', value: '12345') do
+      StatsD.set('set', '12345')
+    end
+
+    @test_case.assert_statsd_set('set', value: 12345) do
+      StatsD.set('set', 12345)
+    end
+
+    @test_case.assert_statsd_set('set', value: '12345') do
+      StatsD.set('set', 12345)
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_set('set', value: '42') do
+        StatsD.set('set', 45)
+      end
+    end
+  end
+
+  def test_tags_will_match_subsets
+    @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1 }) do
+      StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2 })
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter', sample_rate: 0.5, tags: { a: 1, b: 3 }) do
+        StatsD.increment('counter', sample_rate: 0.5, tags: { a: 1, b: 2, c: 4 })
+      end
+    end
+  end
+
+  def test_tags_friendly_error
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter', tags: { class: "AnotherJob" }) do
+        StatsD.increment('counter', tags: { class: "MyJob" })
+      end
+    end
+
+    assert_includes assertion.message, "Captured metrics with the same key"
+    assert_includes assertion.message, "MyJob"
+  end
+
+  def test_multiple_metrics_are_not_order_dependent
+    foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:1'])
+    foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+    @test_case.assert_statsd_calls([foo_1_metric, foo_2_metric]) do
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 2 })
+    end
+
+    foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:1'])
+    foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+    @test_case.assert_statsd_calls([foo_2_metric, foo_1_metric]) do
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 2 })
+    end
+
+    foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 2, tags: ['foo:1'])
+    foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+    @test_case.assert_statsd_calls([foo_1_metric, foo_2_metric]) do
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 2 })
+    end
+
+    foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 2, tags: ['foo:1'])
+    foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+    @test_case.assert_statsd_calls([foo_2_metric, foo_1_metric]) do
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 2 })
+    end
+
+    foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 2, tags: ['foo:1'])
+    foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+    @test_case.assert_statsd_calls([foo_2_metric, foo_1_metric]) do
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 2 })
+      StatsD.increment('counter', tags: { foo: 1 })
+    end
+  end
+
+  def test_assert_multiple_statsd_calls
+    assert_raises(Minitest::Assertion) do
+      foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 2, tags: ['foo:1'])
+      foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+      @test_case.assert_statsd_calls([foo_1_metric, foo_2_metric]) do
+        StatsD.increment('counter', tags: { foo: 1 })
+        StatsD.increment('counter', tags: { foo: 2 })
+      end
+    end
+
+    assert_raises(Minitest::Assertion) do
+      foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 2, tags: ['foo:1'])
+      foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+      @test_case.assert_statsd_calls([foo_1_metric, foo_2_metric]) do
+        StatsD.increment('counter', tags: { foo: 1 })
+        StatsD.increment('counter', tags: { foo: 1 })
+        StatsD.increment('counter', tags: { foo: 2 })
+        StatsD.increment('counter', tags: { foo: 2 })
+      end
+    end
+
+    foo_1_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 2, tags: ['foo:1'])
+    foo_2_metric = StatsD::Instrument::MetricExpectation.new(type: :c, name: 'counter', times: 1, tags: ['foo:2'])
+    @test_case.assert_statsd_calls([foo_1_metric, foo_2_metric]) do
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 1 })
+      StatsD.increment('counter', tags: { foo: 2 })
+    end
+  end
+
+  def test_assert_statsd_call_with_tags
+    @test_case.assert_statsd_increment('counter', tags: ['a:b', 'c:d']) do
+      StatsD.increment('counter', tags: { a: 'b', c: 'd' })
+    end
+
+    @test_case.assert_statsd_increment('counter', tags: { a: 'b', c: 'd' }) do
+      StatsD.increment('counter', tags: ['a:b', 'c:d'])
+    end
+  end
+
+  def test_nested_assertions
+    @test_case.assert_statsd_increment('counter1') do
+      @test_case.assert_statsd_increment('counter2') do
+        StatsD.increment('counter1')
+        StatsD.increment('counter2')
+      end
+    end
+
+    @test_case.assert_statsd_increment('counter1') do
+      StatsD.increment('counter1')
+      @test_case.assert_statsd_increment('counter2') do
+        StatsD.increment('counter2')
+      end
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter1') do
+        @test_case.assert_statsd_increment('counter2') do
+          StatsD.increment('counter2')
+        end
+      end
+    end
+
+    assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter1') do
+        @test_case.assert_statsd_increment('counter2') do
+          StatsD.increment('counter1')
+        end
+        StatsD.increment('counter2')
+      end
+    end
+  end
+
+  def test_assertion_block_with_expected_exceptions
+    @test_case.assert_statsd_increment('expected_happened') do
+      @test_case.assert_raises(RuntimeError) do
+        begin
+          raise "expected"
+        rescue
+          StatsD.increment('expected_happened')
+          raise
+        end
+      end
+    end
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter') do
+        @test_case.assert_raises(RuntimeError) do
+          raise "expected"
+        end
+      end
+    end
+    assert_includes assertion.message, "No StatsD calls for metric counter of type c were made"
+  end
+
+  def test_assertion_block_with_unexpected_exceptions
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter') do
+        StatsD.increment('counter')
+        raise "unexpected"
+      end
+    end
+    assert_includes assertion.message, "An exception occurred in the block provided to the StatsD assertion"
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_raises(RuntimeError) do
+        @test_case.assert_statsd_increment('counter') do
+          StatsD.increment('counter')
+          raise "unexpected"
+        end
+      end
+    end
+    assert_includes assertion.message, "An exception occurred in the block provided to the StatsD assertion"
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_raises(RuntimeError) do
+        @test_case.assert_no_statsd_calls do
+          raise "unexpected"
+        end
+      end
+    end
+    assert_includes assertion.message, "An exception occurred in the block provided to the StatsD assertion"
+  end
+
+  def test_assertion_block_with_other_assertion_failures
+    # If another assertion failure happens inside the block, that failrue should have priority
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_statsd_increment('counter') do
+        @test_case.flunk('other assertion failure')
+      end
+    end
+    assert_equal "other assertion failure", assertion.message
+  end
+end