traces 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38ed43ffa64552bd34d59a35b041cf9e21645a00fdad969358aad2b368b669ce
-  data.tar.gz: 0120a1379df5a3722e1ff6ba364c1686e77790e707289ab2f494fa02eb1dd03c
+  metadata.gz: b0ef616a2189f63b63abe00e1dc84c0d13b48dc0099c90b4c5aa5ea420ea92fa
+  data.tar.gz: 310a045915e9831698ca681c61d53a6175a00a9b34e44e4d9b92ff8b6917dc51
 SHA512:
-  metadata.gz: 32e7836b442a5c2740799059a631929f29ea7345ebd86d9a7f567361263b4254d05e9bd97b2fa87fb1ab9e70f558fce5a5f78f510983c8876195d79e9f464298
-  data.tar.gz: 27e0c6d69a3a739985cf4e82f4f0b4f3c23a4c5b754c5bf9d7844bb4cc616229590202f9ad20a93e8eab37707a384961b5b556a9acbd989c5ce09fc1c00d7d19
+  metadata.gz: 3d5ab804b31b9440fd4cc36af5dfb9bd553d370681417f6441e86bcaeed6a41e7b02eff4f771144fac8f3fa528930bb457a7b60b902c2fe40b26e26ea901eb1e
+  data.tar.gz: 35918ff43dfac6158cb42dea57942a491b58ed906d67a5de03bd0bfffaa3cbda7e4ade3edd2e3c0ce1774a2c9e8caede58c8cb97b5bcf5c2cd5a1d921dc4d7d9

data/lib/traces/backend/test.rb

@@ -85,8 +85,7 @@ module Traces
 				
 				# @returns [Boolean] Whether there is an active trace.
 				def active?
-					# For the sake of testing, we always enable tracing.
-					true
+					!!Fiber.current.traces_backend_context
 				end
 			end
 		end

data/lib/traces/backend.rb

@@ -4,23 +4,104 @@
 # Copyright, 2021-2025, by Samuel Williams.
 
 require_relative "config"
+require_relative "context"
 
 module Traces
 	# The backend implementation is responsible for recording and reporting traces.
 	module Backend
 	end
 	
+	# Capture the current trace context for remote propagation.
+	#
 	# This is a default implementation, which can be replaced by the backend.
+	#
+	# You should prefer to use the new `Traces.current_context` family of methods.
+	#
 	# @returns [Object] The current trace context.
 	def self.trace_context
 		nil
 	end
 	
+	# Whether there is an active trace context.
+	#
 	# This is a default implementation, which can be replaced by the backend.
+	#
 	# @returns [Boolean] Whether there is an active trace.
 	def self.active?
 		!!self.trace_context
 	end
 	
+	# Capture the current trace context for local propagation between execution contexts.
+	#
+	# This method returns the current trace context that can be safely passed between threads, fibers, or other execution contexts within the same process.
+	#
+	# The returned object is opaque, in other words, you should not make assumptions about its structure.
+	#
+	# This is a default implementation, which can be replaced by the backend.
+	#
+	# @returns [Context | Nil] The current trace context, or nil if no active trace.
+	def self.current_context
+		trace_context
+	end
+	
+	# Execute a block within a specific trace context for local execution.
+	#
+	# This method is designed for propagating trace context between execution contexts within the same process (threads, fibers, etc.). It temporarily switches to the specified trace context for the duration of the block execution, then restores the previous context.
+	#
+	# When called without a block, permanently switches to the specified context. This enables manual context management for scenarios where automatic restoration isn't desired.
+	#
+	# This is a default implementation, which can be replaced by the backend.
+	#
+	# @parameter context [Context] A trace context obtained from `Traces.current_context`.
+	# @yields {...} If a block is given, the block is executed within the specified trace context.
+	def self.with_context(context)
+		if block_given?
+			# This implementation is not ideal but the best we can do with the current interface.
+			previous_context = self.trace_context
+			begin
+				self.trace_context = context
+				yield
+			ensure
+				self.trace_context = previous_context
+			end
+		else
+			self.trace_context = context
+		end
+	end
+	
+	# Inject trace context into a headers hash for distributed propagation.
+	#
+	# This method adds W3C Trace Context headers (traceparent, tracestate) and W3C Baggage headers to the provided headers hash, enabling distributed tracing across service boundaries. The headers hash is mutated in place.
+	#
+	# This is a default implementation, which can be replaced by the backend.
+	#
+	# @parameter headers [Hash] The headers object to mutate with trace context headers.
+	# @parameter context [Context] A trace context, or nil to use current context.
+	# @returns [Hash | Nil] The headers hash, or nil if no context is available.
+	def self.inject(headers = nil, context = nil)
+		context ||= self.trace_context
+		
+		if context
+			headers ||= Hash.new
+			context.inject(headers)
+		else
+			headers = nil
+		end
+		
+		return headers
+	end
+	
+	# Extract trace context from headers for distributed propagation.
+	#
+	# The returned object is opaque, in other words, you should not make assumptions about its structure.
+	#
+	# This is a default implementation, which can be replaced by the backend.
+	#
+	# @parameter headers [Hash] The headers object containing trace context.
+	# @returns [Context, nil] The extracted trace context, or nil if no valid context found.
+	def self.extract(headers)
+		Context.extract(headers)
+	end
+	
 	Config::DEFAULT.require_backend
 end

data/lib/traces/config.rb

@@ -35,12 +35,12 @@ module Traces
 		def require_backend(env = ENV)
 			if backend = env["TRACES_BACKEND"]
 				begin
-					if require(backend)
-						# We ensure that the interface methods replace any existing methods by prepending the module:
-						Traces.singleton_class.prepend(Backend::Interface)
-						
-						return true
-					end
+					require(backend)
+					
+					# We ensure that the interface methods replace any existing methods by prepending the module:
+					Traces.singleton_class.prepend(Backend::Interface)
+					
+					return true
 				rescue LoadError => error
 					warn "Unable to load traces backend: #{backend.inspect}!"
 				end

data/lib/traces/context.rb

@@ -11,10 +11,10 @@ module Traces
 		# Parse a string representation of a distributed trace.
 		# @parameter parent [String] The parent trace context.
 		# @parameter state [Array(String)] Any attached trace state.
-		def self.parse(parent, state = nil, **options)
+		def self.parse(parent, state = nil, baggage = nil, **options)
 			version, trace_id, parent_id, flags = parent.split("-")
 			
-			if version == "00"
+			if version == "00" && trace_id && parent_id && flags
 				flags = Integer(flags, 16)
 				
 				if state.is_a?(String)
@@ -25,11 +25,19 @@ module Traces
 					state = state.map{|item| item.split("=")}.to_h
 				end
 				
-				self.new(trace_id, parent_id, flags, state, **options)
+				if baggage.is_a?(String)
+					baggage = baggage.split(",")
+				end
+				
+				if baggage
+					baggage = baggage.map{|item| item.split("=")}.to_h
+				end
+				
+				self.new(trace_id, parent_id, flags, state, baggage, **options)
 			end
 		end
 		
-		# Create a local trace context which is likley to be globally unique.
+		# Create a local trace context which is likely to be globally unique.
 		# @parameter flags [Integer] Any trace context flags.
 		def self.local(flags = 0, **options)
 			self.new(SecureRandom.hex(16), SecureRandom.hex(8), flags, **options)
@@ -53,17 +61,18 @@ module Traces
 		# @parameter flags [Integer] An 8-bit field that controls tracing flags such as sampling, trace level, etc.
 		# @parameter state [Hash] Additional vendor-specific trace identification information.
 		# @parameter remote [Boolean] Whether this context was created from a distributed trace header.
-		def initialize(trace_id, parent_id, flags, state = nil, remote: false)
+		def initialize(trace_id, parent_id, flags, state = nil, baggage = nil, remote: false)
 			@trace_id = trace_id
 			@parent_id = parent_id
 			@flags = flags
 			@state = state
+			@baggage = baggage
 			@remote = remote
 		end
 		
 		# Create a new nested trace context in which spans can be recorded.
 		def nested(flags = @flags)
-			Context.new(@trace_id, SecureRandom.hex(8), flags, @state, remote: @remote)
+			Context.new(@trace_id, SecureRandom.hex(8), flags, @state, @baggage, remote: @remote)
 		end
 		
 		# The ID of the whole trace forest and is used to uniquely identify a distributed trace through a system. It is represented as a 16-byte array, for example, 4bf92f3577b34da6a3ce929d0e0e4736. All bytes as zero (00000000000000000000000000000000) is considered an invalid value.
@@ -75,9 +84,12 @@ module Traces
 		# An 8-bit field that controls tracing flags such as sampling, trace level, etc. These flags are recommendations given by the caller rather than strict rules.
 		attr :flags
 		
-		# Provides additional vendor-specific trace identification information across different distributed tracing systems. Conveys information about the operation's position in multiple distributed tracing graphs.
+		# Provides additional vendor-specific trace identification information across different distributed tracing systems.
 		attr :state
 		
+		# Provides additional application-specific trace identification information across different distributed tracing systems.
+		attr :baggage
+		
 		# Denotes that the caller may have recorded trace data. When unset, the caller did not record trace data out-of-band.
 		def sampled?
 			(@flags & SAMPLED) != 0
@@ -100,6 +112,7 @@ module Traces
 				parent_id: @parent_id,
 				flags: @flags,
 				state: @state,
+				baggage: @baggage,
 				remote: @remote
 			}
 		end
@@ -108,5 +121,50 @@ module Traces
 		def to_json(...)
 			as_json.to_json(...)
 		end
+		
+		# Inject the trace context into the headers, including the `"traceparent"`, `"tracestate"`, and `"baggage"` headers.
+		#
+		# @parameter headers [Hash] The headers hash to inject the trace context into.
+		#
+		# @returns [Hash] The modified headers hash.
+		def inject(headers)
+			headers["traceparent"] = self.to_s
+			
+			if @state and !@state.empty?
+				headers["tracestate"] = self.state.map{|key, value| "#{key}=#{value}"}.join(",")
+			end
+			
+			if @baggage and !@baggage.empty?
+				headers["baggage"] = self.baggage.map{|key, value| "#{key}=#{value}"}.join(",")
+			end
+			
+			return headers
+		end
+		
+		# Extract the trace context from the headers.
+		#
+		# The `"traceparent"` header is a string representation of the trace context. If it is an Array, the first element is used, otherwise it is used as is.
+		# The `"tracestate"` header is a string representation of the trace state. If it is a String, it is split on commas before being processed.
+		# The `"baggage"` header is a string representation of the baggage. If it is a String, it is split on commas before being processed.
+		#
+		# @parameter headers [Hash] The headers hash containing trace context.
+		# @returns [Context | Nil] The extracted trace context, or nil if no valid context found.
+		# @raises [ArgumentError] If headers is not a Hash or contains malformed trace data.
+		def self.extract(headers)
+			if traceparent = headers["traceparent"]
+				if traceparent.is_a?(Array)
+					traceparent = traceparent.first
+				end
+				
+				if traceparent.empty?
+					return nil
+				end
+				
+				tracestate = headers["tracestate"]
+				baggage = headers["baggage"]
+				
+				return self.parse(traceparent, tracestate, baggage, remote: true)
+			end
+		end
 	end
 end

data/lib/traces/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2025, by Samuel Williams.
 
 module Traces
-	VERSION = "0.17.0"
+	VERSION = "0.18.0"
 end

data/lib/traces.rb

@@ -5,6 +5,7 @@
 
 require_relative "traces/version"
 require_relative "traces/provider"
+require_relative "traces/context"
 
 # @namespace
 module Traces

data/readme.md

@@ -15,6 +15,8 @@ Please see the [project documentation](https://socketry.github.io/traces/) for m
 
   - [Getting Started](https://socketry.github.io/traces/guides/getting-started/index) - This guide explains how to use `traces` for tracing code execution.
 
+  - [Context Propagation](https://socketry.github.io/traces/guides/context-propagation/index) - This guide explains how to propagate trace context between different execution contexts within your application using `Traces.current_context` and `Traces.with_context`.
+
   - [Testing](https://socketry.github.io/traces/guides/testing/index) - This guide explains how to test traces in your code.
 
   - [Capture](https://socketry.github.io/traces/guides/capture/index) - This guide explains how to use `traces` for exporting traces from your application. This can be used to document all possible traces.
@@ -23,6 +25,11 @@ Please see the [project documentation](https://socketry.github.io/traces/) for m
 
 Please see the [project releases](https://socketry.github.io/traces/releases/index) for all releases.
 
+### v0.18.0
+
+  - **W3C Baggage Support** - Full support for W3C Baggage specification for application-specific context propagation.
+  - [New Context Propagation Interfaces](https://socketry.github.io/traces/releases/index#new-context-propagation-interfaces)
+
 ### v0.17.0
 
   - Remove support for `resource:` keyword argument with no direct replacement – use an attribute instead.

data/releases.md

@@ -1,5 +1,22 @@
 # Releases
 
+## v0.18.0
+
+  - **W3C Baggage Support** - Full support for W3C Baggage specification for application-specific context propagation.
+
+### New Context Propagation Interfaces
+
+`Traces#trace_context` and `Traces.trace_context` are insufficient for efficient inter-process tracing when using OpenTelemetry. That is because OpenTelemetry has it's own "Context" concept with arbitrary key-value storage (of which the current span is one such key/value pair). Unfortunately, OpenTelemetry requires those values to be propagated "inter-process" while ignores them for "intra-process" tracing.
+
+Therefore, in order to propagate this context, we introduce 4 new methods:
+
+  - `Traces.current_context` - Capture the current trace context for local propagation between execution contexts (threads, fibers).
+  - `Traces.with_context(context)` - Execute code within a specific trace context, with automatic restoration when used with blocks.
+  - `Traces.inject(headers = nil, context = nil)` - Inject W3C Trace Context headers into a headers hash for distributed propagation.
+  - `Traces.extract(headers)` - Extract trace context from W3C Trace Context headers.
+
+The default implementation is built on top of `Traces.trace_context`, however these methods can be replaced by the backend. In that case, the `context` object is opaque, in other words it is library-specific, and you should not assume it is an instance of `Traces::Context`.
+
 ## v0.17.0
 
   - Remove support for `resource:` keyword argument with no direct replacement – use an attribute instead.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traces
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Samuel Williams