metrics 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca751f7a0f0ce3c575014f236d8f34738723c6b64933c1fac259f9c19b13c460
-  data.tar.gz: 0e9b3b2a695ec555416b20d969968079943730723411076081c6e5447af632aa
+  metadata.gz: 8db52b23e0e9f9fc5b7b1253667da5ee801eea1f2e0555908cb51f698c3e3ae7
+  data.tar.gz: b428e08aeb5d30604a19e69058567ba0be4bdd188ac6bad8d7a15c64766f9dc1
 SHA512:
-  metadata.gz: ce75234031de1b6382ddb86311ea33afa4c1924f9ed14a233ff010a4a6acaf2de09a95aeda229462def77eb84d3cc831da1f3ca52e5c1d7a4376a65fb95485ad
-  data.tar.gz: 1392e8e3f39e800dc33b63e9e30a1ca9c15da3b03d2ed04f01393db8a07582f32afd6e15c3c203d0d0cf9a35afabdc1ca966c0ee299be4d571b134b96b20b29f
+  metadata.gz: 397fa3e698ffbcabe00733a9c2370e9d4fb96320669fd546a547f01dae73c90f97932ee4eb19f9f5ce6579e123ad0931d62635b3539e6bc46cb5db5605e3073f
+  data.tar.gz: 9a60eb2350b9d7ee760636c45392d0aa3ee198c90ebc7d51ee3f9556f4b75c8c9af7aff4ffdc9edc5ac2a904d551d5b504818ff8a67cfcbf4b6b2078681c3d5b

data/lib/metrics/backend/console.rb

@@ -21,34 +21,34 @@
 # THE SOFTWARE.
 
 require 'console'
+require_relative '../metric'
 
 module Metrics
 	module Backend
-		module Register
-			def metric_register(name, type, **options)
-				Console.logger.debug(self) {"Registering metric #{name} (#{type}): #{options}."}
+		module Console
+			class Metric < Metrics::Metric
+				def emit(value, tags: nil, sample_rate: 1.0)
+					::Console.logger.info(self, @name, value, tags)
+				end
+			end
+			
+			module Interface
+				def metric(name, type, description: nil, unit: nil, &block)
+					return Metric.new(name, type, description, unit)
+				end
+				
+				# def metric_call_counter(name, description: nil, tags: nil)
+				# 	metric = self.metric(...)
+				# 
+				# 	self.define_method(name) do
+				# 		metric.emit(1)
+				#			super
+				# 	end
+				# end
 			end
 		end
 		
-		def self.prepended(provider)
-			provider.extend(Register)
-		end
-		
-		private
-		
-		# Relative metric adjustment.
-		def metric_adjust(name, amount = 1, attributes: nil)
-			Console.logger.info(self, name, "+= #{amount}", attributes)
-		end
-		
-		# Absolute metric assignment.
-		def metric_count(name, value, attributes: nil)
-			Console.logger.info(self, name, "= #{amount}", attributes)
-		end
-		
-		# Relative metric measurement.
-		def metric_measure(name, value, attributes: nil)
-			Console.logger.info(self, name, "<< #{amount}", attributes)
-		end
+		Interface = Console::Interface
 	end
 end
+

data/lib/metrics/backend/test.rb

@@ -21,70 +21,63 @@
 # THE SOFTWARE.
 
 require 'console'
+require_relative '../metric'
 
 module Metrics
 	module Backend
-		module Register
-			def metric_register(name, type, description: nil, unit: nil, &block)
-				unless name.is_a?(String)
-					raise ArgumentError, "Invalid name!"
-				end
-				
-				unless type.is_a?(Symbol)
-					raise ArgumentError, "Invalid type!"
-				end
-				
-				if description
-					unless description.is_a?(String)
-						raise ArgumentError, "Invalid description!"
+		module Test
+			VALID_METRIC_NAME = /\A[a-z0-9\-_\.]{1,128}\Z/
+			VALID_TAG = /\A[a-z][a-z0-9\-_\.:\\]{0,127}\Z/
+			
+			class Metric < Metrics::Metric
+				def emit(value, tags: nil, sample_rate: 1.0)
+					unless value.is_a?(Numeric)
+						raise ArgumentError, "Value must be numeric!"
 					end
-				end
-				
-				if unit
-					unless unit.is_a?(String)
-						raise ArgumentError, "Invalid unit!"
+					
+					tags&.each do |tag|
+						raise ArgumentError, "Invalid tag, must be string!" unless tag.is_a?(String)
+						
+						unless tag =~ VALID_TAG
+							raise ArgumentError, "Invalid tag, must match #{VALID_TAG}!"
+						end
 					end
 				end
 			end
-		end
-		
-		def self.prepended(provider)
-			provider.extend(Register)
-		end
-		
-		private
-		
-		# Relative metric adjustment.
-		def metric_adjust(name, amount = 1, attributes: nil)
-			unless name.is_a?(String)
-				raise ArgumentError, "Invalid name!"
-			end
 			
-			unless amount.is_a?(Numeric)
-				raise ArgumentError, "Invalid amount!"
-			end
-		end
-		
-		# Absolute metric assignment.
-		def metric_count(name, value, attributes: nil)
-			unless name.is_a?(String)
-				raise ArgumentError, "Invalid name!"
-			end
-			
-			unless value.is_a?(Numeric)
-				raise ArgumentError, "Invalid value!"
+			module Interface
+				def metric(name, type, description: nil, unit: nil, &block)
+					unless name.is_a?(String)
+						raise ArgumentError, "Invalid name, must be string!"
+					end
+					
+					unless name =~ VALID_METRIC_NAME
+						raise ArgumentError, "Invalid name, must match #{VALID_METRIC_NAME}!"
+					end
+					
+					unless type.is_a?(Symbol)
+						raise ArgumentError, "Invalid type, must be symbol!"
+					end
+					
+					# Description is optional but must be string if given:
+					if description
+						unless description.is_a?(String)
+							raise ArgumentError, "Invalid description, must be string!"
+						end
+					end
+					
+					# Unit is optional but must be string if given:
+					if unit
+						unless unit.is_a?(String)
+							raise ArgumentError, "Invalid unit, must be string!"
+						end
+					end
+					
+					return Metric.new(name, type, description, unit)
+				end
 			end
 		end
 		
-		# Relative metric measurement.
-		def metric_measure(name, value, attributes: nil)
-			unless name.is_a?(String)
-				raise ArgumentError, "Invalid name!"
-			end
-			
-			unless value.is_a?(Numeric)
-				raise ArgumentError, "Invalid value!"
-			end
-		end
+		Interface = Test::Interface
 	end
-end
+end

data/lib/metrics/backend.rb

@@ -21,10 +21,10 @@
 # THE SOFTWARE.
 
 module Metrics
+	# Require a specific trace backend.
 	def self.require_backend(env = ENV)
-		if backend = env['METRICS_BACKEND']
-			path = File.join('backend', backend)
-			require_relative(path)
+		if path = env['METRICS_BACKEND']
+			require(path)
 		end
 	end
 end

data/lib/metrics/metric.rb

@@ -0,0 +1,41 @@
+# 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 Metrics
+	class Metric
+		def initialize(name, type, description, unit)
+			@name = name
+			@type = type
+			@description = description
+			@unit = unit
+		end
+		
+		attr :name
+		attr :type
+		attr :description
+		attr :unit
+		
+		def emit(value, tags: nil, sample_rate: 1.0)
+			raise NotImplementedError
+		end
+	end
+end

data/lib/metrics/provider.rb

@@ -23,6 +23,11 @@
 require_relative 'backend'
 
 module Metrics
+	def self.enabled?
+		self.const_defined?(:Backend)
+	end
+	
+	# A module which contains tracing specific wrappers.
 	module Provider
 		def metrics_provider
 			@metrics_provider ||= Module.new
@@ -30,12 +35,13 @@ module Metrics
 	end
 	
 	# Bail out if there is no backend configured.
-	if Metrics.const_defined?(:Backend)
+	if self.enabled?
+		# Extend the specified class in order to emit traces.
 		def self.Provider(klass, &block)
 			klass.extend(Provider)
 			
 			provider = klass.metrics_provider
-			provider.prepend(Backend)
+			provider.extend(Backend::Interface)
 			
 			klass.prepend(provider)
 			
@@ -43,7 +49,7 @@ module Metrics
 		end
 	else
 		def self.Provider(klass, &block)
-			# Tracing disabled.
+			# Metrics disabled.
 		end
 	end
 end

data/lib/metrics/tags.rb

@@ -0,0 +1,37 @@
+# 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 'backend'
+
+module Metrics
+	module Tags
+		def self.normalize(tags)
+			return nil unless tags&.any?
+			
+			if tags.is_a?(Hash)
+				tags = tags.map{|key, value| "#{key}:#{value}"}
+			end
+			
+			return Array(tags)
+		end
+	end
+end

data/lib/metrics/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   RAOsIl+HOBTb252nx1kIRN5hqQx272AJCbCjKx8egcUQKffFVVCI0nye09v5CK+a
   HiLJ8VOFx6w=
   -----END CERTIFICATE-----
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -62,7 +62,9 @@ files:
 - lib/metrics/backend.rb
 - lib/metrics/backend/console.rb
 - lib/metrics/backend/test.rb
+- lib/metrics/metric.rb
 - lib/metrics/provider.rb
+- lib/metrics/tags.rb
 - lib/metrics/version.rb
 homepage: https://github.com/socketry/metrics
 licenses: