opentelemetry-propagator-xray 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ddf5e0d066596c97e5ed75fc26c2ee73c4974037df178916a096e0d56843a9b
-  data.tar.gz: c5d5757de162480fd8f297addbe4a8d7213fabc77e42061f5d8182648d627a0e
+  metadata.gz: 9e1da8daf17d8e2ce3fa9d56afe8dae170e46859b932a034c8cf9ae461e5c191
+  data.tar.gz: '058cb3d7119ee981fe8fd35329ae85bde2bf0ef4359d71ff9279fa390d416b0f'
 SHA512:
-  metadata.gz: 22c6672ef9862c86f1c3e230cadd5fa6841880ed1024f0bd4e88edd3eab7945922bce83f71c8fbc195a3014616318e208868f9eab916a4edb3bd9c99d58cad99
-  data.tar.gz: b6b93a9d29ad1bd7b13884f8bcbcc9aaa5075c8f778daac4ca9816856e6374ad8a64f4f2310d14b8013430f46f30f134088745af898ae3659e634c7e7e880ec0
+  metadata.gz: 2121e1ed83bc4a2a29f4d6561bd50d0fb93d6dee36064cebf4aca1d568bddd24fd0133efb4fce6f769bc1aa1f2da2741df6945d95268ba4b8c0f67ba0ba82073
+  data.tar.gz: bec923bfba589a13089d2e701e7a7819b7e85ebee9b791d28d37974ba49800668960827b281f27db77a5ceba1ad4cf490cf3483efd9939c7f750f33e357b64f4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-propagator-xray
 
+### v0.24.0 / 2025-05-06
+
+* ADDED: Contribute xray lambda propagator
+
 ### v0.23.0 / 2025-01-16
 
 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Copyright OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
+module OpenTelemetry
+  # Namespace for OpenTelemetry propagator extension libraries
+  module Propagator
+    # Namespace for OpenTelemetry XRay propagation
+    module XRay
+      # Implementation of AWS X-Ray Trace Header propagation with special handling for
+      # Lambda's _X_AMZN_TRACE_ID environment variable
+      class LambdaTextMapPropagator < TextMapPropagator
+        AWS_TRACE_HEADER_ENV_KEY = '_X_AMZN_TRACE_ID'
+
+        # Extract trace context from the supplied carrier or from Lambda environment variable
+        # If extraction fails, the original context will be returned
+        #
+        # @param [Carrier] carrier The carrier to get the header from
+        # @param [optional Context] context Context to be updated with the trace context
+        #   extracted from the carrier. Defaults to +Context.current+.
+        # @param [optional Getter] getter If the optional getter is provided, it
+        #   will be used to read the header from the carrier, otherwise the default
+        #   text map getter will be used.
+        #
+        # @return [Context] context updated with extracted baggage, or the original context
+        #   if extraction fails
+        def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter)
+          # Check if the original input context already has a valid span
+          span_context = Trace.current_span(context).context
+          # If original context is valid, just return it - do not extract from carrier
+          return context if span_context.valid?
+
+          # First try to extract from the carrier using the standard X-Ray propagator
+          xray_context = super
+
+          # Check if we successfully extracted a context from the carrier
+          span_context = Trace.current_span(xray_context).context
+          return xray_context if span_context.valid?
+
+          # If not, check for the Lambda environment variable
+          trace_header = ENV.fetch(AWS_TRACE_HEADER_ENV_KEY, nil)
+          return xray_context unless trace_header
+
+          # Create a carrier with the trace header and extract from it
+          env_carrier = { XRAY_CONTEXT_KEY => trace_header }
+          super(env_carrier, context: xray_context, getter: getter)
+        rescue OpenTelemetry::Error
+          context
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Propagator
     module XRay
-      VERSION = '0.23.0'
+      VERSION = '0.24.0'
     end
   end
 end

data/lib/opentelemetry/propagator/xray.rb

@@ -12,6 +12,7 @@
 # See the documentation for the `opentelemetry-api` gem for details.
 
 require_relative 'xray/text_map_propagator'
+require_relative 'xray/lambda_text_map_propagator'
 
 module OpenTelemetry
   # Namespace for OpenTelemetry propagator extension libraries
@@ -22,7 +23,8 @@ module OpenTelemetry
 
       DEBUG_CONTEXT_KEY = Context.create_key('xray-debug-key')
       TEXT_MAP_PROPAGATOR = TextMapPropagator.new
-      private_constant :DEBUG_CONTEXT_KEY, :TEXT_MAP_PROPAGATOR
+      LAMBDA_TEXT_MAP_PROPAGATOR = LambdaTextMapPropagator.new
+      private_constant :DEBUG_CONTEXT_KEY, :TEXT_MAP_PROPAGATOR, :LAMBDA_TEXT_MAP_PROPAGATOR
 
       # @api private
       # Returns a new context with the xray debug flag enabled
@@ -41,6 +43,12 @@ module OpenTelemetry
       def text_map_propagator
         TEXT_MAP_PROPAGATOR
       end
+
+      # Returns a text map propagator that propagates context in the XRay
+      # format with special handling for Lambda environment.
+      def lambda_text_map_propagator
+        LAMBDA_TEXT_MAP_PROPAGATOR
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-propagator-xray
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -24,104 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.69.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.69.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: XRay Context Propagation Extension for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -136,16 +38,17 @@ files:
 - lib/opentelemetry-propagator-xray.rb
 - lib/opentelemetry/propagator/xray.rb
 - lib/opentelemetry/propagator/xray/id_generator.rb
+- lib/opentelemetry/propagator/xray/lambda_text_map_propagator.rb
 - lib/opentelemetry/propagator/xray/text_map_propagator.rb
 - lib/opentelemetry/propagator/xray/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-propagator-xray/0.23.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-propagator-xray/0.24.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/propagator/xray
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-propagator-xray/0.23.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-propagator-xray/0.24.0
 post_install_message: ''
 rdoc_options: []
 require_paths: