statsd-instrument 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85b73b161dac9bc8839c3b820e9ea038d05078519fca692e971a48be7077e799
-  data.tar.gz: e2d5bfa763a5d53537494c8a5006327a93967d4d2b63f74a685094c551815c81
+  metadata.gz: f42d327300430dd5926c971c7d27d860acd99800cc8eeb4552892f755037553f
+  data.tar.gz: 88c22b7ef591313d0e159a24f3875ddc7a63acf0c6d10551cac6bf069a6c0ad3
 SHA512:
-  metadata.gz: e6db90f921635692d1d19145e3b346029886022c679649fac3e6f5641411ddc557fcd2028baff7be4e0b47a23e53f97e4afe9af4ecb7e537dc0850b32352fbec
-  data.tar.gz: 6c8f12361a70596d49dc84b3feb6637bc0ff7e9d62f1e6e7876ec02111cc94a2b561947ac4bfda045f612f57951f9789e578447e67a0b8bda4beec4f0fc76576
+  metadata.gz: 8a0d04e0acf3ddb8ae85bb3d5b4a560dbb713c6c8d26654cca6d52b5b3d70a8570b424b489e33d5bcc301f419db8e1de448daaee863fb0624ff52aa10c67c9a4
+  data.tar.gz: f56d3bd3ecd117d9a359de5445f3b00750d11151a40da26f6e902cd1c5800c8688ae1bab05f2457eb519751c642f69278425ba4541a6fe6caa41dd766dd3a21c

data/.github/workflows/benchmark.yml

@@ -5,18 +5,16 @@ on: push
 jobs:
   test:
     name: Send metric over UDP
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
 
-    - name: Setup Ruby
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6
-
-    - name: Install dependencies
-      run: gem install bundler && bundle install --jobs 4 --retry 3
+        bundler-cache: true
 
     - name: Run benchmark on branch
       run: benchmark/send-metrics-to-local-udp-receiver

data/.github/workflows/lint.yml

@@ -5,18 +5,16 @@ on: push
 jobs:
   test:
     name: Rubocop
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
 
-    - name: Setup Ruby
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
-
-    - name: Install dependencies
-      run: gem install bundler && bundle install --jobs 4 --retry 3
+        ruby-version: 2.6
+        bundler-cache: true
 
     - name: Run Rubocop
       run: bin/rubocop

data/.github/workflows/tests.yml

@@ -4,12 +4,12 @@ on: push
 
 jobs:
   test:
-    name: Ruby ${{ matrix.ruby }} on ubuntu-18.04
-    runs-on: ubuntu-18.04
+    name: Ruby ${{ matrix.ruby }} on ubuntu-latest
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.6', '2.7', '3.0']
+        ruby: ['2.6', '2.7', '3.0', '3.1']
 
         # Windows on macOS builds started failing, so they are disabled for noew
         # platform: [windows-2019, macOS-10.14, ubuntu-18.04]
@@ -19,13 +19,11 @@ jobs:
     steps:
     - uses: actions/checkout@v1
 
-    - name: Setup Ruby
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-
-    - name: Install dependencies
-      run: gem install bundler && bundle install --jobs 4 --retry 3
+        bundler-cache: true
 
     - name: Run test suite
-      run: rake test
+      run: bundle exec rake test

data/CHANGELOG.md

@@ -8,6 +8,10 @@ section below.
 
 _Nothing yet_
 
+## Version 3.2.0
+
+- Add `tag_error_class` option to `statsd_count_success` which tags the class of a thrown error
+
 ## Version 3.1.2
 
  - Fix bug when passing custom client to expectation.

data/Gemfile

@@ -8,6 +8,6 @@ gem "minitest"
 gem "rspec"
 gem "mocha"
 gem "yard"
-gem "rubocop", ">= 1.0"
+gem "rubocop", [">= 1.0", "< 1.30"] # TODO: Our cops are broken by rubocop 1.30, we need to figure out why
 gem "rubocop-shopify", require: false
 gem "benchmark-ips"

data/README.md

@@ -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 library will
+  - In the **production** and **staging** environment, the 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.

data/lib/statsd/instrument/assertions.rb

@@ -57,6 +57,7 @@ module StatsD
       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
 
@@ -152,6 +153,7 @@ module StatsD
       def assert_statsd_expectations(expectations, datagrams: nil, client: nil, &block)
         if datagrams.nil?
           raise LocalJumpError, "assert_statsd_expectations requires a block" unless block_given?
+
           datagrams = capture_statsd_datagrams_with_exception_handling(client: client, &block)
         end
 

data/lib/statsd/instrument/client.rb

@@ -200,6 +200,7 @@ module StatsD
       def increment(name, value = 1, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
         return StatsD::Instrument::VOID unless sample?(sample_rate)
+
         emit(datagram_builder(no_prefix: no_prefix).c(name, value, sample_rate, tags))
       end
 
@@ -217,6 +218,7 @@ module StatsD
 
         sample_rate ||= @default_sample_rate
         return StatsD::Instrument::VOID unless sample?(sample_rate)
+
         emit(datagram_builder(no_prefix: no_prefix).ms(name, value, sample_rate, tags))
       end
 
@@ -236,6 +238,7 @@ module StatsD
       def gauge(name, value, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
         return StatsD::Instrument::VOID unless sample?(sample_rate)
+
         emit(datagram_builder(no_prefix: no_prefix).g(name, value, sample_rate, tags))
       end
 
@@ -249,6 +252,7 @@ module StatsD
       def set(name, value, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
         return StatsD::Instrument::VOID unless sample?(sample_rate)
+
         emit(datagram_builder(no_prefix: no_prefix).s(name, value, sample_rate, tags))
       end
 
@@ -271,6 +275,7 @@ module StatsD
 
         sample_rate ||= @default_sample_rate
         return StatsD::Instrument::VOID unless sample?(sample_rate)
+
         emit(datagram_builder(no_prefix: no_prefix).d(name, value, sample_rate, tags))
       end
 
@@ -288,6 +293,7 @@ module StatsD
       def histogram(name, value, sample_rate: nil, tags: nil, no_prefix: false)
         sample_rate ||= @default_sample_rate
         return StatsD::Instrument::VOID unless sample?(sample_rate)
+
         emit(datagram_builder(no_prefix: no_prefix).h(name, value, sample_rate, tags))
       end
 

data/lib/statsd/instrument/datagram_builder.rb

@@ -67,10 +67,12 @@ module StatsD
       # @return [Array<String>, nil] the list of tags in canonical form.
       def normalize_tags(tags)
         return [] unless tags
+
         tags = tags.map { |k, v| "#{k}:#{v}" } if tags.is_a?(Hash)
 
         # Fast path when no string replacement is needed
         return tags unless tags.any? { |tag| /[|,]/.match?(tag) }
+
         tags.map { |tag| tag.tr("|,", "") }
       end
 
@@ -78,6 +80,7 @@ module StatsD
       def normalize_name(name)
         # Fast path when no normalization is needed to avoid copying the string
         return name unless /[:|@]/.match?(name)
+
         name.tr(":|@", "_")
       end
 

data/lib/statsd/instrument/expectation.rb

@@ -93,10 +93,12 @@ module StatsD
       #   to ensure that this logic matches the logic of the active datagram builder.
       def normalize_tags(tags)
         return [] unless tags
+
         tags = tags.map { |k, v| "#{k}:#{v}" } if tags.is_a?(Hash)
 
         # Fast path when no string replacement is needed
         return tags unless tags.any? { |tag| /[|,]/.match?(tag) }
+
         tags.map { |tag| tag.tr("|,", "") }
       end
     end

data/lib/statsd/instrument/helpers.rb

@@ -10,6 +10,22 @@ module StatsD
 
       # For backwards compatibility
       alias_method :capture_statsd_calls, :capture_statsd_datagrams
+
+      def self.add_tag(tags, key, value)
+        tags = tags.dup || {}
+
+        if tags.is_a?(String)
+          tags = tags.empty? ? "#{key}:#{value}" : "#{tags},#{key}:#{value}"
+        elsif tags.is_a?(Array)
+          tags << "#{key}:#{value}"
+        elsif tags.is_a?(Hash)
+          tags[key] = value
+        else
+          raise ArgumentError, "add_tag only supports string, array or hash, #{tags.class} provided"
+        end
+
+        tags
+      end
     end
   end
 end

data/lib/statsd/instrument/matchers.rb

@@ -49,7 +49,7 @@ module StatsD
             raise RSpec::Expectations::ExpectationNotMetError, "No StatsD calls for metric #{metric_name} were made."
           elsif options[:times] && options[:times] != metrics.length
             raise RSpec::Expectations::ExpectationNotMetError, "The numbers of StatsD calls for metric " \
-             "#{metric_name} was unexpected. Expected #{options[:times].inspect}, got #{metrics.length}"
+              "#{metric_name} was unexpected. Expected #{options[:times].inspect}, got #{metrics.length}"
           end
 
           [:sample_rate, :value, :tags].each do |expectation|

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

@@ -41,7 +41,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          -> (corrector) do
+          ->(corrector) do
             positional_arguments = if node.arguments.last.type == :block_pass
               node.arguments[2...node.arguments.length - 1]
             else

data/lib/statsd/instrument/rubocop.rb

@@ -39,6 +39,7 @@ module RuboCop
 
       def keyword_arguments(node)
         return nil if node.arguments.empty?
+
         last_argument = if node.arguments.last&.type == :block_pass
           node.arguments[node.arguments.length - 2]
         else

data/lib/statsd/instrument/statsd_datagram_builder.rb

@@ -11,6 +11,7 @@ module StatsD
 
       def normalize_tags(tags)
         raise NotImplementedError, "#{self.class.name} does not support tags" if tags
+
         super
       end
     end

data/lib/statsd/instrument/strict.rb

@@ -27,6 +27,7 @@ module StatsD
       def increment(key, value = 1, sample_rate: nil, tags: nil, no_prefix: false)
         raise ArgumentError, "StatsD.increment does not accept a block" if block_given?
         raise ArgumentError, "The value argument should be an integer, got #{value.inspect}" unless value.is_a?(Integer)
+
         check_tags_and_sample_rate(sample_rate, tags)
 
         super
@@ -35,6 +36,7 @@ module StatsD
       def gauge(key, value, sample_rate: nil, tags: nil, no_prefix: false)
         raise ArgumentError, "StatsD.increment does not accept a block" if block_given?
         raise ArgumentError, "The value argument should be an integer, got #{value.inspect}" unless value.is_a?(Numeric)
+
         check_tags_and_sample_rate(sample_rate, tags)
 
         super
@@ -43,6 +45,7 @@ module StatsD
       def histogram(key, value, sample_rate: nil, tags: nil, no_prefix: false)
         raise ArgumentError, "StatsD.increment does not accept a block" if block_given?
         raise ArgumentError, "The value argument should be an integer, got #{value.inspect}" unless value.is_a?(Numeric)
+
         check_tags_and_sample_rate(sample_rate, tags)
 
         super
@@ -50,6 +53,7 @@ module StatsD
 
       def set(key, value, sample_rate: nil, tags: nil, no_prefix: false)
         raise ArgumentError, "StatsD.set does not accept a block" if block_given?
+
         check_tags_and_sample_rate(sample_rate, tags)
 
         super

data/lib/statsd/instrument/udp_sink.rb

@@ -26,13 +26,11 @@ module StatsD
       def <<(datagram)
         with_socket { |socket| socket.send(datagram, 0) }
         self
-
       rescue ThreadError
         # In cases where a TERM or KILL signal has been sent, and we send stats as
         # part of a signal handler, locks cannot be acquired, so we do our best
         # to try and send the datagram without a lock.
         socket.send(datagram, 0) > 0
-
       rescue SocketError, IOError, SystemCallError => error
         StatsD.logger.debug do
           "[StatsD::Instrument::UDPSink] Resetting connection because of #{error.class}: #{error.message}"

data/lib/statsd/instrument/version.rb

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

data/lib/statsd/instrument.rb

@@ -104,24 +104,26 @@ module StatsD
     # @param method (see #statsd_measure)
     # @param name (see #statsd_measure)
     # @param metric_options (see #statsd_measure)
+    # @param tag_error_class add a <tt>error_class</tt> tag with the error class when an error is thrown
     # @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 considered a success, false otherwise.
     # @return [void]
     # @see #statsd_count_if
-    def statsd_count_success(method, name, sample_rate: nil, tags: nil, no_prefix: false, client: nil)
+    def statsd_count_success(method, name, sample_rate: nil,
+      tags: nil, no_prefix: false, client: nil, tag_error_class: false)
       add_to_method(method, name, :count_success) do
         define_method(method) do |*args, &block|
           truthiness = result = super(*args, &block)
-        rescue
+        rescue => error
           truthiness = false
           raise
         else
           if block_given?
             begin
               truthiness = yield(result)
-            rescue
+            rescue => error
               truthiness = false
             end
           end
@@ -130,6 +132,9 @@ module StatsD
           client ||= StatsD.singleton_client
           suffix = truthiness == false ? "failure" : "success"
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
+
+          tags = Helpers.add_tag(tags, :error_class, error.class.name) if tag_error_class && error
+
           client.increment("#{key}.#{suffix}", sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
         end
       end

data/test/helpers_test.rb

@@ -35,8 +35,47 @@ class HelpersTest < Minitest::Test
     StatsD.gauge("gauge", 15)
 
     assert_equal(2, metrics.length)
-
   ensure
     StatsD.singleton_client = @old_client
   end
+
+  def test_add_tag_works_for_nil
+    assert_equal({ key: 123 }, StatsD::Instrument::Helpers.add_tag(nil, :key, 123))
+  end
+
+  def test_add_tag_works_for_hashes
+    assert_equal({ key: 123 }, StatsD::Instrument::Helpers.add_tag({}, :key, 123))
+
+    existing = { existing: 123 }
+    assert_equal({ existing: 123, new: 456 }, StatsD::Instrument::Helpers.add_tag(existing, :new, 456))
+
+    # ensure we do not modify the existing tags
+    assert_equal({ existing: 123 }, existing)
+  end
+
+  def test_add_tag_works_for_arrays
+    assert_equal(["key:123"], StatsD::Instrument::Helpers.add_tag([], :key, 123))
+
+    existing = ["existing:123"]
+    assert_equal(["existing:123", "new:456"], StatsD::Instrument::Helpers.add_tag(existing, :new, 456))
+
+    # ensure we do not modify the existing tags
+    assert_equal(["existing:123"], existing)
+  end
+
+  def test_add_tag_works_for_strings
+    assert_equal("key:123", StatsD::Instrument::Helpers.add_tag("", :key, 123))
+
+    existing = "existing:123"
+    assert_equal("existing:123,new:456", StatsD::Instrument::Helpers.add_tag(existing, :new, 456))
+
+    # ensure we do not modify the existing tags
+    assert_equal("existing:123", existing)
+  end
+
+  def test_add_tags_raises_for_other
+    assert_raises(ArgumentError, "add_tag only supports string, array or hash, Integer provided") do
+      StatsD::Instrument::Helpers.add_tag(1, :key, 123)
+    end
+  end
 end

data/test/statsd_instrumentation_test.rb

@@ -159,6 +159,38 @@ class StatsDInstrumentationTest < Minitest::Test
     ActiveMerchant::UniqueGateway.statsd_remove_count_success(:ssl_post, "ActiveMerchant.Gateway")
   end
 
+  def test_statsd_count_success_tag_error_class
+    ActiveMerchant::Base.statsd_count_success(:ssl_post, "ActiveMerchant.Base", tag_error_class: true)
+
+    assert_statsd_increment("ActiveMerchant.Base.success", tags: nil) do
+      ActiveMerchant::Base.new.ssl_post(true)
+    end
+
+    assert_statsd_increment("ActiveMerchant.Base.failure", tags: ["error_class:RuntimeError"]) do
+      assert_raises(RuntimeError, "Not OK") do
+        ActiveMerchant::Base.new.ssl_post(false)
+      end
+    end
+  ensure
+    ActiveMerchant::Base.statsd_remove_count_success(:ssl_post, "ActiveMerchant.Base")
+  end
+
+  def test_statsd_count_success_tag_error_class_is_opt_in
+    ActiveMerchant::Base.statsd_count_success(:ssl_post, "ActiveMerchant.Base")
+
+    assert_statsd_increment("ActiveMerchant.Base.success", tags: nil) do
+      ActiveMerchant::Base.new.ssl_post(true)
+    end
+
+    assert_statsd_increment("ActiveMerchant.Base.failure", tags: nil) do
+      assert_raises(RuntimeError, "Not OK") do
+        ActiveMerchant::Base.new.ssl_post(false)
+      end
+    end
+  ensure
+    ActiveMerchant::Base.statsd_remove_count_success(:ssl_post, "ActiveMerchant.Base")
+  end
+
   def test_statsd_count
     ActiveMerchant::Gateway.statsd_count(:ssl_post, "ActiveMerchant.Gateway.ssl_post")
 

data/test/udp_sink_test.rb

@@ -136,7 +136,7 @@ module UDPSinkTests
 
         assert_equal(
           "[#{@sink_class}] Resetting connection because of " \
-          "Errno::EDESTADDRREQ: Destination address required\n",
+            "Errno::EDESTADDRREQ: Destination address required\n",
           logs.string,
         )
       ensure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: A StatsD client for Ruby apps