Prefer Metrics.metric rather than modify the current class. (#6)

socketry · Jun 19, 2023 · aa83725 · aa83725
1 parent 536f22d
commit aa83725
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 5 deletions.
diff --git a/guides/getting-started/readme.md b/guides/getting-started/readme.md
@@ -39,7 +39,7 @@ end
 
 # If metrics are disabled, this is a no-op.
 Metrics::Provider(MyClass) do
-	CALL_COUNT = metric('call_count', :counter, description: 'Number of times invoked.')
+	CALL_COUNT = Metrics.metric('call_count', :counter, description: 'Number of times invoked.')
 
 	def my_method
 		CALL_COUNT.emit(1)
@@ -67,7 +67,7 @@ class MyClass
 end
 
 Metrics::Provider(MyClass.singleton_class) do
-	CALL_COUNT = metric('call_count', :counter, description: 'Number of times invoked.')
+	CALL_COUNT = Metrics.metric('call_count', :counter, description: 'Number of times invoked.')
 
 	def my_method
 		CALL_COUNT.emit(1)

diff --git a/lib/metrics/backend.rb b/lib/metrics/backend.rb
@@ -8,6 +8,8 @@ module Metrics
 	def self.require_backend(env = ENV)
 		if path = env['METRICS_BACKEND']
 			require(path)
+
+			Metrics.extend(Backend::Interface)
 		end
 	end
 end

diff --git a/lib/metrics/provider.rb b/lib/metrics/provider.rb
@@ -21,6 +21,13 @@ def metrics_provider
 		end
 	end
 
+	module Deprecated
+		def metric(...)
+			warn "Metrics::Provider#metric is deprecated. Please use Metrics.metric instead."
+			Metrics.metric(...)
+		end
+	end
+
 	private_constant :Singleton
 
 	# Bail out if there is no backend configured.
@@ -30,7 +37,7 @@ def self.Provider(klass, &block)
 			klass.extend(Singleton)
 
 			provider = klass.metrics_provider
-			provider.extend(Backend::Interface)
+			provider.extend(Deprecated)
 
 			klass.prepend(provider)
 

diff --git a/test/metrics.rb b/test/metrics.rb
@@ -15,7 +15,7 @@ def my_method(argument)
 end
 
 Metrics::Provider(MyClass) do
-	MYCLASS_CALL_COUNT = metric('my_class.call', :counter, description: 'Call counter.')
+	MYCLASS_CALL_COUNT = Metrics.metric('my_class.call', :counter, description: 'Call counter.')
 
 	def my_method(argument)
 		MYCLASS_CALL_COUNT.emit(1, tags: ["foo", "bar"])

diff --git a/test/metrics/backend/.capture/app.rb b/test/metrics/backend/.capture/app.rb
@@ -9,7 +9,7 @@ def call
 end
 
 Metrics::Provider(App) do
-	MY_METRIC = metric(:my_metric, :gauge, description: "My metric", unit: "seconds")
+	MY_METRIC = Metrics.metric(:my_metric, :gauge, description: "My metric", unit: "seconds")
 
 	def call
 		MY_METRIC.emit(1, tags: ['environment:test'])