async-utilization 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2494a3f35fcbfd987fe6520ceda64225ccc6592ebe4072f0260f38a430d0d3fc
-  data.tar.gz: '0668665f31e13ac0d00c5eded51ad94f7f394927318e05ef83f7a5cd818e22e3'
+  metadata.gz: 522f4b5822343c23f14422555147e2159e2bac50afbd230a06e985e2cfe1cee4
+  data.tar.gz: caa61db8daf6f65a77e319a210ee0079f9a647deed614e7cc5333507967964fa
 SHA512:
-  metadata.gz: 863148a136e0a8696c337c5c24e18f8751bea2b586f1a703235992103c5454d1621d9296c401ded2d75aa532255beab3ae7ee2ad84211a8eb3b9971aac7b5fc8
-  data.tar.gz: 4a6e0ee78558c67dd2f8c5e8bb284c0aaed26cb23a3df700b451841a8081dafd9973ff2ef033f7f137cae4e657b60eae29cfeca89a8edd7ca3233f46a7318ce5
+  metadata.gz: ebaabb2e0959e3664e4e2a18812d71efa75d967a2fb01a89f8d63af02eb9e36bc564edfc50c7315b4efbbe8ee5f60e865250cb660daa274fa185e6a538994f6c
+  data.tar.gz: 7760f55b1383998120a3f7bf0b65b578c8da04bf648c0407f6b3e57040edec2b1487b82356f6d11eaf3bdb02cab9ddc8797eb3c8ee67c930a03d35fec08a5e60

data/lib/async/utilization/metric.rb

@@ -38,11 +38,14 @@ module Async
 			# @attribute [Symbol] The field name for this metric.
 			attr :name
 			
-			# @attribute [Numeric] The current value of this metric.
-			attr :value
-			
-			# @attribute [Mutex] The mutex for thread safety.
-			attr :guard
+			# Get the current in-memory metric value.
+			#
+			# @returns [Numeric] The last value written to this metric.
+			def value
+				@guard.synchronize do
+					@value
+				end
+			end
 			
 			# Set the observer and rebuild cache.
 			#

data/lib/async/utilization/namespace.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+module Async
+	module Utilization
+		# A registry-like view that prefixes metric names.
+		#
+		# Namespaces let components use generic metric names while applications decide
+		# how those names are composed in the shared registry.
+		class Namespace
+			# Initialize a new namespace.
+			#
+			# @parameter registry [Registry] The underlying registry.
+			# @parameter name [Symbol] The namespace name.
+			def initialize(registry, name)
+				@registry = registry
+				@name = name.to_sym
+			end
+			
+			# @attribute [Registry] The underlying registry.
+			attr :registry
+			
+			# @attribute [Symbol] The namespace name.
+			attr :name
+			
+			# Get a metric in this namespace.
+			#
+			# @parameter name [Symbol] The metric name.
+			# @returns [Metric] A metric instance for the namespaced field.
+			def metric(name)
+				@registry.metric(metric_name(name))
+			end
+			
+			# Get a nested namespace.
+			#
+			# @parameter name [Symbol] The nested namespace name.
+			# @returns [Namespace] A namespace view with the composed name.
+			def namespace(name)
+				self.class.new(@registry, metric_name(name))
+			end
+			
+			private
+			
+			def metric_name(name)
+				:"#{@name}_#{name}"
+			end
+		end
+	end
+end

data/lib/async/utilization/registry.rb

@@ -4,6 +4,7 @@
 # Copyright, 2026, by Samuel Williams.
 
 require "console"
+require_relative "namespace"
 
 module Async
 	module Utilization
@@ -22,9 +23,11 @@ module Async
 		# @example Create a registry and emit metrics:
 		# 	registry = Async::Utilization::Registry.new
 		# 	
-		# 	# Emit metrics - values tracked in registry
-		# 	registry.increment(:total_requests)
-		# 	registry.track(:active_requests) do
+		# 	total_requests = registry.metric(:total_requests)
+		# 	total_requests.increment
+		# 	
+		# 	active_requests = registry.metric(:active_requests)
+		# 	active_requests.track do
 		# 		# Handle request - auto-decrements when block completes
 		# 	end
 		# 	
@@ -37,7 +40,6 @@ module Async
 		# 	observer = Async::Utilization::Observer.open(schema, "/path/to/shm", 4096, 0)
 		# 	registry.observer = observer
 		class Registry
-			
 			# Initialize a new registry.
 			def initialize
 				@observer = nil
@@ -49,15 +51,12 @@ module Async
 			# @attribute [Object | Nil] The registered observer.
 			attr :observer
 			
-			# @attribute [Mutex] The mutex for thread safety.
-			attr :guard
-			
 			# Get the current values for all metrics.
 			#
 			# @returns [Hash] Hash mapping field names to their current values.
 			def values
 				@metrics.transform_values do |metric|
-					metric.guard.synchronize{metric.value}
+					metric.value
 				end
 			end
 			
@@ -79,48 +78,6 @@ module Async
 					
 					# Console.info(self, "Observer assigned", observer: observer, metric_count: @metrics.size)
 				end
-				
-			end
-			
-			# Set a field value.
-			#
-			# Delegates to the metric instance for the given field.
-			#
-			# @parameter field [Symbol] The field name to set.
-			# @parameter value [Numeric] The value to set.
-			def set(field, value)
-				metric(field).set(value)
-			end
-			
-			# Increment a field value.
-			#
-			# Delegates to the metric instance for the given field.
-			#
-			# @parameter field [Symbol] The field name to increment.
-			# @returns [Integer] The new value of the field.
-			def increment(field)
-				metric(field).increment
-			end
-			
-			# Track an operation: increment before the block, decrement after it completes.
-			#
-			# Delegates to the metric instance for the given field.
-			#
-			# @parameter field [Symbol] The field name to track.
-			# @yield The operation to track.
-			# @returns [Object] The block's return value.
-			def track(field, &block)
-				metric(field).track(&block)
-			end
-			
-			# Decrement a field value.
-			#
-			# Delegates to the metric instance for the given field.
-			#
-			# @parameter field [Symbol] The field name to decrement.
-			# @returns [Integer] The new value of the field.
-			def decrement(field)
-				metric(field).decrement
 			end
 			
 			# Get a cached metric reference for a field.
@@ -137,6 +94,14 @@ module Async
 					@metrics[field] ||= Metric.for(field, @observer)
 				end
 			end
+			
+			# Get a namespace view of this registry.
+			#
+			# @parameter name [Symbol] The namespace name.
+			# @returns [Namespace] A registry-like namespace view.
+			def namespace(name)
+				Namespace.new(self, name)
+			end
 		end
 	end
 end

data/lib/async/utilization/version.rb

@@ -7,6 +7,6 @@
 module Async
 	# @namespace
 	module Utilization
-		VERSION = "0.3.2"
+		VERSION = "0.4.0"
 	end
 end

data/lib/async/utilization.rb

@@ -5,6 +5,7 @@
 
 require_relative "utilization/version"
 require_relative "utilization/schema"
+require_relative "utilization/namespace"
 require_relative "utilization/registry"
 require_relative "utilization/observer"
 require_relative "utilization/metric"

data/readme.md

@@ -14,6 +14,11 @@ Please see the [project documentation](https://socketry.github.io/async-utilizat
 
 Please see the [project releases](https://socketry.github.io/async-utilization/releases/index) for all releases.
 
+### v0.4.0
+
+  - Add `Async::Utilization::Namespace` for composing registry metric names.
+  - `Async::Utilization::Metric` is the primary interface, remove `#set`, `#increment`, `#decrement` and `#track` from `Registry`.
+
 ### v0.3.2
 
   - Better observer state handling.
@@ -40,6 +45,22 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
 ### Developer Certificate of Origin
 
 In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.

data/releases.md

@@ -1,5 +1,10 @@
 # Releases
 
+## v0.4.0
+
+  - Add `Async::Utilization::Namespace` for composing registry metric names.
+  - `Async::Utilization::Metric` is the primary interface, remove `#set`, `#increment`, `#decrement` and `#track` from `Registry`.
+
 ## v0.3.2
 
   - Better observer state handling.

data/test/async/utilization/namespace.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require "sus"
+require "async/utilization"
+
+describe Async::Utilization::Namespace do
+	let(:registry) {Async::Utilization::Registry.new}
+	let(:namespace) {registry.namespace(:socket_accept)}
+	
+	it "uses namespaced metric names" do
+		metric = namespace.metric(:acquired_count)
+		
+		expect(metric).to be_a(Async::Utilization::Metric)
+		expect(metric.name).to be == :socket_accept_acquired_count
+		
+		metric.set(2)
+		expect(registry.values).to have_keys(socket_accept_acquired_count: be == 2)
+	end
+	
+	it "returns the same metric instance for the same namespaced field" do
+		metric1 = namespace.metric(:waiting_count)
+		metric2 = namespace.metric(:waiting_count)
+		
+		expect(metric1).to be == metric2
+	end
+	
+	it "supports nested namespaces" do
+		metric = namespace.namespace(:long_task).metric(:waiting_count)
+		
+		expect(metric.name).to be == :socket_accept_long_task_waiting_count
+		
+		metric.increment
+		expect(registry.values).to have_keys(socket_accept_long_task_waiting_count: be == 1)
+	end
+	
+	it "writes namespaced metrics to an observer" do
+		schema = Async::Utilization::Schema.build(socket_accept_acquired_count: :u64)
+		buffer = IO::Buffer.new(8)
+		
+		observer = Object.new
+		observer.define_singleton_method(:schema){schema}
+		observer.define_singleton_method(:buffer){buffer}
+		
+		registry.observer = observer
+		
+		namespace.metric(:acquired_count).set(5)
+		
+		expect(buffer.get_value(:u64, 0)).to be == 5
+	end
+end

data/test/async/utilization/registry.rb

@@ -8,37 +8,38 @@ require "async/utilization"
 
 describe Async::Utilization::Registry do
 	let(:registry) {Async::Utilization::Registry.new}
+	let(:test_field_metric) {registry.metric(:test_field)}
 	
 	it "can increment a value" do
-		value = registry.increment(:test_field)
+		value = test_field_metric.increment
 		expect(value).to be == 1
 		expect(registry.values[:test_field]).to be == 1
 	end
 	
 	it "can increment multiple times" do
-		registry.increment(:test_field)
-		registry.increment(:test_field)
-		registry.increment(:test_field)
+		test_field_metric.increment
+		test_field_metric.increment
+		test_field_metric.increment
 		
 		expect(registry.values[:test_field]).to be == 3
 	end
 	
 	it "can decrement a value" do
-		registry.increment(:test_field)
-		registry.increment(:test_field)
+		test_field_metric.increment
+		test_field_metric.increment
 		
-		value = registry.decrement(:test_field)
+		value = test_field_metric.decrement
 		expect(value).to be == 1
 		expect(registry.values[:test_field]).to be == 1
 	end
 	
 	it "can set a value directly" do
-		registry.set(:test_field, 42)
+		test_field_metric.set(42)
 		expect(registry.values[:test_field]).to be == 42
 	end
 	
 	it "can track an operation with auto-decrement" do
-		registry.track(:test_field) do
+		test_field_metric.track do
 			expect(registry.values[:test_field]).to be == 1
 		end
 		
@@ -47,7 +48,7 @@ describe Async::Utilization::Registry do
 	
 	it "decrements even if track block raises an error" do
 		begin
-			registry.track(:test_field) do
+			test_field_metric.track do
 				raise "Error!"
 			end
 		rescue
@@ -64,13 +65,13 @@ describe Async::Utilization::Registry do
 		observer.define_singleton_method(:schema){schema}
 		observer.define_singleton_method(:buffer){buffer}
 		
-		registry.set(:test_field, 5)
+		test_field_metric.set(5)
 		registry.observer = observer
 		
 		# Buffer should be synced with the existing value on observer assignment
 		expect(buffer.get_value(:u64, 0)).to be == 5
 		
-		registry.increment(:test_field)
+		test_field_metric.increment
 		
 		# Buffer should reflect the incremented value
 		expect(buffer.get_value(:u64, 0)).to be == 6
@@ -83,6 +84,14 @@ describe Async::Utilization::Registry do
 		expect(registry.values).to have_keys(module_test: be == 2)
 	end
 	
+	it "can create a namespace" do
+		namespace = registry.namespace(:socket_accept)
+		
+		expect(namespace).to be_a(Async::Utilization::Namespace)
+		expect(namespace.registry).to be == registry
+		expect(namespace.name).to be == :socket_accept
+	end
+	
 	it "can use metric for decrement" do
 		registry.metric(:module_decrement_test).increment
 		registry.metric(:module_decrement_test).increment
@@ -104,7 +113,7 @@ describe Async::Utilization::Registry do
 		observer.define_singleton_method(:schema){schema}
 		observer.define_singleton_method(:buffer){buffer}
 		
-		registry.set(:test_field, 7)
+		test_field_metric.set(7)
 		registry.observer = observer
 		
 		expect(buffer.get_value(:u64, 0)).to be == 7
@@ -118,11 +127,11 @@ describe Async::Utilization::Registry do
 		observer.define_singleton_method(:buffer){buffer}
 		
 		registry.observer = observer
-		registry.set(:test_field, 5)
+		test_field_metric.set(5)
 		expect(buffer.get_value(:u64, 0)).to be == 5
 		
 		registry.observer = nil
-		registry.set(:test_field, 99)
+		test_field_metric.set(99)
 		
 		# Buffer unchanged, in-memory value updated
 		expect(buffer.get_value(:u64, 0)).to be == 5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-utilization
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -58,6 +58,7 @@ extra_rdoc_files: []
 files:
 - lib/async/utilization.rb
 - lib/async/utilization/metric.rb
+- lib/async/utilization/namespace.rb
 - lib/async/utilization/observer.rb
 - lib/async/utilization/registry.rb
 - lib/async/utilization/schema.rb
@@ -67,6 +68,7 @@ files:
 - releases.md
 - test/async/utilization.rb
 - test/async/utilization/metric.rb
+- test/async/utilization/namespace.rb
 - test/async/utilization/observer.rb
 - test/async/utilization/registry.rb
 - test/async/utilization/schema.rb
@@ -90,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: High-performance utilization metrics for Async services using shared memory.
 test_files: []