traces 0.4.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08840f587a19c2f5f8300c832a29409c5fa2e59c9607cc2c38586baa7db4b573'
-  data.tar.gz: 42c1503ae596a3d8bdc8ece4bd839c09cdfa638236e4c64b1d4c42fcfcbe503e
+  metadata.gz: 623252ebe110a221b107349d5cf95c63df1d85733e7a7bc4448b01e6503ef9aa
+  data.tar.gz: 30137d284c359cbcbbc1518dc6137cb3bf5bf65aa7c0c0807182e1fb6ed0b843
 SHA512:
-  metadata.gz: cf699c4c10ddca5ffc2a40b70498dee12df99cd801c5820a20eab9ef0aa1772871e09fb4d4019415b3be66f02396260613950c124229374401356bc9536e90a6
-  data.tar.gz: 192db05a4272dd9420aa3341928289da2afd31a0c0181ec621f6bce0ba87ede6ac6575d3c17c6f2513cae94ce48c9216c5da1ddfe45ea6fdaa5f5a067aca985d
+  metadata.gz: b03e5650caedbc378f64818e8f94f9df222de598e78e3975ff1aafd6956b4443a3299f76435990edafc705cde434f4323884c5f52e6780083b60ebc772be59dc
+  data.tar.gz: 8188f5208ad9a5396830cd467fb5850e1590a073d436d3da1ad321f22b3f36447d971fee20f67f70d1cb02f6dd301c8bb3cc4c3438fd91b7312b4f99c39d456e

data/lib/traces/backend/console.rb

@@ -55,11 +55,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, attributes: {}, &block)
+				def trace(name, resource: self, attributes: {}, &block)
 					context = Context.nested(Fiber.current.traces_backend_context)
 					Fiber.current.traces_backend_context = context
 					
-					::Console.logger.info(self, name, attributes)
+					::Console.logger.info(resource, name, attributes)
 					
 					if block.arity.zero?
 						yield
@@ -74,13 +74,8 @@ module Traces
 				end
 				
 				# Get a trace context from the current execution scope.
-				# @parameter span [Span] An optional span from which to extract the context.
-				def trace_context(span = nil)
-					if span
-						span.context
-					else
-						Fiber.current.traces_backend_context
-					end
+				def trace_context
+					Fiber.current.traces_backend_context
 				end
 			end
 		end

data/lib/traces/backend/test.rb

@@ -43,12 +43,14 @@ module Traces
 				# @parameter key [String] The metadata key.
 				# @parameter value [Object] The metadata value. Should be coercable to a string.
 				def []= key, value
-					unless key.is_a?(String)
-						raise ArgumentError, "Invalid name!"
+					unless key.is_a?(String) || key.is_a?(Symbol)
+						raise ArgumentError, "Invalid attribute key (must be String or Symbol): #{key.inspect}!"
 					end
 					
-					unless String(value)
-						raise ArgumentError, "Invalid value!"
+					begin
+						String(value)
+					rescue
+						raise ArgumentError, "Invalid attribute value (must be convertible to String): #{value.inspect}!"
 					end
 				end
 			end
@@ -57,18 +59,34 @@ module Traces
 				# Trace the given block of code and validate the interface usage.
 				# @parameter name [String] A useful name/annotation for the recorded span.
 				# @parameter attributes [Hash] Metadata for the recorded span.
-				def trace(name, attributes: nil, &block)
+				def trace(name, resource: self.class.name, attributes: nil, &block)
+					unless block_given?
+						raise ArgumentError, "No block given!"
+					end
+					
 					unless name.is_a?(String)
-						raise ArgumentError, "Invalid name!"
+						raise ArgumentError, "Invalid name (must be String): #{name.inspect}!"
+					end
+					
+					if resource
+						# It should be convertable:
+						resource = resource.to_s
 					end
 					
 					context = Context.nested(Fiber.current.traces_backend_context)
+					
+					span = Span.new(context)
+					
+					# Ensure the attributes are valid and follow the requirements:
+					attributes&.each do |key, value|
+						span[key] = value
+					end
+					
 					Fiber.current.traces_backend_context = context
 					
 					if block.arity.zero?
 						yield
 					else
-						span = Span.new(context)
 						yield span
 					end
 				end
@@ -79,13 +97,8 @@ module Traces
 				end
 				
 				# Get a trace context from the current execution scope.
-				# @parameter span [Span] An optional span from which to extract the context.
-				def trace_context(span = nil)
-					if span
-						span.context
-					else
-						Fiber.current.traces_backend_context
-					end
+				def trace_context
+					Fiber.current.traces_backend_context
 				end
 			end
 		end

data/lib/traces/context.rb

@@ -39,7 +39,7 @@ module Traces
 				end
 				
 				if state
-					state = state.map{|item| item.split('=')}
+					state = state.map{|item| item.split('=')}.to_h
 				end
 				
 				self.new(trace_id, parent_id, flags, state, **options)
@@ -91,7 +91,7 @@ module Traces
 		
 		# 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
+			(@flags & SAMPLED) != 0
 		end
 		
 		# Whether this context was created from a distributed trace header.

data/lib/traces/provider.rb

@@ -23,6 +23,11 @@
 require_relative 'backend'
 
 module Traces
+	# @returns [Boolean] Whether there is an active backend.
+	def self.enabled?
+		self.const_defined?(:Backend)
+	end
+	
 	# A module which contains tracing specific wrappers.
 	module Provider
 		def traces_provider
@@ -31,7 +36,7 @@ module Traces
 	end
 	
 	# Bail out if there is no backend configured.
-	if self.const_defined?(:Backend)
+	if self.enabled?
 		# Extend the specified class in order to emit traces.
 		def self.Provider(klass, &block)
 			klass.extend(Provider)

data/lib/traces/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Traces
-	VERSION = "0.4.1"
+	VERSION = "0.6.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traces
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -10,48 +10,35 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEhDCCAuygAwIBAgIBATANBgkqhkiG9w0BAQsFADA3MTUwMwYDVQQDDCxzYW11
-  ZWwud2lsbGlhbXMvREM9b3Jpb250cmFuc2Zlci9EQz1jby9EQz1uejAeFw0yMTA4
-  MTYwNjMzNDRaFw0yMjA4MTYwNjMzNDRaMDcxNTAzBgNVBAMMLHNhbXVlbC53aWxs
-  aWFtcy9EQz1vcmlvbnRyYW5zZmVyL0RDPWNvL0RDPW56MIIBojANBgkqhkiG9w0B
-  AQEFAAOCAY8AMIIBigKCAYEAyXLSS/cw+fXJ5e7hi+U/TeChPWeYdwJojDsFY1xr
-  xvtqbTTL8gbLHz5LW3QD2nfwCv3qTlw0qI3Ie7a9VMJMbSvgVEGEfQirqIgJXWMj
-  eNMDgKsMJtC7u/43abRKx7TCURW3iWyR19NRngsJJmaR51yGGGm2Kfsr+JtKKLtL
-  L188Wm3f13KAx7QJU8qyuBnj1/gWem076hzdA7xi1DbrZrch9GCRz62xymJlrJHn
-  9iZEZ7AxrS7vokhMlzSr/XMUihx/8aFKtk+tMLClqxZSmBWIErWdicCGTULXCBNb
-  E/mljo4zEVKhlTWpJklMIhr55ZRrSarKFuW7en0+tpJrfsYiAmXMJNi4XAYJH7uL
-  rgJuJwSaa/dMz+VmUoo7VKtSfCoOI+6v5/z0sK3oT6sG6ZwyI47DBq2XqNC6tnAj
-  w+XmCywiTQrFzMMAvcA7rPI4F0nU1rZId51rOvvfxaONp+wgTi4P8owZLw0/j0m4
-  8C20DYi6EYx4AHDXiLpElWh3AgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8E
-  BAMCBLAwHQYDVR0OBBYEFB6ZaeWKxQjGTI+pmz7cKRmMIywwMC4GA1UdEQQnMCWB
-  I3NhbXVlbC53aWxsaWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWB
-  I3NhbXVlbC53aWxsaWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEB
-  CwUAA4IBgQBVoM+pu3dpdUhZM1w051iw5GfiqclAr1Psypf16Tiod/ho//4oAu6T
-  9fj3DPX/acWV9P/FScvqo4Qgv6g4VWO5ZU7z2JmPoTXZtYMunRAmQPFL/gSUc6aK
-  vszMHIyhtyzRc6DnfW2AiVOjMBjaYv8xXZc9bduniRVPrLR4J7ozmGLh4o4uJp7w
-  x9KCFaR8Lvn/r0oJWJOqb/DMAYI83YeN2Dlt3jpwrsmsONrtC5S3gOUle5afSGos
-  bYt5ocnEpKSomR9ZtnCGljds/aeO1Xgpn2r9HHcjwnH346iNrnHmMlC7BtHUFPDg
-  Ts92S47PTOXzwPBDsrFiq3VLbRjHSwf8rpqybQBH9MfzxGGxTaETQYOd6b4e4Ag6
-  y92abGna0bmIEb4+Tx9rQ10Uijh1POzvr/VTH4bbIPy9FbKrRsIQ24qDbNJRtOpE
-  RAOsIl+HOBTb252nx1kIRN5hqQx272AJCbCjKx8egcUQKffFVVCI0nye09v5CK+a
-  HiLJ8VOFx6w=
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2021-10-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+date: 2022-08-18 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables: []
@@ -84,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Application instrumentation and tracing.