opentelemetry-sdk-experimental 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810bad2b227d4e0345bab51445002ccae0dde9cc7a8651d05fc5c44c1bd7df6c
-  data.tar.gz: 53dd2c762679bda44159ec4936ae8beb6052a536a618d52e793eb25f187b68fd
+  metadata.gz: 51a09141af347e88764533ef7ae7a072d1fe45935c61a04ffec0f92d535d90a7
+  data.tar.gz: 641bb04a0687ac7c67de416569270b394246f37bc9245435e53b954b93f0a4a4
 SHA512:
-  metadata.gz: b48e7906d4250ff6cc7f01d32152e1c85ac0627993cba7171debb16514ef8b6a6af79d186098629cb66dbbf9c5b901f05c007144e2f7dcdc06b7b4b6f71a0c39
-  data.tar.gz: 3a861705fa43bfd6150c6441c4e6487dd95857acf85f2d6a21dafd14b32e66ff18eb312d3aa1e13cde5f5b971359de304852f05d34e073e28b0a40824bae97b4
+  metadata.gz: b531cbb38ca9d102377250b501b4ed4309336bc49432c0f8fb8070795d9849406fcb93324563fed99e0e9e4fc0dce30f55d7abe65ac639f2ae7a0e0b128c37fb
+  data.tar.gz: f833b0e558897fe05ec52dbe79ecf0a73d45b4783ed46f992fc73f7b556a8fe56bb806964115a35b8bfc80fcfa4de7b6b95fc31ef142241f2a9c11c6766275ac

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-sdk-experimental
 
+### v0.2.0 / 2023-05-30
+
+* FIXED: Consistent probability sampler init 
+* BREAKING CHANGE: Consistently pass tracestate 
+* BREAKING CHANGE: Set r in Parent CPS 
+
+### v0.1.1 / 2023-03-06
+
+* FIXED: Reduce allocations in update_tracestate 
+* FIXED: Refactor consistent prob sampler for reuse 
+
 ### v0.1.0 / 2022-11-09
 
 * Initial release.

data/README.md

@@ -0,0 +1,8 @@
+# Experimental SDK
+
+The experimental SDK houses bleeding-edge(-ish) functionality that may have unstable APIs. Some examples of what's in
+here:
+
+* `traceresponse` propagator (in [w3c `trace-context` editor's draft](https://w3c.github.io/trace-context/))
+* Consistent Probability Sampler (marked as `experimental` in [opentelemetry-specification)](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md))
+

data/lib/opentelemetry/sdk/experimental/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module SDK
     module Experimental
       # Current OpenTelemetry experimental sdk version
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
     end
   end
 end

data/lib/opentelemetry/sdk/trace/samplers/consistent_probability_based.rb

@@ -25,7 +25,7 @@ module OpenTelemetry
             end
 
             @p_floor = (Math.frexp(probability)[1] - 1).abs
-            @p_ceil = @p_floor + 1
+            @p_ceil = @p_floor - 1
             floor = Math.ldexp(1.0, -@p_floor)
             ceil = Math.ldexp(1.0, -@p_ceil)
             @p_ceil_probability = (probability - floor) / (ceil - floor)
@@ -42,39 +42,22 @@ module OpenTelemetry
           def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
             parent_span_context = OpenTelemetry::Trace.current_span(parent_context).context
             p = probabilistic_p
-            if parent_span_context.valid?
-              tracestate = parent_span_context.tracestate
-              parse_ot_vendor_tag(tracestate) do |_, in_r, rest|
-                r = if in_r.nil? || in_r > 62
-                      OpenTelemetry.logger.debug("ConsistentProbabilitySampler: potentially inconsistent trace detected - r: #{in_r.inspect}")
-                      generate_r(trace_id)
-                    else
-                      in_r
-                    end
-                if p <= r
-                  Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: update_tracestate(tracestate, p, r, rest))
-                else
-                  Result.new(decision: Decision::DROP, tracestate: update_tracestate(tracestate, nil, r, rest))
-                end
+            tracestate = parent_span_context.tracestate
+            parse_ot_vendor_tag(tracestate) do |_, r, rest|
+              if r.nil? || r > 62
+                OpenTelemetry.logger.debug("ConsistentProbabilitySampler: potentially inconsistent trace detected - r: #{r.inspect}") if parent_span_context.valid?
+                r = generate_r(trace_id)
               end
-            else
-              r = generate_r(trace_id)
               if p <= r
-                Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: new_tracestate(p: p, r: r))
+                Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: update_tracestate(tracestate, p, r, rest))
               else
-                Result.new(decision: Decision::DROP, tracestate: new_tracestate(r: r))
+                Result.new(decision: Decision::DROP, tracestate: update_tracestate(tracestate, nil, r, rest))
               end
             end
           end
 
           private
 
-          def generate_r(trace_id)
-            x = trace_id[8, 8].unpack1('Q>') | 0x3
-            clz = 64 - x.bit_length
-            clz
-          end
-
           def probabilistic_p
             if Random.rand < @p_ceil_probability
               @p_ceil

data/lib/opentelemetry/sdk/trace/samplers/consistent_probability_tracestate.rb

@@ -17,6 +17,40 @@ module OpenTelemetry
           MAX_LIST_LENGTH = 256 # Defined by https://www.w3.org/TR/trace-context/
           private_constant(:DECIMAL, :MAX_LIST_LENGTH)
 
+          private
+
+          # sanitized_tracestate returns an OpenTelemetry Tracestate object with the
+          # tracestate sanitized according to the Context invariants defined in the
+          # tracestate probability sampling spec.
+          #
+          # If r is nil after the sanitization, it is generated from the trace_id.
+          #
+          # This method assumes the parent span context is valid.
+          #
+          # @param trace_id [OpenTelemetry::Trace::TraceId] the trace id
+          # @param span_context [OpenTelemetry::Trace::SpanContext] the parent span context
+          # @return [OpenTelemetry::Trace::Tracestate] the sanitized tracestate
+          def sanitized_tracestate(trace_id, span_context)
+            sampled = span_context.trace_flags.sampled?
+            tracestate = span_context.tracestate
+            parse_ot_vendor_tag(tracestate) do |p, r, rest|
+              if !r.nil? && r > 62
+                p = r = nil
+              elsif !p.nil? && p > 63
+                p = nil
+              elsif !p.nil? && !r.nil? && !invariant(p, r, sampled)
+                p = nil
+              elsif !r.nil?
+                return tracestate
+              end
+              if r.nil?
+                OpenTelemetry.logger.debug("ConsistentProbabilitySampler: potentially inconsistent trace detected - r: #{r.inspect}")
+                r = generate_r(trace_id)
+              end
+              update_tracestate(tracestate, p, r, rest)
+            end
+          end
+
           # parse_ot_vendor_tag parses the 'ot' vendor tag of the tracestate.
           # It yields the parsed probability fields and the remaining tracestate.
           # It returns the result of the block.
@@ -44,27 +78,22 @@ module OpenTelemetry
           end
 
           def update_tracestate(tracestate, p, r, rest) # rubocop:disable Naming/UncommunicativeMethodParamName
-            # This could be more efficient and allocate less, however it *should* only be used for root spans and sanitizing invalid tracestate
-            # in the most common configuration of parent_consistent_probability_based(root: consistent_probability_based(p)).
-            ps = "p:#{p}" unless p.nil?
-            rs = "r:#{r}" unless r.nil?
-            ot = [ps, rs, rest].compact.join(';')
-            if ot.empty?
+            if p.nil? && r.nil? && rest.nil?
               tracestate.delete('ot')
-            else
-              tracestate.set_value('ot', ot)
-            end
-          end
-
-          def new_tracestate(p: nil, r: nil) # rubocop:disable Naming/UncommunicativeMethodParamName
-            if p.nil? && r.nil?
-              OpenTelemetry::Trace::Tracestate.DEFAULT
+            elsif p.nil? && r.nil?
+              tracestate.set_value('ot', rest)
+            elsif p.nil? && rest.nil?
+              tracestate.set_value('ot', "r:#{r}")
+            elsif r.nil? && rest.nil?
+              tracestate.set_value('ot', "p:#{p}")
             elsif p.nil?
-              OpenTelemetry::Trace::Tracestate.from_hash('ot' => "r:#{r}")
+              tracestate.set_value('ot', "r:#{r};#{rest}")
             elsif r.nil?
-              OpenTelemetry::Trace::Tracestate.from_hash('ot' => "p:#{p}")
+              tracestate.set_value('ot', "p:#{p};#{rest}")
+            elsif rest.nil?
+              tracestate.set_value('ot', "p:#{p};r:#{r}")
             else
-              OpenTelemetry::Trace::Tracestate.from_hash('ot' => "p:#{p};r:#{r}")
+              tracestate.set_value('ot', "p:#{p};r:#{r};#{rest}")
             end
           end
 
@@ -75,6 +104,12 @@ module OpenTelemetry
           def decimal(str)
             str.to_i if !str.nil? && DECIMAL.match?(str)
           end
+
+          def generate_r(trace_id)
+            x = trace_id[8, 8].unpack1('Q>') | 0x3
+            clz = 64 - x.bit_length
+            clz
+          end
         end
       end
     end

data/lib/opentelemetry/sdk/trace/samplers/parent_consistent_probability_based.rb

@@ -43,7 +43,7 @@ module OpenTelemetry
             if !parent_span_context.valid?
               @root.should_sample?(trace_id: trace_id, parent_context: parent_context, links: links, name: name, kind: kind, attributes: attributes)
             else
-              tracestate = sanitized_tracestate(parent_span_context)
+              tracestate = sanitized_tracestate(trace_id, parent_span_context)
               if parent_span_context.trace_flags.sampled?
                 Result.new(decision: Decision::RECORD_AND_SAMPLE, tracestate: tracestate)
               else
@@ -55,31 +55,6 @@ module OpenTelemetry
           protected
 
           attr_reader :root
-
-          private
-
-          # sanitized_tracestate returns an OpenTelemetry Tracestate object with the
-          # tracestate sanitized according to the Context invariants defined in the
-          # tracestate probability sampling spec.
-          #
-          # @param span_context [OpenTelemetry::Trace::SpanContext] the parent span context
-          # @return [OpenTelemetry::Trace::Tracestate] the sanitized tracestate
-          def sanitized_tracestate(span_context)
-            sampled = span_context.trace_flags.sampled?
-            tracestate = span_context.tracestate
-            parse_ot_vendor_tag(tracestate) do |p, r, rest|
-              if !r.nil? && r > 62
-                p = r = nil
-              elsif !p.nil? && p > 63
-                p = nil
-              elsif !p.nil? && !r.nil? && !invariant(p, r, sampled)
-                p = nil
-              else
-                return tracestate
-              end
-              update_tracestate(tracestate, p, r, rest)
-            end
-          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk-experimental
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-09 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -188,6 +188,7 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-sdk-experimental.rb
 - lib/opentelemetry/sdk/experimental.rb
 - lib/opentelemetry/sdk/experimental/samplers_patch.rb
@@ -200,10 +201,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk-experimental/v0.1.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/api
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk-experimental/v0.2.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/sdk_experimental
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk-experimental/v0.1.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk-experimental/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: