trace 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa04b1bb4d22b20669eb74efbd0afdbd99b481817a16e2c20a9bdb11b6fa9353
-  data.tar.gz: c921971c0356563f72efb1625e7bacba6a00751199758d8a5e69e0dc0d3c1f7c
+  metadata.gz: fb527822327842c5c6b73e6d3b7b1f0aa34eec02f0c2e359bd518ed0244b3661
+  data.tar.gz: 4b3b5b346e92d79f869b02ab044bdd40829d7c66e0f912ed6ec7ee86e655114a
 SHA512:
-  metadata.gz: 4bb0215f0d3862bc5a745e37d5ec8032f61a212fccf1206653837929cb6d95f6fc3edf1f3629e6f4798f89903b783497852c23e65d59373f674519af1c02f77b
-  data.tar.gz: 731472a6b2d16537b7c527e1d118d1449310e37fe72a5840e719db891d4b3c7142bbad61078ff4518cce3a25646357a1cef2a1c3c41e0cda3eeea38fb3338ff5
+  metadata.gz: '086f6ae2a662b67e12081ca4e6c74ed885bafdd6c74be44ea70c21c7d75bae70a6879ece9a63395643644b54c7a54c61cf53a56b23a77dc574dfdf28b516db53'
+  data.tar.gz: 26aea73d38d0bed8bc0fb7e6775e22dbb23d0a2a087e7a9faa02e99a47ea36ea8c41bcca137385f3f209fadcfa6f0ea344ca479a1706b97d03f0af3b8572b026

data/lib/trace/backend/console.rb

@@ -26,7 +26,7 @@ module Trace
 	module Backend
 		private
 		
-		def trace(name, parent: nil, **attributes, &block)
+		def trace(name, parent = nil, **attributes, &block)
 			Console.logger.measure(self, name, parent: parent, **attributes) do
 				begin
 					yield

data/lib/trace/backend/datadog.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'ddtrace'
+
+module Trace
+	module Backend
+		private
+		
+		def trace(name, parent = nil, **attributes, &block)
+			if parent
+				parent = ::Datadog::Context.new(
+					trace_id: parent.trace_id,
+					span_id: parent.span_id,
+					sampled: parent.sampled?,
+				)
+			end
+			
+			::Datadog.tracer.trace(name, child_of: parent, tags: attributes) do |span|
+				begin
+					if block.arity.zero?
+						yield
+					else
+						yield trace_span_context(span)
+					end
+				rescue Exception => error
+					Console.logger.error(self, error)
+					raise
+				end
+			end
+		end
+		
+		def trace_span_context(span)
+			flags = 0
+			
+			if span.sampled
+				flags |= Context::SAMPLED
+			end
+			
+			return Context.new(
+				span.trace_id,
+				span.span_id,
+				flags,
+				nil,
+				remote: false
+			)
+		end
+	end
+end

data/lib/trace/backend/open_telemetry.rb

@@ -45,7 +45,11 @@ module Trace
 			span = TRACER.start_span(name, with_parent: parent, attributes: attributes)
 			
 			begin
-				yield
+				if block.arity.zero?
+					yield
+				else
+					yield trace_span_context(span)
+				end
 			rescue Exception => error
 				span&.record_exception(error)
 				span&.status = ::OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{error.class}")
@@ -54,5 +58,17 @@ module Trace
 				span&.finish
 			end
 		end
+		
+		def trace_span_context(span)
+			context = span.context
+			
+			return Context.new(
+				context.trace_id,
+				context.span_id,
+				context.trace_flags,
+				context.tracestate,
+				remote: context.remote?
+			)
+		end
 	end
 end

data/lib/trace/backend/test.rb

@@ -26,7 +26,22 @@ module Trace
 	module Backend
 		private
 		
-		def trace(name, parent: nil, **attributes, &block)
+		# Increment or decrement (part of a count) a named metric.
+		def adjust_metric(name, amount, **attributes)
+			# No-op.
+		end
+		
+		# Record a specific value (part of a distribution) for a named metric.
+		def record_metric(name, value, **attributes)
+			# No-op.
+		end
+		
+		# Record a specific value (part of a gauge) for a named metric.
+		def observe_metric(name, value, **attributes)
+			# No-op.
+		end
+		
+		def trace(name, parent = nil, **attributes, &block)
 			yield
 		end
 	end

data/lib/trace/backend.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Trace
+	def self.require_backend(env = ENV)
+		if backend = env['TRACE_BACKEND']
+			begin
+				path = File.join('backend', backend)
+				require_relative(path)
+			rescue LoadError
+				require(backend)
+			end
+		end
+	end
+end
+
+Trace.require_backend

data/lib/trace/provider.rb

@@ -20,6 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'backend'
+
 module Trace
 	module Provider
 		def trace_provider
@@ -42,7 +44,7 @@ module Trace
 		end
 	else
 		def self.Provider(klass, &block)
-			# No-op.
+			# Tracing disabled.
 		end
 	end
 end

data/lib/trace/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Trace
-	VERSION = "0.3.0"
+	VERSION = "0.4.2"
 end

data/lib/trace.rb

@@ -20,7 +20,5 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'trace/backend/console'
-
 require_relative 'trace/version'
 require_relative 'trace/provider'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trace
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,7 +31,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/trace.rb
+- lib/trace/backend.rb
 - lib/trace/backend/console.rb
+- lib/trace/backend/datadog.rb
 - lib/trace/backend/open_telemetry.rb
 - lib/trace/backend/test.rb
 - lib/trace/context.rb