trace 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c675b7217702e13f10c5bb1b4b0a12d8c190b02fa4a25c72c8b86ccc4c1b2924
-  data.tar.gz: 7515cc6b87e32a49c0c859be13e07519e74099ef493db8001d372d5f858915af
+  metadata.gz: 656cd18803b101a7b5277c741de308ea0060f185e77968992f103a00349ce781
+  data.tar.gz: 3490984da2c202c2f7043c68a94f9a48d9a20a930c7f1c638d10d6ec9d526800
 SHA512:
-  metadata.gz: c83f8843932c0d9f84356b4fa45dd14252e920752ea271ba367cf5d57041ee92762e8b2a221fb11315aee1c5708264852c73361a85e555702e3064ef5f977e42
-  data.tar.gz: 2e890163ef6241ab39376689e6cd1c909e662609c5a2fcd21fabb950f1329c76a6b8053616a768c02062545d48132ea3ed9e32987e55d942722750583d3b8547
+  metadata.gz: d78d14f24fdfae8d32ca7c606ed737f7ff81d2ec096ae0f8d35dd81828b938fd43bbb993e385763f2447f0abab0f960b04f9fc7d3b21cb4c05eb43ba43b29524
+  data.tar.gz: e4b6988c6dc61ab8fa2733a55f7bba1473812558032c7ab3c0d59b7e1626b44b7475f36cd974cf96f729cb10149ed9f1ca41c756500474c9fcd0f7865e870443

data/lib/trace/backend/console.rb

@@ -26,33 +26,9 @@ module Trace
 	module Backend
 		private
 		
-		# Increment or decrement (part of a count) a named metric.
-		def adjust_metric(name, amount, **attributes)
-			if amount > 0
-				Console.logger.info(self, "#{name} +#{amount}")
-			else
-				Console.logger.info(self, "#{name} -#{amount}")
-			end
-		end
-		
-		# Record a specific value (part of a distribution) for a named metric.
-		def record_metric(name, value, **attributes)
-			Console.logger.info(self, "#{name} << #{value}")
-		end
-		
-		# Record a specific value (part of a gauge) for a named metric.
-		def observe_metric(name, value, **attributes)
-			Console.logger.info(self, "#{name} = #{value}")
-		end
-		
-		def trace(name, parent = nil, **attributes, &block)
-			Console.logger.measure(self, name, parent: parent, **attributes) do
-				begin
-					yield
-				rescue Exception => error
-					Console.logger.error(self, error)
-					raise
-				end
+		def trace(name, parent = nil, attributes: nil, &block)
+			Console.logger.measure(self, name, **attributes) do
+				yield
 			end
 		end
 	end

data/lib/trace/backend/datadog.rb

@@ -0,0 +1,70 @@
+# 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_relative '../context'
+
+require 'ddtrace'
+
+module Trace
+	module Backend
+		private
+		
+		def trace(name, parent = nil, attributes: nil, &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

@@ -20,32 +20,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative '../context'
+
 require 'opentelemetry/sdk'
 
 module Trace
 	module Backend
 		private
 		
-		# 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
-		
 		# Provides a backend that writes data to OpenTelemetry.
 		# See <https://github.com/open-telemetry/opentelemetry-ruby> for more details.
 		TRACER = ::OpenTelemetry.tracer_provider.tracer(Trace, Trace::VERSION)
 		
-		def trace(name, parent = nil, **attributes, &block)
+		def trace(name, parent = nil, attributes: nil, &block)
 			if parent
 				# Convert it to the required object:
 				parent = ::OpenTelemetry::Trace::SpanContext.new(

data/lib/trace/backend/test.rb

@@ -26,22 +26,7 @@ module Trace
 	module Backend
 		private
 		
-		# 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)
+		def trace(name, parent = nil, attributes: nil, &block)
 			yield
 		end
 	end

data/lib/trace/backend.rb

@@ -0,0 +1,32 @@
+# 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']
+			path = File.join('backend', backend)
+			require_relative(path)
+		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.1"
+	VERSION = "0.5.0"
 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.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-09-04 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