async-container 0.22.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97b99976b04ac8d7725349a23176ff2ca94643a4e95c96b6ab566a957be437d7
-  data.tar.gz: ec7aa60548299430c13b14d6abee5df28ec383b48dafb7e60432574bd07dd6fb
+  metadata.gz: 45498b6ccc16a193e4562b68437909aa982613b11a3959608de293246edc1f31
+  data.tar.gz: fa3b269ba5e24b5500fb05409a6c5835127adf8cbda92bff54cc661358e10921
 SHA512:
-  metadata.gz: 8b44d6496b6b9fa16bc288ecc66f0ba0645a0b3301d2a32bf53fbf27f993803cba38b6da9208baa3ef6c14fececb9da65cda6ab8d8ae403aa04c666c4077c978
-  data.tar.gz: 61d79bd5e62d8b406ffe88aae129918b5ab7c3de779847e8295e6dff867fdc58573c68e7df7bee585b9b204c6150dd98bc82fc424c8c6643df7eedd9dbd11f7c
+  metadata.gz: 4481f2950cfacc074c010419ce3afaa785435df9066b072e4d514a7ea3319fd930242afb8ef0f3e40020d7674209d792a4a42059f1f44cdc3270669bca52ef7b
+  data.tar.gz: '018f892e9b7b9cd7703ce0b9e15a8eb689804563b8d691a676f51a0ad79b0d78681d34bca2c63da9e508c8b48dc617cb03dde3911af5271e42997a334dcf06bd'

data/lib/async/container/controller.rb

@@ -149,7 +149,7 @@ module Async
 					old_container&.stop(@graceful_stop)
 				end
 				
-				@notify&.ready!
+				@notify&.ready!(size: @container.size)
 			ensure
 				# If we are leaving this function with an exception, try to kill the container:
 				container&.stop(false)
@@ -185,7 +185,7 @@ module Async
 			
 			# Enter the controller run loop, trapping `SIGINT` and `SIGTERM`.
 			def run
-				@notify&.status!("Initializing...")
+				@notify&.status!("Initializing controller...")
 				
 				with_signal_handlers do
 					self.start

data/lib/async/container/generic.rb

@@ -51,6 +51,11 @@ module Async
 			# @attribute [Group] The group of running children instances.
 			attr :group
 			
+			# @returns [Integer] The number of running children instances.
+			def size
+				@group.size
+			end
+			
 			# @attribute [Hash(Child, Hash)] The state of each child instance.
 			attr :state
 			

data/lib/async/container/group.rb

@@ -32,6 +32,11 @@ module Async
 			# @attribute [Hash(IO, Fiber)] the running tasks, indexed by IO.
 			attr :running
 			
+			# @returns [Integer] The number of running processes.
+			def size
+				@running.size
+			end
+			
 			# Whether the group contains any running processes.
 			# @returns [Boolean]
 			def running?
@@ -175,7 +180,8 @@ module Async
 			protected
 			
 			def wait_for_children(duration = nil)
-				Console.debug(self, "Waiting for children...", duration: duration, running: @running)
+				# This log is a big noisy and doesn't really provide a lot of useful information.
+				# Console.debug(self, "Waiting for children...", duration: duration, running: @running)
 				
 				if !@running.empty?
 					# Maybe consider using a proper event loop here:

data/lib/async/container/notify/log.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require_relative "client"
+require "socket"
+
+module Async
+	module Container
+		module Notify
+			class Log < Client
+				# The name of the environment variable which contains the path to the notification socket.
+				NOTIFY_LOG = "NOTIFY_LOG"
+				
+				# Open a notification client attached to the current {NOTIFY_LOG} if possible.
+				def self.open!(environment = ENV)
+					if path = environment.delete(NOTIFY_LOG)
+						self.new(path)
+					end
+				end
+				
+				# Initialize the notification client.
+				# @parameter path [String] The path to the UNIX socket used for sending messages to the process manager.
+				def initialize(path)
+					@path = path
+				end
+				
+				# @attribute [String] The path to the UNIX socket used for sending messages to the controller.
+				attr :path
+				
+				# Send the given message.
+				# @parameter message [Hash]
+				def send(**message)
+					data = JSON.dump(message)
+					
+					File.open(@path, "a") do |file|
+						file.puts(data)
+					end
+				end
+				
+				# Send the specified error.
+				# `sd_notify` requires an `errno` key, which defaults to `-1` to indicate a generic error.
+				def error!(text, **message)
+					message[:errno] ||= -1
+					
+					super
+				end
+			end
+		end
+	end
+end

data/lib/async/container/notify/server.rb

@@ -5,6 +5,7 @@
 # Copyright, 2020, by Olle Jonsson.
 
 require "tmpdir"
+require "socket"
 require "securerandom"
 
 module Async

data/lib/async/container/notify.rb

@@ -6,6 +6,7 @@
 require_relative "notify/pipe"
 require_relative "notify/socket"
 require_relative "notify/console"
+require_relative "notify/log"
 
 module Async
 	module Container
@@ -18,6 +19,7 @@ module Async
 				@client ||= (
 					Pipe.open! ||
 					Socket.open! ||
+					Log.open! ||
 					Console.open!
 				)
 			end

data/lib/async/container/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Container
-		VERSION = "0.22.0"
+		VERSION = "0.23.1"
 	end
 end

data/readme.md

@@ -22,6 +22,10 @@ Please see the [project documentation](https://socketry.github.io/async-containe
 
 Please see the [project releases](https://socketry.github.io/async-container/releases/index) for all releases.
 
+### v0.23.0
+
+  - [Add support for `NOTIFY_LOG` for Kubernetes readiness probes.](https://socketry.github.io/async-container/releases/index#add-support-for-notify_log-for-kubernetes-readiness-probes.)
+
 ### v0.21.0
 
   - Use `SIGKILL`/`Thread#kill` when the health check fails. In some cases, `SIGTERM` may not be sufficient to terminate a process because the signal can be ignored or the process may be in an uninterruptible state.

data/releases.md

@@ -1,5 +1,26 @@
 # Releases
 
+## v0.23.0
+
+### Add support for `NOTIFY_LOG` for Kubernetes readiness probes.
+
+You may specify a `NOTIFY_LOG` environment variable to enable readiness logging to a log file. This can be used for Kubernetes readiness probes, e.g.
+
+``` yaml
+containers:
+	- name: falcon
+		env:
+			- name: NOTIFY_LOG
+				value: "/tmp/notify.log"
+		command: ["falcon", "host"]
+		readinessProbe:
+			exec:
+				command: ["sh", "-c", "grep -q '\"ready\":true' /tmp/notify.log"]
+			initialDelaySeconds: 5
+			periodSeconds: 5
+			failureThreshold: 12
+```
+
 ## v0.21.0
 
   - Use `SIGKILL`/`Thread#kill` when the health check fails. In some cases, `SIGTERM` may not be sufficient to terminate a process because the signal can be ignored or the process may be in an uninterruptible state.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-container
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -73,6 +73,7 @@ files:
 - lib/async/container/notify.rb
 - lib/async/container/notify/client.rb
 - lib/async/container/notify/console.rb
+- lib/async/container/notify/log.rb
 - lib/async/container/notify/pipe.rb
 - lib/async/container/notify/server.rb
 - lib/async/container/notify/socket.rb