traces 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 618c28f794dbd7fa30d3d211b50bb81a4bf785d8877f4512379d1f9bfc588032
-  data.tar.gz: 0e7dcc6c4e0f88a1721a06cf4225093d9375a15cfc2bf09ec3aa67e16448453b
+  metadata.gz: b5540f65335aab146d74616bfb46fe0119e93134ad8b3c241bfa97c31319d274
+  data.tar.gz: f4a13424f6035a3a11d1a3b5129123c391a3e3738a6a1594af83c17572d2410b
 SHA512:
-  metadata.gz: 8cf0fe5b427eca45083760ea6e5428f6b9a36ec00019ca55e4b505cd0edddd72c10c5d52fdca990a8e7676652cd72529f2f25a29298351625210702a9eb6111d
-  data.tar.gz: fe0a03d14440673a637843065cb48ff9a54be1c315e5c08b0117875e0b42642e268b6b087d2cb4d5f541abc6085aaf589fb23650eacffdd5f137abd90cf9c321
+  metadata.gz: 79f27a7a1e2fff3bfba6c17d933f957ae981778b9696c030f86cd12d08a0709ebc40a31b9812f2042d7bb3115bee52405f8eb27ec4a11e94032fa83d8302c39a
+  data.tar.gz: 277a0b1427ee998fb017d8043d550aabde68371481395ff0b1b1a6733f6a80136889d9e3e934897059fa69bd32b11c1f30fa3598be4443933f9563f746dfc9cb

data/lib/traces/backend/capture.rb

@@ -84,6 +84,11 @@ module Traces
 				def trace_context
 					Fiber.current.traces_backend_context
 				end
+				
+				# @returns [Boolean] Whether there is an active trace.
+				def active?
+					!!Fiber.current.traces_backend_context
+				end
 			end
 		end
 		

data/lib/traces/backend/console.rb

@@ -62,6 +62,11 @@ module Traces
 				def trace_context
 					Fiber.current.traces_backend_context
 				end
+				
+				# @returns [Boolean] Whether there is an active trace.
+				def active?
+					!!Fiber.current.traces_backend_context
+				end
 			end
 		end
 		

data/lib/traces/backend/test.rb

@@ -85,6 +85,11 @@ module Traces
 				def trace_context
 					Fiber.current.traces_backend_context
 				end
+				
+				# @returns [Boolean] Whether there is an active trace.
+				def active?
+					!!Fiber.current.traces_backend_context
+				end
 			end
 		end
 		

data/lib/traces/backend.rb

@@ -10,5 +10,11 @@ module Traces
 	module Backend
 	end
 	
+	# 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
+	
 	Config::DEFAULT.require_backend
 end

data/lib/traces/config.rb

@@ -38,12 +38,10 @@ module Traces
 					if require(backend)
 						Traces.extend(Backend::Interface)
 						
-						self.prepare
-						
 						return true
 					end
 				rescue LoadError => error
-					::Console::Event::Failure.for(error).emit(self, "Unable to load traces backend!", backend: backend, severity: :warn)
+					warn "Unable to load traces backend: #{backend.inspect}!"
 				end
 			end
 			

data/lib/traces/provider.rb

@@ -36,6 +36,8 @@ module Traces
 			
 			return provider
 		end
+		
+		Config::DEFAULT.prepare
 	else
 		def self.Provider(klass, &block)
 			# Tracing disabled.

data/lib/traces/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2023, by Samuel Williams.
 
 module Traces
-	VERSION = "0.14.0"
+	VERSION = "0.15.0"
 end

data/readme.md

@@ -25,7 +25,7 @@ Please see the [project releases](https://socketry.github.io/traces/releases/ind
 
 ### v0.14.0
 
-  - [Introduce `Traces::Config` to control tracing behavior](https://socketry.github.io/traces/releases/index#introduce-traces::config-to-control-tracing-behavior)
+  - [Introduce `Traces::Config` to Expose `prepare` Hook](https://socketry.github.io/traces/releases/index#introduce-traces::config-to-expose-prepare-hook)
 
 ## Contributing
 

data/releases.md

@@ -2,9 +2,9 @@
 
 ## v0.14.0
 
-### Introduce `Traces::Config` to control tracing behavior
+### Introduce `Traces::Config` to Expose `prepare` Hook
 
-There are some reasonable defaults for tracing, but sometimes you want to change them. Adding a `config/traces.rb` file to your project will allow you to do that.
+The `traces` gem uses aspect-oriented programming to wrap existing methods to emit traces. However, while there are some reasonable defaults for emitting traces, it can be useful to customize the behavior and level of detail. To that end, the `traces` gem now optionally loads a `config/traces.rb` which includes a `prepare` hook that can be used to load additional providers.
 
 ``` ruby
 # config/traces.rb
@@ -15,4 +15,4 @@ def prepare
 end
 ```
 
-The `prepare` method is called before the tracing is started but after the backend is required. You can require any provider you want in this file, or even add your own custom providers.
+The `prepare` method is called immediately after the traces backend is loaded. You can require any provider you want in this file, or even add your own custom providers.

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: traces
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
 - Felix Yan
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -38,10 +37,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies: []
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,7 +61,6 @@ licenses:
 metadata:
   documentation_uri: https://socketry.github.io/traces/
   source_code_uri: https://github.com/socketry/traces.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Application instrumentation and tracing.
 test_files: []