traces 0.15.2 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cba8b363fbd6a0df7f971924f3b8d3f358bc5b91ea2eb57045716285081fc35
-  data.tar.gz: 612777384a90dbc375f1a349e8291cabd7bb8ebf77830075d29703e54d5f4d60
+  metadata.gz: 53f12f0b9d29fc4be9a9e701a4946bdf3ad74c226e3ba6059fccab724625c02d
+  data.tar.gz: 02b432f57ec9f3b2ddd2c0b793d490db2e5c4be827baeb63bee26c6e1d0a19ed
 SHA512:
-  metadata.gz: 162910bc810cdb69c55e6bb59354dd7b0859237a4cc47c5d1a4ce4ccb6cafee24913680d9f1d815540b4524941eb9fd8bcda7cd49bebcd3fbdac534708cb828e
-  data.tar.gz: 4e5432869b0470ae85fbee9d6efbc57130b07944f5960eb7ee4832a848068caf56445b5846434075206111262f17b12ce92564417ff56d90c3162ee5338f0bbc
+  metadata.gz: 36710faff7e4ba0a5f22318d5e74304d92ccd8f82761f89fc7c75608bbbba81e7a221996195c1eda59f37c569a3f0ed0fb6c54fd0bdd9088c01508fce0a4ab8f
+  data.tar.gz: ee106e0da529d689f268c4a92f8bc7dacfb2103fb13f15d55577c826c6ae07b495c85fd47ea67812179437074f82f0bac4affc1f836aa75e402c053295e6c550

checksums.yaml.gz.sig

@@ -1,3 +1 @@
-
��ބ�U!��ܰ}��2q�>��
-�)Ϸ��'A�݉�>H0t���@&/�/��kW?�$q�a�a,�()k���r��"�/9)�m�p�uNG)�uhˊ�~#�CȈ��U�Ԝg�%w͹��5���$��v����p�nUQ��.MT�7���
%�`���:��'��B�a+����M��������{�0�Ta�2.:�X�1���'�6��}ٱ�#���/#Ԭ�_y�j�]QU7A��"��͘�Q~�{B��v�O�9cw�y�w�������U��-�a��%2k.A-\t���s���
-"�����Z�M���
+BK�m�Aᨿ��$Χ��xf/v��ls�,NPe��!^�E���Y�5|ީȀ�Ԯ,��%�?.T�u�Kɥ�sj���	Ĕ�	2Mg΅ܖ�=K���3�d�MYl���7�q'��~채�ϴu���޾�I���s献H��`s���D��exC��R��KX���6�AsB���H%�3�=[S�Jn��LyH�z��H��#s�7(�:��eB�sf�Cw�N9w�g��`%o�������y��2c5Iq1%

data/bake/traces/capture.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2025, by Samuel Williams.
+
+# Enable capturing traces.
+def capture
+	ENV["TRACES_BACKEND"] = "traces/backend/capture"
+	require "traces"
+end
+
+# Generate a list of traces that have been captured.
+def list
+	Traces::Backend::Capture.spans.sort_by!{|span| span.name}
+end

data/bake/traces/provider.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+# List available providers for traces from all loaded gems.
+def list
+	available = {}
+	
+	Gem.loaded_specs.each do |name, spec|
+		spec.require_paths.each do |require_path|
+			root = File.expand_path(require_path, spec.full_gem_path)
+			Dir.glob("traces/provider/**/*.rb", base: root).each do |path|
+				(available[name] ||= []) << path
+			end
+		end
+	end
+	
+	return available
+end

data/context/capture.md

@@ -0,0 +1,39 @@
+# Capture
+
+This guide explains how to use `traces` for exporting traces from your application. This can be used to document all possible traces.
+
+## With Test Suite
+
+If your application defines one or more traces and emits them as part of a test suite, you can export them using the `bake traces:capture` command.
+
+```bash
+$ cd test/traces/backend/.capture/
+$ bake traces:capture run traces:capture:list output --format json
+[
+  {
+    "name": "my_trace",
+    "attributes": {
+      "foo": "baz"
+    },
+    "context": {
+      "trace_id": "038d110379a499a8ebcfb2b77cd69e1a",
+      "parent_id": "bf134b25de4f4a82",
+      "flags": 0,
+      "state": null,
+      "remote": false
+    }
+  },
+  {
+    "name": "nested",
+    "attributes": {
+    },
+    "context": {
+      "trace_id": "038d110379a499a8ebcfb2b77cd69e1a",
+      "parent_id": "2dd5510eb8fffc5f",
+      "flags": 0,
+      "state": null,
+      "remote": false
+    }
+  }
+]
+```

data/context/context-propagation.md

@@ -0,0 +1,212 @@
+# Context Propagation
+
+This guide explains how to propagate trace context between different execution contexts within your application using `Traces.current_context` and `Traces.with_context`.
+
+## Overview
+
+The `traces` library provides two complementary approaches for managing trace context:
+
+- **Local context propagation** (`Traces.current_context` / `Traces.with_context`): For passing context between execution contexts within the same process (threads, fibers, async tasks).
+- **Distributed context propagation** (`Traces.inject` / `Traces.extract`): For transmitting context across process and service boundaries via serialization (HTTP headers, message metadata, etc.).
+
+There is a legacy interface `Traces.trace_context` and `Traces.trace_context=` but you should prefer to use the new methods outlined above.
+
+## Local Context Propagation
+
+Local context propagation involves passing trace context between different execution contexts within the same process. This is essential for maintaining trace continuity when code execution moves between threads, fibers, async tasks, or other concurrent execution contexts. Unlike distributed propagation which requires serialization over network boundaries, local propagation uses Context objects directly.
+
+### Capturing the Current Context
+
+Use `Traces.current_context` to capture the current trace context as a Context object:
+
+~~~ ruby
+current_context = Traces.current_context
+# Returns a Traces::Context object or nil if no active trace
+~~~
+
+### Using the Context
+
+Use `Traces.with_context(context)` to execute code within a specific trace context:
+
+~~~ ruby
+# With block (automatic restoration):
+Traces.with_context(context) do
+	# Code runs with the specified context.
+end
+
+# Without block (permanent switch):
+Traces.with_context(context)
+# Context remains active.
+~~~
+
+### Use Cases
+
+#### Thread-Safe Context Propagation
+
+When spawning background threads, you often want them to inherit the current trace context:
+
+~~~ ruby
+require 'traces'
+
+# Main thread has active tracing
+Traces.trace("main_operation") do
+	# Capture current context before spawning thread:
+	current_context = Traces.current_context
+	
+	# Spawn background thread:
+	Thread.new do
+		# Restore context in the new thread:
+		Traces.with_context(current_context) do
+			# This thread now has the same trace context as main thread:
+			Traces.trace("background_work") do
+				perform_heavy_computation
+			end
+		end
+	end.join
+end
+~~~
+
+#### Fiber-Based Async Operations
+
+For fiber-based concurrency (like in async frameworks), context propagation ensures trace continuity:
+
+~~~ ruby
+require 'traces'
+
+Traces.trace("main_operation") do
+	current_context = Traces.current_context
+	
+	# Create fiber for async work:
+	fiber = Fiber.new do
+		Traces.with_context(current_context) do
+			# Fiber inherits the trace context:
+			Traces.trace("fiber_work") do
+				perform_async_operation
+			end
+		end
+	end
+	
+	fiber.resume
+end
+~~~
+
+### Context Propagation vs. New Spans
+
+Remember that context propagation maintains the same trace, while `trace()` creates new spans:
+
+~~~ ruby
+Traces.trace("parent") do
+	context = Traces.current_context
+	
+	Thread.new do
+		# This maintains the same trace context:
+		Traces.with_context(context) do
+			# This creates a NEW span within the same trace:
+			Traces.trace("child") do
+				# Child span, same trace as parent
+			end
+		end
+	end
+end
+~~~
+
+## Distributed Context Propagation
+
+Distributed context propagation involves transmitting trace context across process and service boundaries. Unlike local propagation which works within a single process, distributed propagation requires serializing context data and transmitting it over network protocols.
+
+### Injecting Context into Headers
+
+Use `Traces.inject(headers, context = nil)` to add W3C Trace Context headers to a headers hash for transmission over network boundaries:
+
+~~~ ruby
+require 'traces'
+
+# Capture current context:
+context = Traces.current_context
+headers = {'Content-Type' => 'application/json'}
+
+# Inject trace headers:
+Traces.inject(headers, context)
+# headers now contains: {'Content-Type' => '...', 'traceparent' => '00-...'}
+
+# Or use current context by default:
+Traces.inject(headers)  # Uses current trace context
+~~~
+
+### Extracting Context from Headers
+
+Use `Traces.extract(headers)` to extract trace context from W3C headers received over the network:
+
+~~~ ruby
+# Receive headers from incoming request:
+incoming_headers = request.headers
+
+# Extract context:
+context = Traces.extract(incoming_headers)
+# Returns a Traces::Context object or nil if no valid context
+
+# Use the extracted context:
+if context
+  Traces.with_context(context) do
+    # Process request with distributed trace context
+  end
+end
+~~~
+
+### Use Cases
+
+#### Outgoing HTTP Requests
+
+~~~ ruby
+require 'traces'
+
+class ApiClient
+	def make_request(endpoint, data)
+		Traces.trace("api_request", attributes: {endpoint: endpoint}) do
+			headers = {
+				'content-type' => 'application/json'
+			}
+			
+			# Add trace context to outgoing request:
+			Traces.inject(headers)
+			
+			http_client.post(endpoint, 
+				body: data.to_json,
+				headers: headers
+			)
+		end
+	end
+end
+~~~
+
+#### Incoming HTTP Requests
+
+~~~ ruby
+require 'traces'
+
+class WebController
+	def handle_request(request)
+		# Extract trace context from incoming headers:
+		context = Traces.extract(request.headers)
+		
+		# Process request with inherited context:
+		if context
+			Traces.with_context(context) do
+				Traces.trace("web_request", attributes: {
+					path: request.path,
+					method: request.method
+				}) do
+					process_business_logic
+				end
+			end
+		else
+			Traces.trace("web_request", attributes: {
+				path: request.path,
+				method: request.method
+			}) do
+				process_business_logic
+			end
+		end
+	end
+end
+~~~

data/context/getting-started.md

@@ -0,0 +1,126 @@
+# Getting Started
+
+This guide explains how to use `traces` for tracing code execution.
+
+## Installation
+
+Add the gem to your project:
+
+~~~ bash
+$ bundle add traces
+~~~
+
+## Core Concepts
+
+`traces` has several core concepts:
+
+- A {ruby Traces::Provider} which implements custom logic for wrapping existing code in traces.
+- A {ruby Traces::Context} which represents the current tracing environment which can include distributed tracing.
+- A {ruby Traces::Backend} which connects traces to a specific backend system for processing.
+
+## Usage
+
+There are two main aspects to integrating within this gem.
+
+1. Libraries and applications must provide traces.
+2. Those traces must be consumed or emitted somewhere.
+
+### Providing Traces
+
+Adding tracing to libraries requires the use of {ruby Traces::Provider}:
+
+~~~ ruby
+require 'traces'
+
+class MyClass
+	def my_method
+		puts "Hello World"
+	end
+end
+
+# If tracing is disabled, this is a no-op.
+Traces::Provider(MyClass) do
+	def my_method
+		attributes = {
+			'foo' => 'bar'
+		}
+		
+		Traces.trace('my_method', attributes: attributes) do
+			super
+		end
+	end
+end
+
+MyClass.new.my_method
+~~~
+
+This code by itself will not create any traces. In order to execute it and output traces, you must set up a backend to consume them.
+
+In addition, to trace class methods:
+
+~~~ ruby
+require 'traces'
+
+class MyClass
+	def self.my_method
+		puts "Hello World"
+	end
+end
+
+# If tracing is disabled, this is a no-op.
+Traces::Provider(MyClass.singleton_class) do
+	def my_method
+		attributes = {
+			'foo' => 'bar'
+		}
+		
+		Traces.trace('my_method', attributes: attributes) do
+			super
+		end
+	end
+end
+
+MyClass.my_method
+~~~
+
+### Consuming Traces
+
+Consuming traces means proving a backend implementation which can emit those traces to some log or service. There are several options, but two backends are included by default:
+
+- `traces/backend/test` does not emit any traces, but validates the usage of the tracing interface.
+- `traces/backend/console` emits traces using the [`console`](https://github.com/socketry/console) gem.
+
+In order to use a specific backend, set the `TRACES_BACKEND` environment variable, e.g.
+
+~~~ shell
+$ TRACES_BACKEND=traces/backend/console ./my_script.rb
+~~~
+
+Separate implementations are provided for specific APMs:
+
+- [OpenTelemetry](https://github.com/socketry/traces-backend-open_telemetry)
+- [Datadog](https://github.com/socketry/traces-backend-datadog)
+- [New Relic](https://github.com/newrelic/traces-backend-newrelic)
+
+### Configuration
+
+By default, you may not have many traces available, as they are typically opt-in. To enable more traces, create a `config/traces.rb` file in your project root and require the providers you want to use:
+
+```ruby
+# config/traces.rb
+def prepare
+	require "traces/provider/async"
+	require "traces/provider/async/pool"
+end
+```
+
+To get a list of all available providers, you can use the `bake` command:
+
+~~~ shell
+$ bundle exec bake traces:provider:list
+{"async" => ["traces/provider/async/barrier.rb", "traces/provider/async/task.rb", "traces/provider/async.rb"],
+ "async-pool" => ["traces/provider/async/pool/controller.rb"],
+ "protocol-http2" => ["traces/provider/protocol/http2/framer.rb", "traces/provider/protocol/http2.rb"]}
+~~~
+
+You can then add the providers you want to use to your `config/traces.rb` file.

data/context/index.yaml

@@ -0,0 +1,23 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Application instrumentation and tracing.
+metadata:
+  documentation_uri: https://socketry.github.io/traces/
+  source_code_uri: https://github.com/socketry/traces.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use `traces` for tracing code execution.
+- path: context-propagation.md
+  title: Context Propagation
+  description: This guide explains how to propagate trace context between different
+    execution contexts within your application using `Traces.current_context` and
+    `Traces.with_context`.
+- path: testing.md
+  title: Testing
+  description: This guide explains how to test traces in your code.
+- path: capture.md
+  title: Capture
+  description: This guide explains how to use `traces` for exporting traces from your
+    application. This can be used to document all possible traces.

data/context/testing.md

@@ -0,0 +1,32 @@
+# Testing
+
+This guide explains how to test traces in your code.
+
+## Expectations
+
+One approach to testing traces are emitted, is by using mocks to verify that methods are called with the expected arguments.
+
+```ruby
+it "should trace the operation" do
+	expect(Traces).to receive(:trace).with("my_controller.do_something")
+	
+	my_controller.do_something
+end
+```
+
+This is generally a good appoach for testing that specific traces are emitted.
+
+## Validation
+
+The traces gem supports a variety of backends, and each backend may have different requirements for the data that is submitted. The test backend is designed to be used for testing that the data submitted is valid.
+
+```ruby
+ENV['TRACES_BACKEND'] = 'traces/backend/test'
+
+require 'traces'
+
+Traces.trace(5) do
+	puts "Hello"
+end
+# => lib/traces/backend/test.rb:52:in `trace': Invalid name (must be String): 5! (ArgumentError)
+```

data/lib/traces/backend/capture.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require_relative '../context'
+require_relative "../context"
 
-require 'fiber'
+require "fiber"
 
 Fiber.attr_accessor :traces_backend_context
 
@@ -20,16 +20,14 @@ module Traces
 				# @parameter name [String] A useful name/annotation for the recorded span.
 				# @parameter resource [String] The "resource" that the span is associated with.
 				# @parameter attributes [Hash] Metadata for the recorded span.
-				def initialize(context, name, resource, attributes)
+				def initialize(context, name, attributes)
 					@context = context
 					@name = name
-					@resource = resource
 					@attributes = attributes
 				end
 				
 				attr :context
 				attr :name
-				attr :resource
 				attr :attributes
 				
 				# Assign some metadata to the span.
@@ -43,7 +41,6 @@ module Traces
 				def as_json
 					{
 						name: @name,
-						resource: @resource,
 						attributes: @attributes,
 						context: @context.as_json
 					}
@@ -65,11 +62,11 @@ module Traces
 				# Trace the given block of code and log the execution.
 				# @parameter name [String] A useful name/annotation for the recorded span.
 				# @parameter attributes [Hash] Metadata for the recorded span.
-				def trace(name, resource: nil, attributes: {}, &block)
+				def trace(name, attributes: {}, &block)
 					context = Context.nested(Fiber.current.traces_backend_context)
 					Fiber.current.traces_backend_context = context
 					
-					span = Span.new(context, name, resource, attributes)
+					span = Span.new(context, name, attributes)
 					Capture.spans << span
 					
 					yield span

data/lib/traces/backend/console.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
-require_relative '../context'
+require_relative "../context"
 
-require 'console'
-require 'fiber'
+require "console"
+require "fiber"
 
 Fiber.attr_accessor :traces_backend_context
 
@@ -40,11 +40,11 @@ module Traces
 				# Trace the given block of code and log the execution.
 				# @parameter name [String] A useful name/annotation for the recorded span.
 				# @parameter attributes [Hash] Metadata for the recorded span.
-				def trace(name, resource: nil, attributes: {}, &block)
+				def trace(name, attributes: {}, &block)
 					context = Context.nested(Fiber.current.traces_backend_context)
 					Fiber.current.traces_backend_context = context
 					
-					::Console.logger.info(resource || self, name, attributes)
+					::Console.logger.info(self, name, attributes)
 					
 					if block.arity.zero?
 						yield

data/lib/traces/backend/test.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
-require_relative '../context'
+require_relative "../context"
 
-require 'fiber'
+require "fiber"
 
 Fiber.attr_accessor :traces_backend_context
 
@@ -46,7 +46,7 @@ module Traces
 				# @parameter name [String] A useful name/annotation for the recorded span.
 				# @parameter resource [String] The context in which the trace operation is occuring.
 				# @parameter attributes [Hash] Metadata for the recorded span.
-				def trace(name, resource: nil, attributes: nil, &block)
+				def trace(name, attributes: nil, &block)
 					unless block_given?
 						raise ArgumentError, "No block given!"
 					end
@@ -55,9 +55,6 @@ module Traces
 						raise ArgumentError, "Invalid name (must be String): #{name.inspect}!"
 					end
 					
-					# It should be convertable:
-					resource &&= resource.to_s
-					
 					context = Context.nested(Fiber.current.traces_backend_context)
 					
 					span = Span.new(context)
@@ -88,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

@@ -3,24 +3,105 @@
 # Released under the MIT License.
 # Copyright, 2021-2025, by Samuel Williams.
 
-require_relative 'config'
+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

@@ -33,14 +33,14 @@ module Traces
 		
 		# Require a specific traces backend implementation.
 		def require_backend(env = ENV)
-			if backend = env['TRACES_BACKEND']
+			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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
-require 'securerandom'
+require "securerandom"
 
 module Traces
 	# A generic representation of the current tracing context.
@@ -11,25 +11,33 @@ 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)
-			version, trace_id, parent_id, flags = parent.split('-')
+		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)
-					state = state.split(',')
+					state = state.split(",")
 				end
 				
 				if state
-					state = state.map{|item| item.split('=')}.to_h
+					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/provider.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
-require_relative 'backend'
+require_relative "backend"
 
 module Traces
 	# @returns [Boolean] Whether there is an active backend.
@@ -36,8 +36,6 @@ module Traces
 			
 			return provider
 		end
-		
-		Config::DEFAULT.prepare
 	else
 		def self.Provider(klass, &block)
 			# Tracing disabled.

data/lib/traces/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
 module Traces
-	VERSION = "0.15.2"
+	VERSION = "0.18.2"
 end

data/lib/traces.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 
-require_relative 'traces/version'
-require_relative 'traces/provider'
+require_relative "traces/version"
+require_relative "traces/provider"
 
 # @namespace
 module Traces
+	if self.enabled?
+		Config::DEFAULT.prepare
+	end
 end

data/license.md

@@ -1,7 +1,8 @@
 # MIT License
 
-Copyright, 2021-2024, by Samuel Williams.  
+Copyright, 2021-2025, by Samuel Williams.  
 Copyright, 2022, by Felix Yan.  
+Copyright, 2024, by Zach Taylor.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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,23 @@ 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.1
+
+  - Don't call `prepare` in `traces/provider.rb`. It can cause circular loading warnings.
+
+### 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.
+
+### v0.16.0
+
+  - Introduce `traces:provider:list` command to list all available trace providers.
+
 ### v0.14.0
 
   - [Introduce `Traces::Config` to Expose `prepare` Hook](https://socketry.github.io/traces/releases/index#introduce-traces::config-to-expose-prepare-hook)

data/releases.md

@@ -1,5 +1,34 @@
 # Releases
 
+## v0.18.1
+
+  - Don't call `prepare` in `traces/provider.rb`. It can cause circular loading warnings.
+
+## 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.
+
+## v0.16.0
+
+  - Introduce `traces:provider:list` command to list all available trace providers.
+
 ## v0.14.0
 
 ### Introduce `Traces::Config` to Expose `prepare` Hook

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: traces
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.18.2
 platform: ruby
 authors:
 - Samuel Williams
 - Felix Yan
+- Zach Taylor
 bindir: bin
 cert_chain:
 - |
@@ -37,12 +38,19 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-02-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- bake/traces/capture.rb
+- bake/traces/provider.rb
+- context/capture.md
+- context/context-propagation.md
+- context/getting-started.md
+- context/index.yaml
+- context/testing.md
 - lib/traces.rb
 - lib/traces/backend.rb
 - lib/traces/backend/capture.rb
@@ -68,14 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Application instrumentation and tracing.
 test_files: []