opentelemetry-propagator-xray 0.17.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f94f1a102905889f239f763f86dfde4add7bfc4d87e40993f529f225591dc5c
-  data.tar.gz: 86c5467ebfc5502df6adf1438bcfe6029d93d5f445d5086f994973407824489f
+  metadata.gz: 820948011b975ff27b97020f49a8aee8c09bc00e087969fe2d94d7f80b2ff02c
+  data.tar.gz: 28bf9e806c7116b594c55d5233780e40f5529aeb7ecc43f0b91804c6c112c730
 SHA512:
-  metadata.gz: a7383440a2611e6b5b525f16faf9076786bdeccbfc084109576a342420f8994fa580faf35e72a0df34cd034720f88c26a3340a017d7b10b27f891419f281a339
-  data.tar.gz: aaa8f97d5ed3434e616f44db8284e997ed7a9532910cb5e43e9896256d16fcc4c496f5241e6274dfd7300d9d1e202392ecb105b538dcfda20eff17043abb80ad
+  metadata.gz: da09932b027d616e3be9635b64f6a3ea099d6c67dc5962defbf244ebeb42594eceff68155f5db8176dea5a19d2462f5a7659ec2fae5942c7418b13794b6ef639
+  data.tar.gz: e4af70f7729a8ee66e9d2c1db9ea3d970ad3b2a1f0d3b88e58f80a278428dcd3bd5b8aa78074b001b8c073b82163c6686eceac8a1ea65990133d4c9189562986

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Release History: opentelemetry-propagator-xray
 
+### v0.20.1 / 2021-09-29
+
+* (No significant changes)
+
+### v0.20.0 / 2021-08-12
+
+* ADDED: Xray compliant ids 
+
+### v0.19.0 / 2021-06-23
+
+* FIXED: XRay propagator null exception (#833)
+* ADDED: Add Tracer.non_recording_span to API 
+
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* FIXED: XRay trace_id parsing length
+
 ### v0.17.0 / 2021-04-22
 
 * Initial release.

data/README.md

@@ -23,6 +23,23 @@ gem install opentelemetry-propagator-xray
 
 Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-xray` in your `Gemfile`.
 
+In your application:
+```
+require 'opentelemetry/propagator/xray'
+# Optional
+ENV['OTEL_PROPAGATORS'] ||= 'xray' # Or you can set this as an environment variable outside of the application
+```
+
+## To generate AWS XRay compliant IDs use the 'OpenTelemetry::AWSXRayTrace' module:
+```
+require 'opentelemetry/propagator/xray'
+
+OpenTelemetry::SDK.configure do |c|
+  c.id_generator = OpenTelemetry::Propagator::XRay::IDGenerator
+end
+```
+The propagator and ID generation are independent and do not need to be used in conjunction but can be.
+
 ## How can I get involved?
 
 The `opentelemetry-propagator-xray` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.

data/lib/opentelemetry/propagator/xray/id_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Propagator
+    module XRay
+      # This module is intended to only be used as an override for how to generate IDs to be compliant with XRay
+      module IDGenerator
+        extend self
+
+        # Generates a valid trace identifier, a 16-byte string with at least one
+        # non-zero byte.
+        # AWS Docs: https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html
+        # hi - 4 bytes timestamp, 4 bytes random (Mid)
+        # low - 8 bytes random.
+        # Since we include timestamp, impossible to be invalid.
+        # @return [bytes] a valid trace ID that is compliant with AWS XRay.
+        def generate_trace_id
+          time_hi = generate_time_bytes
+          mid_and_low = RANDOM.bytes(12)
+          time_hi << mid_and_low
+        end
+
+        # Generates a valid span identifier, an 8-byte string with at least one
+        # non-zero byte.
+        #
+        # @return [bytes] a valid span ID.
+        def generate_span_id
+          OpenTelemetry::Trace.generate_span_id
+        end
+
+        private
+
+        # Random number generator for generating IDs. This is an object that can
+        # respond to `#bytes` and uses the system PRNG. The current logic is
+        # compatible with Ruby 2.5 (which does not implement the `Random.bytes`
+        # class method) and with Ruby 3.0+ (which deprecates `Random::DEFAULT`).
+        # When we drop support for Ruby 2.5, this can simply be replaced with
+        # the class `Random`.
+        #
+        # @return [#bytes]
+        RANDOM = Random.respond_to?(:bytes) ? Random : Random::DEFAULT
+
+        # Seconds since epoch converted to 4 bytes in big-endian order.
+        def generate_time_bytes
+          [Time.now.to_i].pack('N')
+        end
+      end
+    end
+  end
+end

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

@@ -38,6 +38,8 @@ module OpenTelemetry
         #   if extraction fails
         def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
           header = getter.get(carrier, XRAY_CONTEXT_KEY)
+          return context unless header
+
           match = parse_header(header)
           return context unless match
 
@@ -49,7 +51,7 @@ module OpenTelemetry
             remote: true
           )
 
-          span = Trace::Span.new(span_context: span_context)
+          span = OpenTelemetry::Trace.non_recording_span(span_context)
           context = XRay.context_with_debug(context) if match['sampling_state'] == 'd'
           Trace.context_with_span(span, parent_context: context)
         rescue OpenTelemetry::Error
@@ -76,7 +78,7 @@ module OpenTelemetry
                            end
 
           ot_trace_id = span_context.hex_trace_id
-          xray_trace_id = "1-#{ot_trace_id[0..6]}-#{ot_trace_id[7..ot_trace_id.length]}"
+          xray_trace_id = "1-#{ot_trace_id[0..7]}-#{ot_trace_id[8..ot_trace_id.length]}"
           parent_id = span_context.hex_span_id
 
           xray_value = "Root=#{xray_trace_id};Parent=#{parent_id};Sampled=#{sampling_state}"
@@ -98,7 +100,7 @@ module OpenTelemetry
         # Convert an id from a hex encoded string to byte array. Assumes the input id has already been
         # validated to be 35 characters in length.
         def to_trace_id(hex_id)
-          Array(hex_id[2..8] + hex_id[10..hex_id.length]).pack('H*')
+          Array(hex_id[2..9] + hex_id[11..hex_id.length]).pack('H*')
         end
 
         # Convert an id from a hex encoded string to byte array.

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Propagator
     module XRay
-      VERSION = '0.17.0'
+      VERSION = '0.20.1'
     end
   end
 end

data/lib/opentelemetry/propagator/xray.rb

@@ -46,3 +46,4 @@ module OpenTelemetry
 end
 
 require_relative './xray/version'
+require_relative './xray/id_generator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-xray
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.20.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -135,16 +135,17 @@ files:
 - README.md
 - lib/opentelemetry-propagator-xray.rb
 - lib/opentelemetry/propagator/xray.rb
+- lib/opentelemetry/propagator/xray/id_generator.rb
 - lib/opentelemetry/propagator/xray/text_map_propagator.rb
 - lib/opentelemetry/propagator/xray/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-xray/v0.17.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-xray/v0.20.1/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/propagator/xray
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-xray/v0.17.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-xray/v0.20.1
 post_install_message: 
 rdoc_options: []
 require_paths: