statsd-instrument 3.11.0 → 3.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f2b45a3e809ef0e5ca26b7faf52512632705f62120b3b73987a10282e19ed76
-  data.tar.gz: 7d7574e77adea4dc54fcf0355b83e1392623bcf2d4ecccd60a2cc101f62c84bb
+  metadata.gz: 3da8fd9b1f80c7cf776c41d335ab14858dd625299bbec536c7f8994dfe93baf6
+  data.tar.gz: b1ca1c4049a5f3956ea510074027bb577d26ab8a2033cf96d4af5fcc39fc90c9
 SHA512:
-  metadata.gz: bb416ef206605fb8204acec2b0501e4722a2bd51d81fbc1083c4a4a96203a2838dd329355908ee83b64b7a3943f8f8af862cbf7d8433363d4452e68f14292f95
-  data.tar.gz: bf0597922ce2dbe8837ef29b0de1f7c4fa1ca0e9623dc4d15628661b49059577d31499c46164a14e98744c5e765d68b407a15f14153c212ec245f3d90ed691e7
+  metadata.gz: f8774b020de05ec35687a82aca947a19b095ea34867fdcd73518748c9ccddfe28e41cdc41c2dfe1b9c2e4f657b4416218d67fe3b0e259a8bf10a810580f8ea60
+  data.tar.gz: 420ea1eb853426b83d2d5f546dde091d402aaff31ef243b912df3869dd02882e8ef24bde4b124f860beccb0e9528dcfbcd7ab6b25b36b3d2fc3e02798fa209e1

data/CHANGELOG.md

@@ -6,6 +6,10 @@ section below.
 
 ## Unreleased changes
 
+## Version 3.11.1
+
+- Fix `CompiledMetric::Distribution` applying `sample_rate` twice.
+
 ## 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.

data/lib/statsd/instrument/client.rb

@@ -285,6 +285,25 @@ module StatsD
         StatsD::Instrument::VOID
       end
 
+      # Emits a pre-sampled compiled distribution metric.
+      # This method is used when the generated compiled metric method already made
+      # the sampling decision before measuring block latency.
+      #
+      # @param precompiled_datagram [StatsD::Instrument::CompiledMetric::PrecompiledDatagram]
+      #   The precompiled metric datagram
+      # @param value [Numeric] The metric value
+      # @return [void]
+      # @api private
+      def emit_presampled_precompiled_distribution_metric(precompiled_datagram, value)
+        if @enable_aggregation
+          @aggregator.aggregate_precompiled_timing_metric(precompiled_datagram, value)
+          return StatsD::Instrument::VOID
+        end
+
+        emit(precompiled_datagram.to_datagram(value))
+        StatsD::Instrument::VOID
+      end
+
       # Emits a precompiled metric for high-performance use cases.
       # This method is used by {StatsD::Instrument::CompiledMetric::Gauge} to emit metrics
       # with minimal allocations.

data/lib/statsd/instrument/compiled_metric.rb

@@ -177,6 +177,10 @@ module StatsD
           default_val = default_value
           default_val_assignment = default_val.nil? ? "" : " = #{default_val.inspect}"
           allow_block = allow_measuring_latency
+          # Block-enabled compiled metrics run through generate_block_handler first,
+          # which applies sample_rate before emitting. Use the presampled client helper
+          # here so distributions don't make a second sampling decision.
+          client_emit_method = allow_block ? "emit_presampled_precompiled_#{method}_metric" : "emit_precompiled_#{method}_metric"
 
           method_code = <<~RUBY
             def self.#{method}(__value__#{default_val_assignment}, #{tag_names.map { |name| "#{name}:" }.join(", ")})
@@ -218,7 +222,7 @@ module StatsD
 
               __datagram__ ||= PrecompiledDatagram.new([#{tag_names.join(", ")}], @datagram_blueprint, @sample_rate)
 
-              @singleton_client.emit_precompiled_#{method}_metric(__datagram__, __value__)
+              @singleton_client.#{client_emit_method}(__datagram__, __value__)
               __return_value__
             end
           RUBY
@@ -233,12 +237,16 @@ module StatsD
           method = method_name
           default_val = default_value
           allow_block = allow_measuring_latency
+          # Block-enabled compiled metrics run through generate_block_handler first,
+          # which applies sample_rate before emitting. Use the presampled client helper
+          # here so distributions don't make a second sampling decision.
+          client_emit_method = allow_block ? "emit_presampled_precompiled_#{method}_metric" : "emit_precompiled_#{method}_metric"
 
           instance_eval(<<~RUBY, __FILE__, __LINE__ + 1)
             def self.#{method}(__value__ = #{default_val.inspect})
               __return_value__ = StatsD::Instrument::VOID
               #{generate_block_handler if allow_block}
-              @singleton_client.emit_precompiled_#{method}_metric(@static_datagram, __value__)
+              @singleton_client.#{client_emit_method}(@static_datagram, __value__)
               __return_value__
             end
           RUBY

data/lib/statsd/instrument/version.rb

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

data/test/compiled_metric/distribution_test.rb

@@ -230,6 +230,43 @@ class CompiledMetricDistributionTest < Minitest::Test
     assert_equal(["env:production", "region:us-east", "service:web"], datagram.tags.sort)
   end
 
+  def test_sampled_distribution_value_uses_one_sampling_decision
+    sample_rate = 0.5
+    @sink.expects(:sample?).with(sample_rate).once.returns(true)
+
+    metric = Class.new(StatsD::Instrument::CompiledMetric::Distribution) do
+      define(
+        name: "foo.bar",
+        tags: { shop_id: Integer },
+        sample_rate: sample_rate,
+      )
+    end
+
+    metric.distribution(5, shop_id: 123)
+
+    assert_equal(1, @sink.datagrams.size)
+    assert_equal("test.foo.bar:5|d|@0.5|#shop_id:123", @sink.datagrams.first.source)
+  end
+
+  def test_sampled_distribution_block_uses_one_sampling_decision
+    sample_rate = 0.5
+    @sink.expects(:sample?).with(sample_rate).once.returns(true)
+    Process.stubs(:clock_gettime).with(Process::CLOCK_MONOTONIC, :float_millisecond).returns(100.0, 125.0)
+
+    metric = Class.new(StatsD::Instrument::CompiledMetric::Distribution) do
+      define(
+        name: "foo.bar",
+        sample_rate: sample_rate,
+      )
+    end
+
+    returned_value = metric.distribution { :result }
+
+    assert_equal(:result, returned_value)
+    assert_equal(1, @sink.datagrams.size)
+    assert_equal("test.foo.bar:25.0|d|@0.5", @sink.datagrams.first.source)
+  end
+
   def test_latency_as_value_when_block_provided
     metric = Class.new(StatsD::Instrument::CompiledMetric::Distribution) do
       define(
@@ -415,18 +452,17 @@ class CompiledMetricDistributionWithAggregationTest < Minitest::Test
   end
 
   def test_sample_rate_with_aggregation
-    # When aggregating with sample_rate, sampling happens before aggregation
-    # This test verifies that with a sample_rate >0, a subset of distributions are aggregated
+    sample_rate = 0.5
+    @sink.expects(:sample?).with(sample_rate).times(5).returns(false, true, false, false, true)
+
     metric = Class.new(StatsD::Instrument::CompiledMetric::Distribution) do
       define(
         name: "foo.bar",
         static_tags: { service: "web" },
-        sample_rate: 0.5,
+        sample_rate: sample_rate,
       )
     end
 
-    metric.stubs(:sample?).returns(false, true, false, false, true)
-
     metric.distribution(1)
     metric.distribution(2)
     metric.distribution(3)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.11.1
 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.9
+rubygems_version: 4.0.14
 specification_version: 4
 summary: A StatsD client for Ruby apps
 test_files: