async-pool 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb369c01748a2f2c555a8549a2280c1e39b30a3c7f7918e4e426a79d7eec41ce
-  data.tar.gz: 5b8d9ac62de382ce06753d04512708cca9c969c7eaf368a1f7b88fa12b6d1eae
+  metadata.gz: 958468bc2e159bc6304f603d522ccc08fe967469bd463a992484f237e880ddf3
+  data.tar.gz: 2fcd90d3589cb71a9395b0e9b9810dc860bda4971c538e754d7a4113e1628ff0
 SHA512:
-  metadata.gz: b18bfe389d25644da07f2e8f85bd92891f7066e1c9b67d6ed91e9a9de1e8d47bcaf4e612c7388619a8693c2f6ee2fc85a09f0cada7647f53a2de5714dbaac30a
-  data.tar.gz: 0bb8ca350d3942057cfcc91ff957382512ee0e1e012e20344ba71b6bf09df7a353c65d4996341fc8407d99629a8286346a6412a4e6bc6a0199dcaf67e11d069f
+  metadata.gz: 5a03eb3421cd11bc52ec995ddadd67c9e717763a69dbed5d8d27248f0b93ec9e824765eef5a8d02719968fc20f974d4b7690ec8a1e66fa6cc5d103f95f56ce0d
+  data.tar.gz: f4f19064995d171e013e5d80c90343387c733e9f13a4acd846c1534aee573ff7f75c5d3d41907919bdd83ff09bd1112e6a9d7f063ed66e4e072e91648220ae2b

data/lib/async/pool/controller.rb

@@ -5,11 +5,14 @@
 # Copyright, 2020, by Simon Perepelitsa.
 # Copyright, 2024, by Thomas Morgan.
 
-require 'console/logger'
+require "console/logger"
 
-require 'async'
-require 'async/notification'
-require 'async/semaphore'
+require "async"
+require "async/notification"
+require "async/semaphore"
+
+require "traces"
+require "metrics"
 
 module Async
 	module Pool
@@ -26,7 +29,7 @@ module Async
 			# @parameter limit [Integer | Nil] The maximum number of resources that this pool can have at any given time. If nil, the pool can have an unlimited number of resources.
 			# @parameter concurrency [Integer] The maximum number of concurrent tasks that can be creating a new resource.
 			# @parameter policy [Policy] The pool policy.
-			def initialize(constructor, limit: nil, concurrency: (limit || 1), policy: nil)
+			def initialize(constructor, limit: nil, concurrency: (limit || 1), policy: nil, tags: nil)
 				@constructor = constructor
 				@limit = limit
 				
@@ -36,6 +39,8 @@ module Async
 				@policy = policy
 				@gardener = nil
 				
+				@tags = Metrics::Tags.normalize(tags)
+				
 				# All available resources:
 				@resources = {}
 				
@@ -93,6 +98,9 @@ module Async
 			# @attribute [Hash(Resource, Integer)] all allocated resources, and their associated usage.
 			attr :resources
 			
+			# @attribute [Array(String)] The name of the pool.
+			attr_accessor :tags
+			
 			# The number of resources in the pool.
 			def size
 				@resources.size
@@ -154,7 +162,9 @@ module Async
 				retire(resource) unless processed
 			end
 			
-			private def drain
+			def drain
+				Console.debug(self, "Draining pool...", size: @resources.size)
+				
 				# Enumerate all existing resources and retire them:
 				while resource = acquire_existing_resource
 					retire(resource)
@@ -262,6 +272,7 @@ module Async
 			
 			def reuse(resource)
 				Console.debug(self) {"Reuse #{resource}"}
+				
 				usage = @resources[resource]
 				
 				if usage.nil? || usage.zero?
@@ -286,11 +297,7 @@ module Async
 					@notification.wait
 				end
 				
-				Console.debug(self) {"Wait for resource -> #{resource}"}
-				
-				# if resource.concurrency > 1
-				# 	@notification.signal
-				# end
+				# Be careful not to context switch or fail here.
 				
 				return resource
 			end
@@ -318,12 +325,16 @@ module Async
 			def available_resource
 				resource = nil
 				
+				Console.debug(self, "Acquiring concurrency guard...", blocking: @guard.blocking?)
+				
 				@guard.acquire do
+					Console.debug(self, "Acquired concurrency guard.")
+					
 					resource = acquire_or_create_resource
 				end
 				
 				return resource
-			rescue Exception
+			rescue Exception => error
 				reuse(resource) if resource
 				raise
 			end
@@ -375,6 +386,52 @@ module Async
 					return create_resource
 				end
 			end
+			
+			Traces::Provider(self) do
+				def create_resource(...)
+					attributes = {
+						concurrency: @guard.limit,
+						size: @resources.size,
+						limit: @limit,
+						tags: @tags,
+					}
+					
+					Traces.trace("async.pool.create", attributes: attributes) {super}
+				end
+				
+				def drain(...)
+					attributes = {
+						size: @resources.size,
+						tags: @tags,
+					}
+					
+					Traces.trace("async.pool.drain", attributes: attributes) {super}
+				end
+			end
+			
+			Metrics::Provider(self) do
+				ACQUIRE_COUNT = Metrics.metric("async.pool.acquire", :counter, description: "Number of times a resource was invoked.")
+				RELEASE_COUNT = Metrics.metric("async.pool.release", :counter, description: "Number of times a resource was released.")
+				RETIRE_COUNT = Metrics.metric("async.pool.retire", :counter, description: "Number of times a resource was retired.")
+				
+				def acquire(...)
+					ACQUIRE_COUNT.emit(1, tags: @tags)
+					
+					super
+				end
+				
+				def release(...)
+					super.tap do
+						RELEASE_COUNT.emit(1, tags: @tags)
+					end
+				end
+				
+				def retire(...)
+					super.tap do
+						RETIRE_COUNT.emit(1, tags: @tags)
+					end
+				end
+			end
 		end
 	end
 end

data/lib/async/pool/resource.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'console/logger'
+require "console/logger"
 
-require 'async/notification'
-require 'async/semaphore'
+require "async/notification"
+require "async/semaphore"
 
 module Async
 	module Pool

data/lib/async/pool/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Pool
-		VERSION = "0.8.0"
+		VERSION = "0.9.0"
 	end
 end

data/lib/async/pool.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'pool/version'
-require_relative 'pool/controller'
+require_relative "pool/version"
+require_relative "pool/controller"
 
 # @namespace
 module Async

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-pool
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -56,6 +56,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: traces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables: []