Add Transaction#set_measurement

Author: st0012

sentry-ruby/lib/sentry/transaction.rb

@@ -22,6 +22,10 @@ class Transaction < Span
     # @return [String]
     attr_reader :parent_sampled
 
+    # The measurements added to the transaction.
+    # @return [Hash]
+    attr_reader :measurements
+
     # @deprecated Use Sentry.get_current_hub instead.
     attr_reader :hub
 
@@ -40,9 +44,11 @@ def initialize(name: nil, parent_sampled: nil, hub:, **options)
       @hub = hub
       @configuration = hub.configuration # to be removed
       @tracing_enabled = hub.configuration.tracing_enabled?
+      @custom_measurements_enabled = hub.configuration.experiments.custom_measurements
       @traces_sampler = hub.configuration.traces_sampler
       @traces_sample_rate = hub.configuration.traces_sample_rate
       @logger = hub.configuration.logger
+      @measurements = {}
       init_span_recorder
     end
 
@@ -94,6 +100,20 @@ def deep_dup
       copy
     end
 
+    # Sets a custom measurement on the transaction.
+    # @param name [String] name of the measurement
+    # @param value [Float] value of the measurement
+    # @param unit [String] unit of the measurement
+    # @return [void]
+    def set_measurement(name, value, unit = "")
+      unless @custom_measurements_enabled
+        log_debug("[Tracing] Experimental custom_measurements feature is disabled")
+        return
+      end
+
+      @measurements[name] = { value: value, unit: unit }
+    end
+
     # Sets initial sampling decision of the transaction.
     # @param sampling_context [Hash] a context Hash that'll be passed to `traces_sampler` (if provided).
     # @return [void]

sentry-ruby/spec/sentry/transaction_spec.rb

@@ -121,6 +121,50 @@
     end
   end
 
+  describe "#set_measurement" do
+    context "when config.experiments.custom_measurements = false" do
+      let(:string_io) { StringIO.new }
+
+      before { Sentry.configuration.logger = Logger.new(string_io) }
+
+      it "logs the warning message" do
+        subject.set_measurement("metric.foo", 0.1, "second")
+
+        expect(string_io.string).to include("[Tracing] Experimental custom_measurements feature is disabled")
+      end
+    end
+
+    context "when config.experiments.custom_measurements = true" do
+      before do
+        Sentry.configuration.experiments.custom_measurements = true
+      end
+
+      it "sets the measurement" do
+        subject.set_measurement("metric.foo", 0.1, "second")
+        subject.set_measurement("metric.bar", 1.0, "minute")
+        subject.set_measurement("metric.baz", 1.0)
+
+        expect(subject.measurements).to eq(
+          {
+            "metric.foo" => { value: 0.1, unit: "second" },
+            "metric.bar" => { value: 1.0, unit: "minute" },
+            "metric.baz" => { value: 1.0, unit: "" },
+          }
+        )
+
+        subject.set_measurement("metric.foo", 2, "second")
+
+        expect(subject.measurements).to eq(
+          {
+            "metric.foo" => { value: 2, unit: "second" },
+            "metric.bar" => { value: 1.0, unit: "minute" },
+            "metric.baz" => { value: 1.0, unit: "" },
+          }
+        )
+      end
+    end
+  end
+
   describe "#start_child" do
     it "initializes a new child Span and assigns the 'transaction' attribute with itself" do
       # create subject span and wait for a sec for making time difference