Rename Sampler#should_sample -> Sampler#decision

Author: mwear

api/lib/opentelemetry/trace/samplers/always_sample_sampler.rb

@@ -26,12 +26,12 @@ class AlwaysSampleSampler < Sampler
         # @param [Enumerable<Link>] links A collection of links to be associated
         #   with the {Span} to be created. Can be nil.
         # @return [Decision] The sampling decision
-        def should_sample(span_context: nil,
-                          extracted_context: nil,
-                          trace_id:,
-                          span_id:,
-                          span_name:,
-                          links: nil)
+        def decision(span_context: nil,
+                     extracted_context: nil,
+                     trace_id:,
+                     span_id:,
+                     span_name:,
+                     links: nil)
           super
           ALWAYS_SAMPLE_DECISION
         end

api/lib/opentelemetry/trace/samplers/never_sample_sampler.rb

@@ -26,12 +26,12 @@ class NeverSampleSampler < Sampler
         # @param [Enumerable<Link>] links A collection of links to be associated
         #   with the {Span} to be created. Can be nil.
         # @return [Decision] The sampling decision
-        def should_sample(span_context: nil,
-                          extracted_context: nil,
-                          trace_id:,
-                          span_id:,
-                          span_name:,
-                          links: nil)
+        def decision(span_context: nil,
+                     extracted_context: nil,
+                     trace_id:,
+                     span_id:,
+                     span_name:,
+                     links: nil)
           super
           NEVER_SAMPLE_DECISION
         end

api/lib/opentelemetry/trace/samplers/sampler.rb

@@ -24,12 +24,12 @@ class Sampler
         # @return [Decision] The sampling decision
 
         # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        def should_sample(span_context: nil,
-                          extracted_context: nil,
-                          trace_id:,
-                          span_id:,
-                          span_name:,
-                          links: nil)
+        def decision(span_context: nil,
+                     extracted_context: nil,
+                     trace_id:,
+                     span_id:,
+                     span_name:,
+                     links: nil)
           raise ArgumentError, "expected span_context to be a SpanContext, not #{span_context.class}" if span_context && !span_context.is_a?(SpanContext)
           raise ArgumentError, "expected extracted_context to be a Boolean, not #{extracted_context.class}" if !extracted_context.nil? && !Internal.boolean?(extracted_context)
           raise ArgumentError, "expected trace_id to be an Integer, not #{trace_id.class}" unless trace_id.is_a?(Integer)

api/test/opentelemetry/trace/samplers/always_sample_sampler_test.rb

@@ -13,9 +13,9 @@
       sampler.description.must_equal('AlwaysSampleSampler')
     end
   end
-  describe '.should_sample' do
+  describe '.decision' do
     it 'returns a true decision' do
-      decision = sampler.should_sample(
+      decision = sampler.decision(
         span_context: nil,
         extracted_context: nil,
         trace_id: 344,

api/test/opentelemetry/trace/samplers/never_sample_sampler_test.rb

@@ -13,9 +13,9 @@
       sampler.description.must_equal('NeverSampleSampler')
     end
   end
-  describe '.should_sample' do
+  describe '.decision' do
     it 'returns a false decision' do
-      decision = sampler.should_sample(
+      decision = sampler.decision(
         span_context: nil,
         extracted_context: nil,
         trace_id: 344,

api/test/opentelemetry/trace/samplers/sampler_test.rb

@@ -10,12 +10,12 @@
   class BasicSampler < OpenTelemetry::Trace::Samplers::Sampler
     DECISION = OpenTelemetry::Trace::Samplers::Decision.new(decision: true)
     # rubocop:disable Metrics/ParameterLists
-    def should_sample(span_context: nil,
-                      extracted_context: nil,
-                      trace_id:,
-                      span_id:,
-                      span_name:,
-                      links: nil)
+    def decision(span_context: nil,
+                 extracted_context: nil,
+                 trace_id:,
+                 span_id:,
+                 span_name:,
+                 links: nil)
       super
       DECISION
     end
@@ -27,9 +27,9 @@ def description
   end
 
   let(:sampler) { BasicSampler.new }
-  describe '.should_sample' do
+  describe '.decision' do
     it 'returns a decision with required arguments' do
-      decision = sampler.should_sample(
+      decision = sampler.decision(
         span_context: nil,
         extracted_context: nil,
         trace_id: 344,
@@ -42,7 +42,7 @@ def description
 
     it 'checks span_context for type' do
       proc do
-        sampler.should_sample(
+        sampler.decision(
           span_context: Object.new,
           extracted_context: nil,
           trace_id: 344,
@@ -55,7 +55,7 @@ def description
 
     it 'checks extracted_context for type' do
       proc do
-        sampler.should_sample(
+        sampler.decision(
           span_context: nil,
           extracted_context: Object.new,
           trace_id: 344,
@@ -68,7 +68,7 @@ def description
 
     it 'checks trace_id for type' do
       proc do
-        sampler.should_sample(
+        sampler.decision(
           span_context: nil,
           extracted_context: nil,
           trace_id: Object.new,
@@ -81,7 +81,7 @@ def description
 
     it 'checks span_id for type' do
       proc do
-        sampler.should_sample(
+        sampler.decision(
           span_context: nil,
           extracted_context: nil,
           trace_id: 344,
@@ -94,7 +94,7 @@ def description
 
     it 'checks span_name for type' do
       proc do
-        sampler.should_sample(
+        sampler.decision(
           span_context: nil,
           extracted_context: nil,
           trace_id: 344,
@@ -107,7 +107,7 @@ def description
 
     it 'checks that links are enumerable' do
       proc do
-        sampler.should_sample(
+        sampler.decision(
           span_context: nil,
           extracted_context: nil,
           trace_id: 344,