statsd-instrument 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcbaac2cd4178c61bfcb484c45931bb387d81dfa632fbd114bba126c393beb75
-  data.tar.gz: d1101fbc534b6612ff76a282ab45d37aad3a0c185b3ccedf6dcf2ef78ce85bb1
+  metadata.gz: 7f4884abfa414d10454edd851f0a15cf51b4333396cf4cd2da209f6f7e543366
+  data.tar.gz: 2e3f6b906fd8ab8a651d683475dbb660ea37a5207de95722efdf5c467cda2c94
 SHA512:
-  metadata.gz: 4cd62e31fe1dc59ae49345e598de791ba1295a18d527d88f840de7349d31e8d325cf00543e59eddf02c3fed56a58f9020ace88ca7554de2340d193e8e62cb1d4
-  data.tar.gz: 98fcae4a9b924ab432d745ad2c02f4ac5ed6d0e94ad1f002e80afc0f4f741f01412dbf605151813432dc828ad57f9c1747e26a7127c32950df9ffddeb90e9523
+  metadata.gz: d771c8e13ef08ef146170b41024e09abbabaca4ebbfeb9c34781f04a2fdaf287776e7c79d93fe49d5ffb9ac18da82a1759d37621697d18cf9e5e423577110aae
+  data.tar.gz: 573003d398eba6f81fb13385bf93c0ee4254c5074ba935471cd2dee659c1c2016f9c9bb44f9c71383a30b5b91129c12753c949118ebc103b6cb1595609e534e6

data/CHANGELOG.md

@@ -4,7 +4,13 @@ This file documents the changes between releases of this library. When
 creating a pull request, please add an entry to the "unreleased changes"
 section below.
 
-### Unreleased changes
+## Unreleased changes
+
+## Version 3.5.0
+
+- Allow user to provide a lambda function to dynamically set metric tags
+
+## Version 3.4.0
 
 - UDP Batching has been largely refactored again. The `STATSD_FLUSH_INTERVAL` environment variable
   is deprecated. It still disable batching if set to `0`, but other than that is has no effect.
@@ -516,123 +522,123 @@ average metric considerably.
 
 - Add mutex around UDP socket invalidation (#147)
 
-### Version 2.3.0
+## Version 2.3.0
 
 - No changes from `beta6`, distributions are GA at DataDog so making the distribution changes GA in gem
 
-### Version 2.3.0.beta6
+## Version 2.3.0.beta6
 
 - Fix invalidate socket on connectivity issues in UDP (#135)
 
-### Version 2.3.0.beta5
+## Version 2.3.0.beta5
 
 - Fixes bug in return value for blocks used in distributions (#132)
 
-### Version 2.3.0.beta4
+## Version 2.3.0.beta4
 
 - Add support for distribution to accept a block
 - Add class method for defining and removing a distribution from a method (same as a measure)
 - Refactor most instrument methods to reduce code duplication
 
-### Version 2.3.0.beta3
+## Version 2.3.0.beta3
 
 - fix for `:as_dist` parameter in the `statsd_measure` class method
 
-### Version 2.3.0.beta2
+## Version 2.3.0.beta2
 
 - Add support for specifying a measure to emit as a distribution using `:as_dist` parameter
 
-### Version 2.3.0.beta
+## Version 2.3.0.beta
 
 - Add support for beta, Datadog specific distribution metrics
 - Invalidate socket on connectivity issues
 
-### Version 2.2.1
+## Version 2.2.1
 
 - Fix performance regression from v2.2.0
 
-### Version 2.2.0
+## Version 2.2.0
 
 - Add support for two new Datadog specific metric types: events and service checks.
 
-### Version 2.1.3
+## Version 2.1.3
 
 - The `assert_statsd_calls` test helper will now raise an exception whenever a block isn't passed.
 - Sending stats inside an exit handler will no longer cause programs to exit abruptly.
 
-### Version 2.1.2
+## Version 2.1.2
 
 - Use `prepend` instead of rewriting classes for metaprogramming methods.
 - RSpec: make matchers more flexible.
 - Bugfix: Only ask Rails for the environment when it's actually loaded.
 
-### Version 2.1.1
+## Version 2.1.1
 
 - Add `assert_statsd_calls` to from validating cases where one has multiple metrics with the same name and type being recorded, but with different options.
 
-### Version 2.1.0
+## Version 2.1.0
 
 - Fix rspec-rails compatibility
 - Add `value` keyword argument to all metric types.
 
-### Version 2.0.12
+## Version 2.0.12
 
 - Make StatsD client thread-safe
 - Assertions: Ensure sample rates have proper values.
 - Assertions: Make tag assertions work more intuitively
 - RSpec: Add backwards compatibility for RSpec 2
 
-### Version 2.0.11
+## Version 2.0.11
 
 - Don't change method visibility when adding instrumentation to methods using metaprogramming
 - RSpec: add support for Compound expectations
 
-### Version 2.0.10
+## Version 2.0.10
 
 - Assertions: allow ignoring certain tags when asserting for other tags to be present.
 
-### Version 2.0.9
+## Version 2.0.9
 
 - Better error message for `assert_no_statsd_calls`
 
-### Version 2.0.8
+## Version 2.0.8
 
 - More tag handling performance improvements.
 - RSpec matchers documentation improvements
 
-### Version 2.0.7
+## Version 2.0.7
 
 - Tag handling performance improvements.
 - Test against Ruby 2.2.
 - Drop support for Ruby 1.9.3.
 
-### Version 2.0.6
+## Version 2.0.6
 
 - Fix some loading order issues in Rails environments.
 - Default behavior: in a **staging** environment, the defaults are now the same as in a **production environment**.
 - Documentation overhaul
 
-### Version 2.0.5
+## Version 2.0.5
 
 - Allow for nested assertions using the `assert_statsd_*` assertion methods.
 
-### Version 2.0.4
+## Version 2.0.4
 
 - Add a Railtie to fix some initialization issues.
 
-### Version 2.0.3
+## Version 2.0.3
 
 - Assertion method bugfixes
 
-### Version 2.0.2
+## Version 2.0.2
 
 - Documentation fixes
 
-### Version 2.0.1
+## Version 2.0.1
 
 - Add assertion methods `assert_statsd_histogram`, `assert_statsd_set`, and `assert_statsd_key_value`.
 
-### Version 2.0.0
+## Version 2.0.0
 
 - Complete rewrite using pluggable backends.
 - Add assertion methods in `StatsD::Instrument::Assertions` to make testing easier and less brittle.

data/README.md

@@ -21,7 +21,7 @@ The following environment variables are supported:
 - `STATSD_ADDR`: (default `localhost:8125`) The address to send the StatsD UDP
   datagrams to.
 - `STATSD_IMPLEMENTATION`: (default: `datadog`). The StatsD implementation you
-  are using. `statsd`, `statsite` and `datadog` are supported. Some features
+  are using. `statsd` and `datadog` are supported. Some features
   are only available on certain implementations,
 - `STATSD_ENV`: The environment StatsD will run in. If this is not set
   explicitly, this will be determined based on other environment variables,
@@ -255,6 +255,16 @@ GoogleBase.statsd_count :insert, 'GoogleBase.insert', tags: ['env:production']
 If implementation is not set to `:datadog`, tags will not be included in the UDP packets, and a
 warning is logged to `StatsD.logger`.
 
+You can use lambda function that instead of a list of tags to set the metric tags.
+Like the dynamic metric name, the lambda function must accept two arguments:
+the object the function is being called on and the array of arguments
+passed.
+
+``` ruby
+metric_tagger = lambda { |object, args| { "key": args.first } }
+GoogleBase.statsd_count(:insert, 'GoogleBase.insert', tags: metric_tagger)
+```
+
 ## Testing
 
 This library comes with a module called `StatsD::Instrument::Assertions` and `StatsD::Instrument::Matchers` to help you write tests

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "3.4.0"
+    VERSION = "3.5.0"
   end
 end

data/lib/statsd/instrument.rb

@@ -34,6 +34,15 @@ module StatsD
       name.respond_to?(:call) ? name.call(callee, args).gsub("::", ".") : name.gsub("::", ".")
     end
 
+    # Generates the tags for an instrumented method.
+    # @private
+    # @return [Array[String]]
+    def self.generate_tags(tags, callee, *args)
+      return if tags.nil?
+
+      tags.respond_to?(:call) ? tags.call(callee, args) : tags
+    end
+
     # Even though this method is considered private, and is no longer used internally,
     # applications in the wild rely on it. As a result, we cannot remove this method
     # until the next major version.
@@ -61,6 +70,8 @@ module StatsD
     # @param method [Symbol] The name of the method to instrument.
     # @param name [String, #call] The name of the metric to use. You can also pass in a
     #    callable to dynamically generate a metric name
+    # @param tags [Hash, #call] The tags to be associated with the metric. You can also
+    #    pass in a callable to dynamically generate the tags key and values
     # @param metric_options (see StatsD#measure)
     # @return [void]
     def statsd_measure(method, name, sample_rate: nil, tags: nil, no_prefix: false, client: nil)
@@ -68,6 +79,7 @@ module StatsD
         define_method(method) do |*args, &block|
           client ||= StatsD.singleton_client
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
+          tags = StatsD::Instrument.generate_tags(tags, self, *args)
           client.measure(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix) do
             super(*args, &block)
           end
@@ -88,6 +100,7 @@ module StatsD
         define_method(method) do |*args, &block|
           client ||= StatsD.singleton_client
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
+          tags = StatsD::Instrument.generate_tags(tags, self, *args)
           client.distribution(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix) do
             super(*args, &block)
           end
@@ -132,7 +145,7 @@ module StatsD
           client ||= StatsD.singleton_client
           suffix = truthiness == false ? "failure" : "success"
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
-
+          tags = StatsD::Instrument.generate_tags(tags, 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)
@@ -172,6 +185,7 @@ module StatsD
           if truthiness
             client ||= StatsD.singleton_client
             key = StatsD::Instrument.generate_metric_name(name, self, *args)
+            tags = StatsD::Instrument.generate_tags(tags, self, *args)
             client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
           end
         end
@@ -192,6 +206,7 @@ module StatsD
         define_method(method) do |*args, &block|
           client ||= StatsD.singleton_client
           key = StatsD::Instrument.generate_metric_name(name, self, *args)
+          tags = StatsD::Instrument.generate_tags(tags, self, *args)
           client.increment(key, sample_rate: sample_rate, tags: tags, no_prefix: no_prefix)
           super(*args, &block)
         end

data/test/changelog_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ChangelogTest < Minitest::Test
+  def test_has_heading_for_current_version
+    assert_includes(changelog_headings, current_version_heading)
+  end
+
+  def test_headings_are_consistent
+    invalid_headings = changelog_headings.reject do |heading|
+      next true if heading == "# Changelog"
+      next true if heading == "## Unreleased changes"
+
+      # Remaining headings are <h2> if and only if they are version headings, and must be formatted correctly.
+      if heading.start_with?("## ") || heading.include?("Version")
+        next heading.match?(/^## Version \d+\.\d+\.\d+/)
+      end
+
+      next true if heading.start_with?("###") # <h3> and lower are permitted
+
+      false # All other headings are forbidden
+    end
+
+    assert_empty(invalid_headings, "Headings must follow formatting conventions")
+  end
+
+  private
+
+  def current_version_heading
+    "## Version #{StatsD::Instrument::VERSION}"
+  end
+
+  def changelog_headings
+    File.read("CHANGELOG.md").each_line.grep(/^#/).map(&:strip)
+  end
+end

data/test/statsd_instrumentation_test.rb

@@ -7,7 +7,7 @@ class StatsDInstrumentationTest < Minitest::Test
     class Base
       extend StatsD::Instrument
 
-      def ssl_post(arg)
+      def ssl_post(arg, async: false)
         if arg
           "OK"
         else
@@ -21,8 +21,8 @@ class StatsDInstrumentationTest < Minitest::Test
     end
 
     class Gateway < Base
-      def purchase(arg)
-        ssl_post(arg)
+      def purchase(arg, async: false)
+        ssl_post(arg, async: async)
         true
       rescue
         false
@@ -34,12 +34,12 @@ class StatsDInstrumentationTest < Minitest::Test
     end
 
     class UniqueGateway < Base
-      def ssl_post(arg)
+      def ssl_post(arg, async: false)
         { success: arg }
       end
 
-      def purchase(arg)
-        ssl_post(arg)
+      def purchase(arg, async: false)
+        ssl_post(arg, async: async)
       end
     end
   end
@@ -223,6 +223,30 @@ class StatsDInstrumentationTest < Minitest::Test
     ActiveMerchant::Gateway.statsd_remove_count(:ssl_post, metric_namer)
   end
 
+  def test_statsd_count_with_tags_as_lambda
+    metric_namer = lambda { |object, args| "#{object.metric_name}.#{args.first}" }
+    metric_tagger = lambda { |_object, args| { "key": args.first } }
+    ActiveMerchant::Gateway.statsd_count(:ssl_post, metric_namer, tags: metric_tagger)
+
+    assert_statsd_increment("subgateway.foo", tags: { "key": "foo" }) do
+      GatewaySubClass.new.purchase("foo")
+    end
+  ensure
+    ActiveMerchant::Gateway.statsd_remove_count(:ssl_post, metric_namer)
+  end
+
+  def test_statsd_count_with_tags_as_proc
+    metric_namer = proc { |object, args| "#{object.metric_name}.#{args.first}" }
+    metric_tagger = proc { |_object, args| { "key": args.first } }
+    ActiveMerchant::Gateway.statsd_count(:ssl_post, metric_namer, tags: metric_tagger)
+
+    assert_statsd_increment("subgateway.foo", tags: { "key": "foo" }) do
+      GatewaySubClass.new.purchase("foo")
+    end
+  ensure
+    ActiveMerchant::Gateway.statsd_remove_count(:ssl_post, metric_namer)
+  end
+
   def test_statsd_count_with_method_receiving_block
     ActiveMerchant::Base.statsd_count(:post_with_block, "ActiveMerchant.Base.post_with_block")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies: []
 description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
   StatsD instrumentation into your code.
@@ -77,6 +77,7 @@ files:
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
 - test/capture_sink_test.rb
+- test/changelog_test.rb
 - test/client_test.rb
 - test/datagram_builder_test.rb
 - test/datagram_test.rb
@@ -131,6 +132,7 @@ test_files:
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
 - test/capture_sink_test.rb
+- test/changelog_test.rb
 - test/client_test.rb
 - test/datagram_builder_test.rb
 - test/datagram_test.rb