opentelemetry-sdk-experimental 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be212866685d65872e43767ebdadebff97a0a31c46a19245de8c257b06bd3301
-  data.tar.gz: '08f676fb84c65d7f58b9c5e181fd8d4ae7f58d640741e0006cee18418ff8b11c'
+  metadata.gz: 51a09141af347e88764533ef7ae7a072d1fe45935c61a04ffec0f92d535d90a7
+  data.tar.gz: 641bb04a0687ac7c67de416569270b394246f37bc9245435e53b954b93f0a4a4
 SHA512:
-  metadata.gz: ef59d111a8416be5b53efd7d49a4645b2d90e6ca4da97b6ab40903df776d7bb76d0149b12e3bf1fb674e4b5e06469a2bfad14261b125200fe906837f827bf3b2
-  data.tar.gz: 4b39e784ed7f9f41af5de58ff35aab476b393646b015ba9aed90f0dca979c9f6ea037860973d430e1389b5d091bfee7709301336e97ccd598afae40cd3005c38
+  metadata.gz: b531cbb38ca9d102377250b501b4ed4309336bc49432c0f8fb8070795d9849406fcb93324563fed99e0e9e4fc0dce30f55d7abe65ac639f2ae7a0e0b128c37fb
+  data.tar.gz: f833b0e558897fe05ec52dbe79ecf0a73d45b4783ed46f992fc73f7b556a8fe56bb806964115a35b8bfc80fcfa4de7b6b95fc31ef142241f2a9c11c6766275ac

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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 

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.1'
+      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,27 +42,16 @@ 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

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

@@ -23,9 +23,14 @@ module OpenTelemetry
           # 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(span_context)
+          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|
@@ -35,9 +40,13 @@ module OpenTelemetry
                 p = nil
               elsif !p.nil? && !r.nil? && !invariant(p, r, sampled)
                 p = nil
-              else
+              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
@@ -88,18 +97,6 @@ module OpenTelemetry
             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?
-              OpenTelemetry::Trace::Tracestate.from_hash('ot' => "r:#{r}")
-            elsif r.nil?
-              OpenTelemetry::Trace::Tracestate.from_hash('ot' => "p:#{p}")
-            else
-              OpenTelemetry::Trace::Tracestate.from_hash('ot' => "p:#{p};r:#{r}")
-            end
-          end
-
           def invariant(p, r, sampled) # rubocop:disable Naming/UncommunicativeMethodParamName
             ((p <= r) == sampled) || (sampled && (p == 63))
           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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk-experimental
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 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.1/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.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk-experimental/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: