metrics 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47038b401644ef77b0316ac3b16340df8f7efe44ca7d5b696a1cb73615a52ef7
-  data.tar.gz: '018de755d4db7d975b4b699b8fe67d7f19559816f1d970b595836609905c9a3c'
+  metadata.gz: 17744766f0b1ea11b5ff6d133cff9f17e3779c5ca364eb4d0ec6baff47a113b8
+  data.tar.gz: d375e8a6a550e480116af29e648c8e81c4a5639d1dc09dffdf0cfbfe8055f600
 SHA512:
-  metadata.gz: 3a5e5475285bad1a0b9e1124e5988a06490cf3a0eaed388499b1deaf91410084713a797aee99cd7bed6cde2483d7fe9fa0db471de01c38f2cfc899bfec94b87d
-  data.tar.gz: '019ed337389e7508fe8115e1587810a4eeee9d206bac126139718af8de82bb807928afca1588987cad5a964b8f510e9c4e50768f64eba3feb8f7c757f7acbdb9'
+  metadata.gz: 877a67b65d9c2b1ee8febb5a0899dd37dc07f2553d9b8a98a6c3c27c266c4c3a92c4345d717749110d7501e2eec0a9e9e5b70219c93fa6097c3d573c2a8f3e92
+  data.tar.gz: f0e2439306576fd0dcf20c1b6715da9534aa149252b7a6fb2aeb4d5bf8ec8844bf932a0d287b542ea23f03cf9d0ec41277c4d8bf6ff84557fdc4ba1dc4a138c5

data/lib/metrics/backend/console.rb

@@ -21,21 +21,34 @@
 # THE SOFTWARE.
 
 require 'console'
+require_relative '../metric'
 
 module Metrics
 	module Backend
-		private
-		
-		def metric_increment(name, amount = 1, attributes: nil)
-			Console.logger.info(self, name, "+= #{amount}", attributes)
-		end
-		
-		def metric_decrement(name, amount = 1, attributes: nil)
-			Console.logger.info(self, name, "-= #{amount}", attributes)
+		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 metric_measure(name, amount = 1, attributes: nil)
-			Console.logger.info(self, name, "<< #{amount}", attributes)
-		end
+		Interface = Console::Interface
 	end
 end
+

data/lib/metrics/backend/test.rb

@@ -21,18 +21,63 @@
 # THE SOFTWARE.
 
 require 'console'
+require_relative '../metric'
 
 module Metrics
 	module Backend
-		private
-		
-		def metric_increment(name, amount = 1, attributes: nil)
-		end
-		
-		def metric_decrement(name, amount = 1, attributes: nil)
+		module Test
+			VALID_METRIC_NAME = /\A[a-z0-9\-_\.]{1,128}\Z/i
+			VALID_TAG = /\A[a-z][a-z0-9\-_\.:\\]{0,127}\Z/i
+			
+			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
+					
+					tags&.each do |tag|
+						raise ArgumentError, "Invalid tag (must be String): #{tag.inspect}!" unless tag.is_a?(String)
+						
+						unless tag =~ VALID_TAG
+							raise ArgumentError, "Invalid tag (must match #{VALID_TAG}): #{tag.inspect}!"
+						end
+					end
+				end
+			end
+			
+			module Interface
+				def metric(name, type, description: nil, unit: nil, &block)
+					unless name.is_a?(String)
+						raise ArgumentError, "Invalid name (must be String): #{name.inspect}!"
+					end
+					
+					unless name =~ VALID_METRIC_NAME
+						raise ArgumentError, "Invalid name (must match #{VALID_METRIC_NAME}): #{name.inspect}!"
+					end
+					
+					unless type.is_a?(Symbol)
+						raise ArgumentError, "Invalid type (must be Symbol): #{type.inspect}!"
+					end
+					
+					# Description is optional but must be string if given:
+					if description
+						unless description.is_a?(String)
+							raise ArgumentError, "Invalid description (must be String): #{description.inspect}!"
+						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): #{unit.inspect}!"
+						end
+					end
+					
+					return Metric.new(name, type, description, unit)
+				end
+			end
 		end
 		
-		def metric_measure(name, amount = 1, attributes: nil)
-		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,12 @@
 require_relative 'backend'
 
 module Metrics
+	# @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 metrics_provider
 			@metrics_provider ||= Module.new
@@ -30,13 +36,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)
-			klass.prepend(Backend)
 			
 			provider = klass.metrics_provider
-			provider.prepend(Backend)
+			provider.extend(Backend::Interface)
 			
 			klass.prepend(provider)
 			
@@ -44,7 +50,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.1.0"
+	VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   RAOsIl+HOBTb252nx1kIRN5hqQx272AJCbCjKx8egcUQKffFVVCI0nye09v5CK+a
   HiLJ8VOFx6w=
   -----END CERTIFICATE-----
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2022-01-27 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:
@@ -83,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Application metrics and instrumentation.