opentelemetry-propagator-ottrace 0.21.0 → 0.21.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14db3a0c0374ca4573529297d3ea1b3c2349882a82b7cc2e0464657aa4936579
-  data.tar.gz: afc84d4a0af4619a89ede478fc7609ffe549c871cbbf6106c64c8e683e092f4d
+  metadata.gz: edf917794b9e372bdf9d8bf6a8aee00b67c98d31a918c8d1f478304fc6856e42
+  data.tar.gz: e5868bbbd7e2b0d5c0cbe68e56fbf259f68522d95358063a1683084e8174dbbb
 SHA512:
-  metadata.gz: 2c3e85840f70d7d139e73e46461bd637c7c41e4e5173db6dc5ee723001fea80c876f9352e5346e1b6627a32726a0a3f936882503a78a9a54c1e4cb801495ab4a
-  data.tar.gz: 93bd9785ab9c156f9b702c8aa15fce0f9dd86560657421939687657c18eebb0194e0aa979db6a6549ead2b6153cb7e90c4aca29d91a1389b08cec008698e3eec
+  metadata.gz: f0a211a209a385f58fe114af5bb203130993e6a0ee25d9d887137b9c78ce76b1d7417e587a88673eb2a449eb98e197e95375127f61d7ef5a0a418ccdd5a990e4
+  data.tar.gz: 68b90c1cbd008c8b839f7a3920390435afce32114416882f08250b2450c386347afb4f54968de1be15ae4dfc78e23ffdbbd063ef727ac9c5d16aa114bc1b4b76

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-propagator-ottrace
 
+### v0.21.2 / 2023-11-23
+
+* CHANGED: Applied Rubocop Performance Recommendations [#727](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/727)
+
+### v0.21.1 / 2023-07-19
+
+* DOCS: Add some clarity to ottrace docs [#522](https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/522)
+
 ### v0.21.0 / 2023-04-17
 
 * BREAKING CHANGE: Drop support for EoL Ruby 2.7

data/README.md

@@ -7,8 +7,8 @@ The `opentelemetry-propagator-ottrace` gem contains injectors and extractors for
 
 | Header Name         | Description                                                                                                                            | Required              |
 | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| `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-traceid` | 64-bit; 16 hex digits (extract and inject) or 128-bit; 32 hex digits (extract)                                             | yes                   |
+| `ot-tracer-spanid`  | 64-bit; 16 hex digits                                                                                    | yes                   |
 | `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 |
 
@@ -24,11 +24,15 @@ This issue was [fixed](https://github.com/open-telemetry/opentelemetry-go-contri
 
 ### Interop and trace ids
 
-The OT trace propagation format expects trace ids to be 64-bits. In order to
-interop with OpenTelemetry, trace ids need to be truncated to 64-bits before
-sending them on the wire. When truncating, the least significant (right-most)
-bits MUST be retained. For example, a trace id of
-`3c3039f4d78d5c02ee8e3e41b17ce105` would be truncated to `ee8e3e41b17ce105`.
+OTTrace was changed to be interoperable with other format so it is supposed to 8 or 16 byte array values for the trace-id.
+
+In order to do that Lightstep released a version of the OTTrace propagators in OpenTracing SDKs that left padded 64-bit headers to 128-bits using an additional 64-bit of 0s.
+
+The reality of the world is not every application upgraded to support 16 byte array propagation format, but this propagator must still convert legacy 64-bit trace ids to match the W3C Trace Context Trace ID 16 byte array.
+
+In addition to that it must be interoperable with legacy OTTracers, which expect 64-bit headers so this propagator truncates the value from a 128-bit to a 64-bit value before inject it into the carrier.
+
+This propagator is compatible with 64-bit or 128-bit trace ids when extracting the parent context, however it truncates the trace ids down to 64-bit trace ids when injecting the context.
 
 ### Baggage Notes
 

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

@@ -116,10 +116,10 @@ module OpenTelemetry
             getter.keys(carrier).each do |carrier_key|
               baggage_key = carrier_key.start_with?(prefix) && carrier_key[prefix.length..-1]
               next unless baggage_key
-              next unless VALID_BAGGAGE_HEADER_NAME_CHARS =~ baggage_key
+              next unless VALID_BAGGAGE_HEADER_NAME_CHARS.match?(baggage_key)
 
               value = getter.get(carrier, carrier_key)
-              next unless INVALID_BAGGAGE_HEADER_VALUE_CHARS !~ value
+              next if INVALID_BAGGAGE_HEADER_VALUE_CHARS.match?(value)
 
               builder.set_value(baggage_key, value)
             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.21.0'
+      VERSION = '0.21.2'
     end
   end
 end

data/lib/opentelemetry-propagator-ottrace.rb

@@ -5,4 +5,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry-api'
-require_relative './opentelemetry/propagator/ottrace'
+require_relative 'opentelemetry/propagator/ottrace'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-ottrace
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.2
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -72,56 +72,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.49.0
+        version: 1.57.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.49.0
+        version: 1.57.1
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 1.19.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 1.19.1
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: yard-doctest
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: '0.9'
 description: OTTrace Context Propagation Extension for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -141,10 +141,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-propagator-ottrace/0.21.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-propagator-ottrace/0.21.2/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/propagator/ottrace
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-propagator-ottrace/0.21.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-propagator-ottrace/0.21.2
 post_install_message: 
 rdoc_options: []
 require_paths: