statsd-instrument 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4768c067e6be6c254db4557916f0cfecb4b86cb318bc8c220acfaf67e9930029
-  data.tar.gz: 756ea941dc116e8c4ed95f1d6af1060ca1d524271b13cb5a418772fc7952519b
+  metadata.gz: 1f2b45a3e809ef0e5ca26b7faf52512632705f62120b3b73987a10282e19ed76
+  data.tar.gz: 7d7574e77adea4dc54fcf0355b83e1392623bcf2d4ecccd60a2cc101f62c84bb
 SHA512:
-  metadata.gz: aab58b7242348378b11869da05bcf548c434b63a5f9155a904532b186e5a420e44891c30b1e551d0627359da05fad9c50414876d6eb57baba5883b7990f1d127
-  data.tar.gz: aece18a4af6ef4a14fbb437a91b3dcbd84b7a876a815210d3fb1e207b4851bc8803531589f1b985563da5a31e93e2724d1cc18d2d063742d7dc91ccbeb5abf60
+  metadata.gz: bb416ef206605fb8204acec2b0501e4722a2bd51d81fbc1083c4a4a96203a2838dd329355908ee83b64b7a3943f8f8af862cbf7d8433363d4452e68f14292f95
+  data.tar.gz: bf0597922ce2dbe8837ef29b0de1f7c4fa1ca0e9623dc4d15628661b49059577d31499c46164a14e98744c5e765d68b407a15f14153c212ec245f3d90ed691e7

data/CHANGELOG.md

@@ -6,6 +6,11 @@ section below.
 
 ## Unreleased changes
 
+## Version 3.11.0
+
+- [#418](https://github.com/Shopify/statsd-instrument/pull/418) - Prevent misuse of `CompiledMetric` definitions by requiring a subclass when defining one.
+- [#417](https://github.com/Shopify/statsd-instrument/pull/417) - Add a `metric_name` method to `CompiledMetric`.
+
 ## Version 3.10.0
 
 - [#416](https://github.com/Shopify/statsd-instrument/pull/416) - Fix missing `metric_prefix` in Aggregator finalizer, causing metrics to lose their prefix when flushed during GC.

data/lib/statsd/instrument/compiled_metric.rb

@@ -18,6 +18,12 @@ module StatsD
     #   # Later, emit with minimal allocations:
     #   CheckoutMetric.increment(shop_id: 123, user_id: 456, value: 1)
     class CompiledMetric
+      # Raised when a CompiledMetric subclass is defined incorrectly.
+      # This includes calling `define` on a base type class directly,
+      # calling `define` more than once, or using a metric before `define`
+      # has been called.
+      class DefinitionError < StandardError; end
+
       # Default maximum number of unique tag combinations to cache before clearing
       # the cache to prevent unbounded memory growth
       DEFAULT_MAX_TAG_COMBINATION_CACHE_SIZE = 5000
@@ -33,6 +39,19 @@ module StatsD
         # @param max_cache_size [Integer] Maximum tag combinations this metric supports, and will be retained in-memory. Cardinality beyond this number will fall back to the slow path and should be avoided.
         # @return [Class] A new CompiledMetric subclass configured for this metric
         def define(name:, static_tags: {}, tags: {}, no_prefix: false, sample_rate: nil, max_cache_size: DEFAULT_MAX_TAG_COMBINATION_CACHE_SIZE)
+          if equal?(CompiledMetric) || superclass.equal?(CompiledMetric)
+            raise DefinitionError,
+              "`define` must be called on a subclass, not on #{self.name} directly. " \
+                "Use `Class.new(#{self.name}) { define(...) }` or " \
+                "`class MyMetric < #{self.name}; define(...); end` instead."
+          end
+
+          if defined?(@datagram_blueprint)
+            raise DefinitionError,
+              "`define` has already been called on #{self.name}. " \
+                "Each CompiledMetric subclass can only be defined once."
+          end
+
           client = StatsD.singleton_client
 
           # Build the datagram blueprint using the builder
@@ -51,7 +70,7 @@ module StatsD
           # Create a new class for this specific metric
           # Using classes instead of instances for better YJIT optimization
           metric_class = tap do
-            @name = DatagramBlueprintBuilder.normalize_name(name)
+            @name = DatagramBlueprintBuilder.normalize_name(name).freeze
             @datagram_blueprint = datagram_blueprint
             @tag_combination_cache = {}
             @max_cache_size = max_cache_size
@@ -101,10 +120,15 @@ module StatsD
           @singleton_client.sink.sample?(sample_rate)
         end
 
+        # @return [String, nil] The normalized metric name for this compiled metric class (`nil` if not yet defined).
+        def metric_name
+          @name
+        end
+
         # @return [Float] The defined sample rate for a metric class.
         # Will raise when `define` has not yet been called on the class.
         def sample_rate
-          raise ArgumentError, "Every CompiledMetric subclass needs to call `define` before accessing its sample_rate." unless defined?(@sample_rate)
+          raise DefinitionError, "Every CompiledMetric subclass needs to call `define` before accessing its sample_rate." unless defined?(@sample_rate)
 
           @sample_rate
         end
@@ -115,7 +139,7 @@ module StatsD
         # Once `define` was called during the class creation, it will override the
         # method implementation to emit the actual metric datagrams.
         def require_define_to_be_called
-          raise ArgumentError, "Every CompiledMetric subclass needs to call `define` before first invocation of #{method_name}."
+          raise DefinitionError, "Every CompiledMetric subclass needs to call `define` before first invocation of #{method_name}."
         end
 
         def generate_block_handler

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "3.10.0"
+    VERSION = "3.11.0"
   end
 end

data/test/compiled_metric/counter_test.rb

@@ -24,7 +24,7 @@ class CompiledMetricCounterTest < Minitest::Test
   def test_counter_without_define
     metric = Class.new(StatsD::Instrument::CompiledMetric::Counter)
 
-    error = assert_raises(ArgumentError) do
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
       metric.increment(5)
     end
     assert_equal("Every CompiledMetric subclass needs to call `define` before first invocation of increment.", error.message)

data/test/compiled_metric/distribution_test.rb

@@ -24,7 +24,7 @@ class CompiledMetricDistributionTest < Minitest::Test
   def test_distribution_without_define
     metric = Class.new(StatsD::Instrument::CompiledMetric::Distribution)
 
-    error = assert_raises(ArgumentError) do
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
       metric.distribution(5)
     end
     assert_equal("Every CompiledMetric subclass needs to call `define` before first invocation of distribution.", error.message)

data/test/compiled_metric/gauge_test.rb

@@ -24,7 +24,7 @@ class CompiledMetricGaugeTest < Minitest::Test
   def test_gauge_without_define
     metric = Class.new(StatsD::Instrument::CompiledMetric::Gauge)
 
-    error = assert_raises(ArgumentError) do
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
       metric.gauge(5)
     end
     assert_equal("Every CompiledMetric subclass needs to call `define` before first invocation of gauge.", error.message)

data/test/compiled_metric_test.rb

@@ -439,9 +439,78 @@ class CompiledMetricDefinitionTest < Minitest::Test
   def test_sample_rate_without_define
     metric = Class.new(StatsD::Instrument::CompiledMetric::Counter)
 
-    error = assert_raises(ArgumentError) do
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
       metric.sample_rate
     end
     assert_equal("Every CompiledMetric subclass needs to call `define` before accessing its sample_rate.", error.message)
   end
+
+  def test_metric_name
+    metric = Class.new(StatsD::Instrument::CompiledMetric::Counter) do
+      define(
+        name: "foo.bar",
+      )
+    end
+
+    assert_equal("foo.bar", metric.metric_name)
+    assert_predicate(metric.metric_name, :frozen?)
+  end
+
+  def test_metric_name_is_normalized
+    metric = Class.new(StatsD::Instrument::CompiledMetric::Counter) do
+      define(
+        name: "foo:bar|baz@qux",
+      )
+    end
+
+    assert_equal("foo_bar_baz_qux", metric.metric_name)
+    assert_predicate(metric.metric_name, :frozen?)
+  end
+
+  def test_metric_name_without_define
+    metric = Class.new(StatsD::Instrument::CompiledMetric::Counter)
+
+    assert_nil(metric.metric_name)
+  end
+
+  def test_define_directly_on_counter_raises
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
+      StatsD::Instrument::CompiledMetric::Counter.define(name: "bad_metric")
+    end
+    assert_includes(error.message, "`define` must be called on a subclass")
+    assert_includes(error.message, "Counter")
+  end
+
+  def test_define_directly_on_gauge_raises
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
+      StatsD::Instrument::CompiledMetric::Gauge.define(name: "bad_metric")
+    end
+    assert_includes(error.message, "`define` must be called on a subclass")
+    assert_includes(error.message, "Gauge")
+  end
+
+  def test_define_directly_on_distribution_raises
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
+      StatsD::Instrument::CompiledMetric::Distribution.define(name: "bad_metric")
+    end
+    assert_includes(error.message, "`define` must be called on a subclass")
+    assert_includes(error.message, "Distribution")
+  end
+
+  def test_define_directly_on_compiled_metric_raises
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
+      StatsD::Instrument::CompiledMetric.define(name: "bad_metric")
+    end
+    assert_includes(error.message, "`define` must be called on a subclass")
+  end
+
+  def test_double_define_raises
+    error = assert_raises(StatsD::Instrument::CompiledMetric::DefinitionError) do
+      Class.new(StatsD::Instrument::CompiledMetric::Counter) do
+        define(name: "first_metric")
+        define(name: "second_metric")
+      end
+    end
+    assert_includes(error.message, "`define` has already been called")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.9
 specification_version: 4
 summary: A StatsD client for Ruby apps
 test_files: