statsd-instrument 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feb99d0537663296eacb1c2f0c6d090f37430afc04d886b60a9aaf322f86a114
-  data.tar.gz: 0ed9a90c182d52d11a70490b78c369ba2ec9cdc1b4cf90c86d306199061d5dc9
+  metadata.gz: 85b73b161dac9bc8839c3b820e9ea038d05078519fca692e971a48be7077e799
+  data.tar.gz: e2d5bfa763a5d53537494c8a5006327a93967d4d2b63f74a685094c551815c81
 SHA512:
-  metadata.gz: bba9e06ddabc9ec50fcc6586f53376d5c5a97ddd1745265d76130544b07ebe603375b964bb1d2ede8e32f03963d098df3bca774873a610cee20fad7df11d537c
-  data.tar.gz: b60faf4b9164f883592109a04e64ffb7aaa60972460c26545526c43ad16d2c3ed4a897d9a537a3b285cae4c6435dae8afd96a3303cf7aa2b818afceca65cf17b
+  metadata.gz: e6db90f921635692d1d19145e3b346029886022c679649fac3e6f5641411ddc557fcd2028baff7be4e0b47a23e53f97e4afe9af4ecb7e537dc0850b32352fbec
+  data.tar.gz: 6c8f12361a70596d49dc84b3feb6637bc0ff7e9d62f1e6e7876ec02111cc94a2b561947ac4bfda045f612f57951f9789e578447e67a0b8bda4beec4f0fc76576

data/.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
     - name: Setup Ruby
       uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: 2.7
 
     - name: Install dependencies
       run: gem install bundler && bundle install --jobs 4 --retry 3

data/.rubocop.yml

@@ -5,8 +5,9 @@ require:
   - ./lib/statsd/instrument/rubocop.rb
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   UseCache: true
+  SuggestExtensions: false
   CacheRootDirectory: tmp/rubocop
   Exclude:
     - statsd-instrument.gemspec

data/CHANGELOG.md

@@ -8,6 +8,10 @@ section below.
 
 _Nothing yet_
 
+## Version 3.1.2
+
+ - Fix bug when passing custom client to expectation.
+
 ## Version 3.1.1
 
  - Improved flushing of buffered datagrams on process exit when using UDP batching.

data/README.md

@@ -1,6 +1,6 @@
 # StatsD client for Ruby apps
 
-This is a ruby client for statsd (http://github.com/etsy/statsd). It provides
+This is a ruby client for statsd (https://github.com/statsd/statsd). It provides
 a lightweight way to track and measure metrics in your application.
 
 We call out to statsd by sending data over a UDP socket. UDP sockets are fast,
@@ -10,8 +10,8 @@ because it means your code doesn't get bogged down trying to log statistics.
 We send data to statsd several times per request and haven't noticed a
 performance hit.
 
-For more information about StatsD, see the [README of the Etsy
-project](http://github.com/etsy/statsd).
+For more information about StatsD, see the [README of the StatsD
+project](https://github.com/statsd/statsd).
 
 ## Configuration
 

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

@@ -6,8 +6,8 @@ require "tmpdir"
 require "benchmark/ips"
 
 revision = %x(git rev-parse HEAD).rstrip
-master_revision = %x(git rev-parse origin/master).rstrip
-branch = if revision == master_revision
+base_revision = %x(git rev-parse origin/master).rstrip
+branch = if revision == base_revision
   "master"
 else
   %x(git rev-parse --abbrev-ref HEAD).rstrip

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

@@ -8,8 +8,8 @@ require "socket"
 require "statsd-instrument"
 
 revision = %x(git rev-parse HEAD).rstrip
-master_revision = %x(git rev-parse origin/master).rstrip
-branch = if revision == master_revision
+base_revision = %x(git rev-parse origin/master).rstrip
+branch = if revision == base_revision
   "master"
 else
   %x(git rev-parse --abbrev-ref HEAD).rstrip

data/lib/statsd/instrument/assertions.rb

@@ -74,7 +74,7 @@ module StatsD
       # @raise [Minitest::Assertion] If an exception occurs, or if the metric did
       #   not occur as specified during the execution the block.
       def assert_statsd_increment(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-        expectation = StatsD::Instrument::Expectation.increment(metric_name, value, **options)
+        expectation = StatsD::Instrument::Expectation.increment(metric_name, value, client: client, **options)
         assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
       end
 
@@ -86,7 +86,7 @@ module StatsD
       # @return [void]
       # @raise (see #assert_statsd_increment)
       def assert_statsd_measure(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-        expectation = StatsD::Instrument::Expectation.measure(metric_name, value, **options)
+        expectation = StatsD::Instrument::Expectation.measure(metric_name, value, client: client, **options)
         assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
       end
 
@@ -98,7 +98,7 @@ module StatsD
       # @return [void]
       # @raise (see #assert_statsd_increment)
       def assert_statsd_gauge(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-        expectation = StatsD::Instrument::Expectation.gauge(metric_name, value, **options)
+        expectation = StatsD::Instrument::Expectation.gauge(metric_name, value, client: client, **options)
         assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
       end
 
@@ -110,7 +110,7 @@ module StatsD
       # @return [void]
       # @raise (see #assert_statsd_increment)
       def assert_statsd_histogram(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-        expectation = StatsD::Instrument::Expectation.histogram(metric_name, value, **options)
+        expectation = StatsD::Instrument::Expectation.histogram(metric_name, value, client: client, **options)
         assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
       end
 
@@ -122,7 +122,7 @@ module StatsD
       # @return [void]
       # @raise (see #assert_statsd_increment)
       def assert_statsd_distribution(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-        expectation = StatsD::Instrument::Expectation.distribution(metric_name, value, **options)
+        expectation = StatsD::Instrument::Expectation.distribution(metric_name, value, client: client, **options)
         assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
       end
 
@@ -134,7 +134,7 @@ module StatsD
       # @return [void]
       # @raise (see #assert_statsd_increment)
       def assert_statsd_set(metric_name, value = nil, datagrams: nil, client: nil, **options, &block)
-        expectation = StatsD::Instrument::Expectation.set(metric_name, value, **options)
+        expectation = StatsD::Instrument::Expectation.set(metric_name, value, client: client, **options)
         assert_statsd_expectation(expectation, datagrams: datagrams, client: client, &block)
       end
 

data/lib/statsd/instrument/batched_udp_sink.rb

@@ -29,7 +29,7 @@ module StatsD
       end
 
       def sample?(sample_rate)
-        sample_rate == 1 || rand < sample_rate
+        sample_rate == 1.0 || rand < sample_rate
       end
 
       def <<(datagram)

data/lib/statsd/instrument/datagram_builder.rb

@@ -5,18 +5,6 @@ module StatsD
     # @note This class is part of the new Client implementation that is intended
     #   to become the new default in the next major release of this library.
     class DatagramBuilder
-      unless Regexp.method_defined?(:match?) # for ruby 2.3
-        module RubyBackports
-          refine Regexp do
-            def match?(str)
-              match(str) != nil
-            end
-          end
-        end
-
-        using(RubyBackports)
-      end
-
       def self.unsupported_datagram_types(*types)
         types.each do |type|
           define_method(type) do |_, _, _, _|

data/lib/statsd/instrument/expectation.rb

@@ -32,9 +32,10 @@ module StatsD
 
       attr_accessor :times, :type, :name, :value, :sample_rate, :tags
 
-      def initialize(client: StatsD.singleton_client, type:, name:, value: nil,
+      def initialize(client: nil, type:, name:, value: nil,
         sample_rate: nil, tags: nil, no_prefix: false, times: 1)
 
+        client ||= StatsD.singleton_client
         @type = type
         @name = no_prefix || !client.prefix ? name : "#{client.prefix}.#{name}"
         @value = normalized_value_for_type(type, value) if value
@@ -78,19 +79,6 @@ module StatsD
 
       private
 
-      # Needed for normalize_tags
-      unless Regexp.method_defined?(:match?) # for ruby 2.3
-        module RubyBackports
-          refine Regexp do
-            def match?(str)
-              (self =~ str) != nil
-            end
-          end
-        end
-
-        using(RubyBackports)
-      end
-
       # @private
       #
       # Utility function to convert tags to the canonical form.

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

@@ -19,7 +19,7 @@ module RuboCop
 
         MSG = "Do not use the return value of StatsD metric methods"
 
-        INVALID_PARENTS = %i{lvasgn array pair send return yield}
+        INVALID_PARENTS = [:lvasgn, :array, :pair, :send, :return, :yield]
 
         def on_send(node)
           if metric_method?(node) && node.arguments.last&.type != :block_pass

data/lib/statsd/instrument/rubocop.rb

@@ -3,34 +3,13 @@
 module RuboCop
   module Cop
     module StatsD
-      METRIC_METHODS = %i{
-        increment
-        gauge
-        measure
-        set
-        histogram
-        distribution
-        key_value
-      }
+      METRIC_METHODS = [:increment, :gauge, :measure, :set, :histogram, :distribution, :key_value]
 
-      METAPROGRAMMING_METHODS = %i{
-        statsd_measure
-        statsd_distribution
-        statsd_count_success
-        statsd_count_if
-        statsd_count
-      }
+      METAPROGRAMMING_METHODS = [:statsd_measure, :statsd_distribution, :statsd_count_success, :statsd_count_if,
+                                 :statsd_count,]
 
-      SINGLETON_CONFIGURATION_METHODS = %i{
-        backend
-        backend=
-        prefix
-        prefix=
-        default_tags
-        default_tags=
-        default_sample_rate
-        default_sample_rate=
-      }
+      SINGLETON_CONFIGURATION_METHODS = [:backend, :"backend=", :prefix, :"prefix=", :default_tags, :"default_tags=",
+                                         :default_sample_rate, :"default_sample_rate=",]
 
       private
 

data/lib/statsd/instrument/udp_sink.rb

@@ -20,7 +20,7 @@ module StatsD
       end
 
       def sample?(sample_rate)
-        sample_rate == 1 || rand < sample_rate
+        sample_rate == 1.0 || rand < sample_rate
       end
 
       def <<(datagram)

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "3.1.1"
+    VERSION = "3.1.2"
   end
 end

data/test/assertions_test.rb

@@ -440,4 +440,17 @@ class AssertionsTest < Minitest::Test
       StatsD.increment("incr", no_prefix: true)
     end
   end
+
+  def test_client_propagation_to_expectations
+    foo_1_metric = StatsD::Instrument::Expectation.increment("foo")
+    @test_case.assert_statsd_expectations([foo_1_metric]) do
+      StatsD.increment("foo")
+    end
+
+    client = StatsD::Instrument::Client.new(prefix: "prefix")
+    foo_2_metric = StatsD::Instrument::Expectation.increment("foo", client: client)
+    @test_case.assert_statsd_expectations([foo_2_metric]) do
+      StatsD.increment("prefix.foo")
+    end
+  end
 end

data/test/datagram_builder_test.rb

@@ -16,7 +16,7 @@ class DatagramBuilderTest < Minitest::Test
 
   def test_normalize_unsupported_tag_names
     assert_equal(["ign#ored"], @datagram_builder.send(:normalize_tags, ["ign#o|re,d"]))
-    # Note: how this is interpreted by the backend is undefined.
+    # NOTE: how this is interpreted by the backend is undefined.
     # We rely on the user to not do stuff like this if they don't want to be surprised.
     # We do not want to take the performance hit of normalizing this.
     assert_equal(["lol::class:omg::lol"], @datagram_builder.send(:normalize_tags, "lol::class" => "omg::lol"))

data/test/statsd_instrumentation_test.rb

@@ -345,7 +345,7 @@ class StatsDInstrumentationTest < Minitest::Test
     client = StatsD::Instrument::Client.new(prefix: "prefix")
 
     ActiveMerchant::Gateway.statsd_count(:ssl_post, "ActiveMerchant.Gateway.ssl_post", client: client)
-    assert_statsd_increment("prefix.ActiveMerchant.Gateway.ssl_post", client: client) do
+    assert_statsd_increment("ActiveMerchant.Gateway.ssl_post", client: client) do
       ActiveMerchant::Gateway.new.purchase(true)
     end
   ensure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -87,7 +87,6 @@ files:
 - statsd-instrument.gemspec
 - test/assertions_test.rb
 - test/benchmark/clock_gettime.rb
-- test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
 - test/capture_sink_test.rb
@@ -135,14 +134,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: A StatsD client for Ruby apps
 test_files:
 - test/assertions_test.rb
 - test/benchmark/clock_gettime.rb
-- test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
 - test/capture_sink_test.rb

data/test/benchmark/default_tags.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "statsd-instrument"
-require "benchmark/ips"
-
-StatsD.logger = Logger.new(File::NULL)
-
-class Suite
-  def warming(*args)
-    StatsD.default_tags = if args[0] == "with default tags"
-      { first_tag: "first_value", second_tag: "second_value" }
-    end
-    puts "warming with default tags: #{StatsD.default_tags}"
-  end
-
-  def running(*args)
-    StatsD.default_tags = if args[0] == "with default tags"
-      { first_tag: "first_value", second_tag: "second_value" }
-    end
-    puts "running with default tags: #{StatsD.default_tags}"
-  end
-
-  def warmup_stats(*)
-  end
-
-  def add_report(*)
-  end
-end
-
-suite = Suite.new
-
-Benchmark.ips do |bench|
-  bench.config(suite: suite)
-  bench.report("without default tags") do
-    StatsD.increment("GoogleBase.insert", tags: {
-      first_tag: "first_value",
-      second_tag: "second_value",
-      third_tag: "third_value",
-    })
-  end
-
-  bench.report("with default tags") do
-    StatsD.increment("GoogleBase.insert", tags: { third_tag: "third_value" })
-  end
-
-  bench.compare!
-end