async-service-supervisor 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acb581fece1b2ca0364e8b7f3fee2893c15d788f022377c23ba810a71276beb7
-  data.tar.gz: 68d38aa49e35ef1c63e6f214ff271daca6650dfa5bffb1d628eb0f429b5d6219
+  metadata.gz: 5d6f60f666c3e162c85ca9a275a74dd74dc2219230950d18a0ecf08cffa5761a
+  data.tar.gz: 2c78c20413ca658e6f2341999bfe42fc1600028978ab134ea10f0b0bed5ac44c
 SHA512:
-  metadata.gz: b46f7d61a4ec984478e0fbc062ebb14dc48899a2c004dc23c1446a69f2d095e5614f4eb6fedc0a7d6f264318ea84ce2f12a69b99bff643c18b0b2ef35b13fa8d
-  data.tar.gz: a836860985fc1753ca0b116a9d929562c8b24fd9ba474043c178e2dfa26dd59caf64106ce96a3b508762560c88d5ea39fb74f72d63559f91fab425e79c1869e1
+  metadata.gz: c4f862fdaeef651d0b736381340277720b987ac70a3f2e32481a636c638a251f30f5340da9f9789938eb4c7e25b9188b1e3f83c86ae0846f2620d23c9e69365f
+  data.tar.gz: 59291a5fe82bd9dbd2b42ef041b2cde87648666c787c99c90725b88576c0484e759c11fdd6a23ce8d58ce4666f6d21e9258065a2af870f040ab74cbccf15d50a

data/lib/async/service/supervisor/monitor.rb

@@ -8,11 +8,20 @@ require "async/loop"
 module Async
 	module Service
 		module Supervisor
+			# Base class for supervisor monitors that run periodically within the supervisor process.
+			#
+			# Subclasses should override {#run_once} to implement specific monitoring logic.
 			class Monitor
+				# Initialize a new monitor.
+				#
+				# @parameter interval [Numeric] The interval in seconds between each invocation of {#run_once}.
 				def initialize(interval: 1.0)
 					@interval = interval
 				end
 				
+				# Serialize the monitor state for JSON representation.
+				#
+				# @returns [Hash] An empty hash by default; subclasses should override to include relevant state.
 				def as_json(...)
 					{}
 				end

data/lib/async/service/supervisor/process_monitor.rb

@@ -67,15 +67,20 @@ module Async
 					{ppid: @ppid, metrics: self.metrics}
 				end
 				
-				# Run one iteration of the process monitor.
-				def run_once
-					metrics = self.metrics
-					
+				# Emit the process metrics.
+				#
+				# @parameter metrics [Hash] The process metrics to emit.
+				def emit(metrics)
 					# Log each process individually for better searchability in log platforms:
 					metrics.each do |process_id, general|
 						Console.info(self, "Process metrics captured.", general: general)
 					end
 				end
+				
+				# Run one iteration of the process monitor.
+				def run_once
+					self.emit(self.metrics)
+				end
 			end
 		end
 	end

data/lib/async/service/supervisor/version.rb

@@ -9,7 +9,7 @@ module Async
 	module Service
 		# @namespace
 		module Supervisor
-			VERSION = "0.15.0"
+			VERSION = "0.16.0"
 		end
 	end
 end

data/readme.md

@@ -28,6 +28,10 @@ Please see the [project documentation](https://socketry.github.io/async-service-
 
 Please see the [project releases](https://socketry.github.io/async-service-supervisor/releases/index) for all releases.
 
+### v0.16.0
+
+  - Add `ProcessMonitor#emit(metrics)` as an override point for subclasses to consume captured process metrics (e.g. emitting StatsD gauges).
+
 ### v0.15.0
 
   - Improve robustness and error handling of default monitors and server loop, ensuring that monitor failures either completely crash the server or retry appropriately, rather than leaving the server in a broken state.
@@ -72,11 +76,6 @@ Please see the [project releases](https://socketry.github.io/async-service-super
   - Disable memory sampler by default and use text output format.
       - Introduce support for redirecting dump output to logs.
 
-### v0.8.0
-
-  - Add `Async::Service::Supervisor::ProcessMonitor` for logging CPU and memory metrics periodically.
-  - Fix documentation to use correct `maximum_size_limit:` parameter name for `MemoryMonitor` (was incorrectly documented as `limit:`).
-
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.16.0
+
+  - Add `ProcessMonitor#emit(metrics)` as an override point for subclasses to consume captured process metrics (e.g. emitting StatsD gauges).
+
 ## v0.15.0
 
   - Improve robustness and error handling of default monitors and server loop, ensuring that monitor failures either completely crash the server or retry appropriately, rather than leaving the server in a broken state.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-service-supervisor
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Samuel Williams