metrics 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68f3f47929348e39fb0b1989c529211aeca2e77a11d89cc74eb5156517413920
-  data.tar.gz: 23d3a1efe32f6de6a69f63401ad777e5ccd42d9386bb02dfa8039c0bfa84e7b0
+  metadata.gz: 193277c7355699f745c13423414860110e110ce7cc0ea2c6244d4a6aef1bace2
+  data.tar.gz: e5363e2f9660f500f69472421e314451cbdf7ef0339a8af685a4d7bd0006012d
 SHA512:
-  metadata.gz: 266cbaef3d8f81ba42de551bf2119ec6f93004a68cc373046726aec26129a949e01b3548362d6f155bd9fbc48144d06483fcc83db62c9eab34bfe340c4681df7
-  data.tar.gz: 50fe49335a1fadc4362d1dac69c084867eb47b358de9197d7f77276033a9c55176db64464bf422ef55da3e52ffef2263bd0baae741a0f0027e98182e8aa4d588
+  metadata.gz: c659a423919600b8efe495dce0bd45d78da651dd66ff6caa1f3bb95e95322171dccd0bfd2e417380c815105c6a13f1933c0a8672cf6c85407a8e7a7bcef54790
+  data.tar.gz: e153ebb2d36bd2471053f14569fcece3a72bacc8cfa799b750963a74d0b3ced80579130acfd87e8a27491da5950e08c5deddb3612cb24bc3f64ffb861eb2dcf9

data/lib/metrics/backend/capture.rb

@@ -3,7 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require "console"
 require_relative "../metric"
 
 module Metrics

data/lib/metrics/backend/console.rb

@@ -3,9 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require "console"
 require_relative "../metric"
 
+require "console"
+
 module Metrics
 	module Backend
 		module Console

data/lib/metrics/backend/test.rb

@@ -3,7 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require "console"
 require_relative "../metric"
 
 module Metrics

data/lib/metrics/backend.rb

@@ -3,27 +3,11 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require "console/event/failure"
+require_relative "config"
 
 module Metrics
 	module Backend
-		# Require a specific trace backend.
-		def self.require_backend(env = ENV)
-			if backend = env["METRICS_BACKEND"]
-				begin
-					require(backend)
-				rescue LoadError => error
-					::Console::Event::Failure.for(error).emit(self, "Unable to load metrics backend!", backend: backend, severity: :warn)
-					
-					return false
-				end
-				
-				Metrics.extend(Backend::Interface)
-				
-				return true
-			end
-		end
 	end
+	
+	Config::DEFAULT.require_backend
 end
-
-Metrics::Backend.require_backend

data/lib/metrics/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Metrics
+	# Represents a configuration for the metrics library.
+	class Config
+		DEFAULT_PATH = ENV.fetch("METRICS_CONFIG_DEFAULT_PATH", "config/metrics.rb")
+		
+		# Load the configuration from the given path.
+		# @parameter path [String] The path to the configuration file.
+		# @returns [Config] The loaded configuration.
+		def self.load(path)
+			config = self.new
+			
+			if File.exist?(path)
+				config.instance_eval(File.read(path), path)
+			end
+			
+			return config
+		end
+		
+		# Load the default configuration.
+		# @returns [Config] The default configuration.
+		def self.default
+			@default ||= self.load(DEFAULT_PATH)
+		end
+		
+		# Prepare the backend, e.g. by loading additional libraries or instrumentation.
+		def prepare
+		end
+		
+		# Require a specific metrics backend implementation.
+		def require_backend(env = ENV)
+			if backend = env["METRICS_BACKEND"]
+				begin
+					if require(backend)
+						Metrics.extend(Backend::Interface)
+						
+						return true
+					end
+				rescue LoadError => error
+					warn "Unable to load metrics backend: #{backend.inspect}!"
+				end
+			end
+			
+			return false
+		end
+		
+		# Load the default configuration.
+		DEFAULT = self.default
+	end
+end

data/lib/metrics/provider.rb

@@ -35,6 +35,8 @@ module Metrics
 			
 			return provider
 		end
+		
+		Config::DEFAULT.prepare
 	else
 		def self.Provider(klass, &block)
 			# Metrics disabled.

data/lib/metrics/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2024, by Samuel Williams.
 
 module Metrics
-	VERSION = "0.12.0"
+	VERSION = "0.12.1"
 end

data/lib/metrics.rb

@@ -6,3 +6,7 @@
 require_relative "metrics/version"
 require_relative "metrics/provider"
 require_relative "metrics/tags"
+
+# @namespace
+module Metrics
+end

data/readme.md

@@ -19,6 +19,14 @@ Please see the [project documentation](https://socketry.github.io/metrics/) for
 
   - [Testing](https://socketry.github.io/metrics/guides/testing/index) - This guide explains how to write assertions in your test suite to validate `metrics` are being emitted correctly.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/metrics/releases/index) for all releases.
+
+### v0.12.1
+
+  - [Introduce `Metrics::Config` to Expose `prepare` Hook](https://socketry.github.io/metrics/releases/index#introduce-metrics::config-to-expose-prepare-hook)
+
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -0,0 +1,18 @@
+# Releases
+
+## v0.12.1
+
+### Introduce `Metrics::Config` to Expose `prepare` Hook
+
+The `metrics` gem uses aspect-oriented programming to wrap existing methods to emit metrics. However, while there are some reasonable defaults for emitting metrics, it can be useful to customize the behavior and level of detail. To that end, the `metrics` gem now optionally loads a `config/metrics.rb` which includes a `prepare` hook that can be used to load additional providers.
+
+``` ruby
+# config/metrics.rb
+
+def prepare
+	require 'metrics/provider/async'
+	require 'metrics/provider/async/http'
+end
+```
+
+The `prepare` method is called immediately after the metrics backend is loaded. You can require any provider you want in this file, or even add your own custom providers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metrics
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-10-12 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -51,12 +51,14 @@ files:
 - lib/metrics/backend/capture.rb
 - lib/metrics/backend/console.rb
 - lib/metrics/backend/test.rb
+- lib/metrics/config.rb
 - lib/metrics/metric.rb
 - lib/metrics/provider.rb
 - lib/metrics/tags.rb
 - lib/metrics/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/metrics
 licenses:
 - MIT