opentelemetry-propagator-ottrace 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b5cf12e061f413b78abecc045bdca50df6da9290f0a8e3122b75294f06844d8
-  data.tar.gz: d932aab774e78dfc9a3b41952f10b074a7a3a11add0f31d5b17bbdb0690fe99f
+  metadata.gz: cb24c007cb6bf25c86c659217edc17329ec2aaeb4fa034b3211ee6de3444918f
+  data.tar.gz: 58c33687234c495ecdbca0024e7fecd11fb1093e69a361a6a56ba5bb9a6f25d7
 SHA512:
-  metadata.gz: 93bd9f07eae87a8815d6d9fee2c28bc31099f3699c26740f62f81ff3b6e2330a293242749b6dbb5afd17bd55f74a4c414050917fcfd6ee8f568c708d99abc4b3
-  data.tar.gz: 26db4c6a5a39cb81a872aa6ccfecc5736e59f71cd84a41d6805bb1a59dbc938e75d066254c98f4319fbf09a74d51bbdd3534c7d66e009bee79a83fa21a9e3d32
+  metadata.gz: 4132c33a8d43467034404e3427eaa108da849068d448112c42d1afa273eb67d213fba03af692289de2b0ba573ae75d1ff9a6c349a72f18fdb23d7528f4ce1dce
+  data.tar.gz: 95cc971d986ee60ca487f21d9ae0a5b2270997658a94068599574c82720ce5219cb12a440d2e3905a29613ed34f9059ffb95cbe5bd3b30e6e6a1fc9935b9f226

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History: opentelemetry-propagator-ottrace
 
+### v0.20.0 / 2022-06-09
+
+* (No significant changes)
+
+### v0.19.3 / 2021-10-29
+
+* FIXED: Add Support fo OTTrace Bit Encoded Sampled Flags 
+
+### v0.19.2 / 2021-09-29
+
+* (No significant changes)
+
 ### v0.19.1 / 2021-08-12
 
 * (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.1'
+      VERSION = '0.20.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-ottrace
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-sdk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -155,10 +141,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.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.20.0/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.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-ottrace/v0.20.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -167,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="