opentelemetry-propagator-ottrace 0.19.2 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b42bdd108dcc74802f5129b21a756d6486032683609c39a25fc90ed02f7db1b
-  data.tar.gz: d9b91353856cd6dc03273964bb8c616ce1481a0fd5ca9ac3e97e828393ec40dc
+  metadata.gz: 7a060f65dc3023d234e5ac579656cdac5d342b0065304ab353755c63ee91d01f
+  data.tar.gz: 64bbd78fbb886ff8efe8ea05956f71fb50f16a1d3243c0592c378edcecd82964
 SHA512:
-  metadata.gz: 1b64964eddc665db4ccd5352c60b2a0bc060368a1b93381364e431d94fe5e68288713c996759abda22124ce13d99aee730086defa736c8cee8a9336e5a594977
-  data.tar.gz: b03132fe3a08a5a0e08674aa1213e8476d8f1c62f4edacb76f2d0c7e58af7ff71c275a14bb0441f03eac23152d875a0a587b0a3680240de854a65458f73a476f
+  metadata.gz: 0b2ea92bb675dbf1aad7668b63bf4cee0869df54eab39cf158ab4e15c9dc951d15293fbc3af82b288699798b11be0caef6538681d6ee0540d1ff6e1209bc44ab
+  data.tar.gz: f53cfa0001f2dd3f9cd48bc420e9330eea959c68ed1da1b79bcb44fa4e1b539f471f9d7da9010c6c9bbcd96b35adbe592a8c57525e3cb1251b7ab2fc0be37e8d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-propagator-ottrace
 
+### v0.19.3 / 2021-10-29
+
+* FIXED: Add Support fo OTTrace Bit Encoded Sampled Flags 
+
 ### v0.19.2 / 2021-09-29
 
 * (No significant changes)

data/README.md

@@ -9,9 +9,19 @@ The `opentelemetry-propagator-ottrace` gem contains injectors and extractors for
 | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
 | `ot-tracer-traceid` | uint64 encoded as a string of 16 hex characters                                                                                        | yes                   |
 | `ot-tracer-spanid`  | uint64 encoded as a string of 16 hex characters                                                                                        | yes                   |
-| `ot-tracer-sampled` | boolean encoded as a string with the values `'true'` or `'false'`                                                                      | no                    |
+| `ot-tracer-sampled` | boolean or bit encoded as a string with the values `'true'`,`'false'`, `'1'`, or `'0'`                                                 | no                    |
 | `ot-baggage-*`      | repeated string to string key-value baggage items; keys are prefixed with `ot-baggage-` and the corresponding value is the raw string. | if baggage is present |
 
+### Sampled Flag vs Bit
+
+The `ot-tracer-sampled` header is a `boolean` encoded string however the Golang SDK incorrectly sets the `ot-tracer-sampled` header to a `bit` flag.
+This and other language SDKs compensate for this by supporting both a `bit` and `boolean` encoded strings upon extraction:
+
+- [Java](https://github.com/open-telemetry/opentelemetry-java/blob/9cea4ef1f92d3186b1bd8296e9daac4281c0f759/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/Common.java#L41)
+- [Golang](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/b72c2cd63b9a9917554cbcd709e61f5d8541eea5/propagators/ot/ot_propagator.go#L118)
+
+This issue was [fixed](https://github.com/open-telemetry/opentelemetry-go-contrib/pull/1358) however this SDK supports both for backward compatibility with older versions of the Golang propagator.
+
 ### Interop and trace ids
 
 The OT trace propagation format expects trace ids to be 64-bits. In order to

data/lib/opentelemetry/propagator/ottrace/text_map_propagator.rb

@@ -56,7 +56,7 @@ module OpenTelemetry
           span_context = Trace::SpanContext.new(
             trace_id: Array(trace_id).pack('H*'),
             span_id: Array(span_id).pack('H*'),
-            trace_flags: sampled == 'true' ? Trace::TraceFlags::SAMPLED : Trace::TraceFlags::DEFAULT,
+            trace_flags: as_trace_flags(sampled),
             remote: true
           )
 
@@ -89,6 +89,15 @@ module OpenTelemetry
 
         private
 
+        def as_trace_flags(sampled)
+          case sampled
+          when 'true', '1'
+            Trace::TraceFlags::SAMPLED
+          else
+            Trace::TraceFlags::DEFAULT
+          end
+        end
+
         def valid?(trace_id:, span_id:)
           !(VALID_TRACE_ID_REGEX !~ trace_id || VALID_SPAN_ID_REGEX !~ span_id)
         end

data/lib/opentelemetry/propagator/ottrace/version.rb

@@ -15,7 +15,7 @@ module OpenTelemetry
   module Propagator
     # Namespace for OpenTelemetry OTTrace propagation
     module OTTrace
-      VERSION = '0.19.2'
+      VERSION = '0.19.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-ottrace
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.19.3
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -155,10 +155,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.19.2/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.19.3/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/propagator/ottrace
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.19.2
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.19.3
 post_install_message: 
 rdoc_options: []
 require_paths: