opentelemetry-propagator-xray 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89391742d88b6bac32e0dc80d3765deb50e12d5d42baca5647acfb323f405a2b
-  data.tar.gz: 06a5bab1b6a8fa872319609f3d57766403c14f4f52c3b8d5bcb8248ea641560e
+  metadata.gz: ca3370fa3f9f9fa94ef28c282efd6d36a1699dff92113dac4b1eb6151ed028f5
+  data.tar.gz: 484eacc6800f0cfdacea45e12e1caaedffea4eb0f2a5d70ad983046e4a051ced
 SHA512:
-  metadata.gz: 4c340040a81ca5b8a78bde572a7ec9f131c01c96c734a7a2150d837ce0fa0f7a74b9a05debff03732886060ecadfde933246a5bf89edec425febc0b059a07b37
-  data.tar.gz: c34b0bf30ae46b686dcd753c0f686890aa13454d50ef224b29f112162e99756b52c01824f1119e4c85cc5bd6c75dca95182f9b902b890141913b7e3373d97fdb
+  metadata.gz: 6eec0d22dc44cbea2e243a9d29da5ac2f3899904b5d8ee2da2c3c64785869e342a0ee5a399c4ea5c17bbdf1aaa9695fad750eb9d771a4d16a1ff9b490d9d4966
+  data.tar.gz: 1cd3b9ca47adf31e87174d30d22f751dfab9ab89e729fc0e18caebbf4ffc305fb376005791d11fffa140c15eb9f56a4a58933cc9d080851db8c74ef2f2519377

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-propagator-xray
 
+### v0.20.0 / 2021-08-12
+
+* ADDED: Xray compliant ids 
+
 ### v0.19.0 / 2021-06-23
 
 * FIXED: XRay propagator null exception (#833)

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.rb

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

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/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Propagator
     module XRay
-      VERSION = '0.19.0'
+      VERSION = '0.20.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-xray
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-08-16 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.rc2
+        version: 1.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 - !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.19.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-xray/v0.20.0/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.19.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-xray/v0.20.0
 post_install_message: 
 rdoc_options: []
 require_paths: