Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,18 @@ issues caused by forking. If you detect something wrong, you can
call `Process.exit`, and this mold won't be used, another one will be
spawned later. e.g. you can check `Socket.getaddrinfo` still works, etc.


### `after_child_ready`

Called by the monitor process when a worker, service or mold reports
ready. Outdated molds discarded by the monitor don't trigger it.

```ruby
after_child_ready do |server, child|
server.logger.info("#{child.to_log} ready")
end
```

### `after_worker_fork`

```ruby
Expand Down
4 changes: 3 additions & 1 deletion lib/pitchfork/children.rb
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,9 @@ def fetch(pid)
def update(message)
case message
when Message::MoldSpawned
mold = Worker.new(nil)
# The initial mold PID is already known
# but for subsequent ones, we had no record of it.
mold = @children[message.pid] || Worker.new(nil)
mold.update(message)
@pending_molds[mold.pid] = mold
@children[mold.pid] = mold
Expand Down
5 changes: 5 additions & 0 deletions lib/pitchfork/configurator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ class Configurator
:before_fork => nil,
:after_worker_fork => nil,
:after_mold_fork => nil,
:after_child_ready => nil,
:before_worker_exit => nil,
:after_worker_exit => lambda { |server, worker, status|
m = if worker.nil?
Expand Down Expand Up @@ -155,6 +156,10 @@ def after_monitor_ready(*args, &block)
set_hook(:after_monitor_ready, block_given? ? block : args[0], 1)
end

def after_child_ready(*args, &block)
set_hook(:after_child_ready, block_given? ? block : args[0])
end

def after_worker_timeout(*args, &block)
set_hook(:after_worker_timeout, block_given? ? block : args[0], 3)
end
Expand Down
9 changes: 7 additions & 2 deletions lib/pitchfork/http_server.rb
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def extend_deadline(extra_time)
:listener_opts, :children, :poller,
:orig_app, :config, :ready_pipe, :early_hints, :setpgid, :restart_command, :restart_command_argv, :working_directory
attr_writer :after_worker_exit, :before_worker_exit, :after_worker_ready, :after_request_complete,
:refork_condition, :after_worker_timeout, :after_worker_hard_timeout, :after_monitor_ready, :refork_max_unavailable,
:refork_condition, :after_worker_timeout, :after_worker_hard_timeout, :after_monitor_ready, :after_child_ready, :refork_max_unavailable,
:max_consecutive_spawn_errors

attr_reader :logger, :version
Expand Down Expand Up @@ -233,7 +233,9 @@ def start(sync = true)
else
build_app!
SharedMemory.current_version = @version
after_mold_fork&.call(self, Worker.new(nil, pid: $$).promoted!(@spawn_timeout))
mold = Worker.new(nil, pid: $$).promoted!(@spawn_timeout)
after_mold_fork&.call(self, mold)
safe_run_callback(@after_child_ready, "after_child_ready", self, mold)
end

if sync
Expand Down Expand Up @@ -449,9 +451,12 @@ def monitor_handle_message(message)
mold.soft_kill(:TERM)
end
end
safe_run_callback(@after_child_ready, "after_child_ready", self, new_mold)
end
when Message::WorkerReady, Message::ServiceReady
@consecutive_spawn_errors = 0
child = @children.fetch(message.pid) rescue nil
safe_run_callback(@after_child_ready, "after_child_ready", self, child) if child
else
logger.error("Unexpected message in sig_queue #{message.inspect}")
end
Expand Down
5 changes: 4 additions & 1 deletion lib/pitchfork/worker.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class Worker
# :stopdoc:
EXIT_SIGNALS = [:QUIT, :TERM]
attr_accessor :nr, :pid, :generation, :version
attr_reader :monitor, :requests_count
attr_reader :monitor, :requests_count, :spawned_at

class << self
def load(data)
Expand All @@ -34,6 +34,7 @@ def initialize(nr, pid: nil, generation: 0, version: 0, service: false)
@monitor = nil
@exiting = false
@requests_count = 0
@spawned_at = Pitchfork.time_now

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We just experimented with this in production, it works well for workers, but for molds the timing seem very off, I'll try to figure it out.

if nr
@state_drop = SharedMemory.worker_state(@nr)
elsif service?
Expand All @@ -56,6 +57,7 @@ def init_with(data)
@monitor = fd ? MessageSocket.for_fd(fd) : nil
@exiting = data.fetch(:exiting)
@requests_count = data.fetch(:requests_count)
@spawned_at = data.fetch(:spawned_at, 0)

@state_drop = if @nr
SharedMemory.worker_state(@nr)
Expand Down Expand Up @@ -84,6 +86,7 @@ def dump
monitor_fd: @monitor&.fileno,
exiting: exiting?,
requests_count: requests_count,
spawned_at: spawned_at,
}
end

Expand Down
1 change: 1 addition & 0 deletions test/integration/test_boot.rb
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ def server.murder_lazy_workers

abandoned_worker_pid = read_stderr.match(/worker=0 gen=0.0 pid=(\d+) spawned but slot is taken/)[1]
assert_stderr(/reaped unknown subprocess .* pid #{abandoned_worker_pid} exit 0/)
refute_stderr(/monitor loop error/)

assert_clean_shutdown(pid)
end
Expand Down
20 changes: 18 additions & 2 deletions test/unit/test_children.rb
Original file line number Diff line number Diff line change
Expand Up @@ -261,8 +261,8 @@ def test_dump_load
assert_equal [worker], @children.workers

pipe = Pitchfork.socketpair.last
@children.update(Message::MoldSpawned.new(nil, 42, 1, 0, pipe))
@children.update(Message::MoldReady.new(42))
@children.update(Message::MoldSpawned.new(nil, 44, 1, 0, pipe))
@children.update(Message::MoldReady.new(44))

assert_not_nil @children.mold
@children = assert_roundtrip(@children)
Expand All @@ -277,6 +277,22 @@ def test_dump_load
assert_not_nil @children.service
end

def test_mold_ready_spawned_at_preserved
pipe = Pitchfork.socketpair.last

mold = Worker.new(nil, pid: 42) # Initial mold pid is known
spawned_at = mold.spawned_at
@children.register_mold(mold)

returned_mold = @children.update(Message::MoldSpawned.new(nil, 42, 0, 0, pipe))
assert_same mold, returned_mold
assert_same spawned_at, returned_mold.spawned_at

returned_mold = @children.update(Message::MoldReady.new(42))
assert_same mold, returned_mold
assert_same spawned_at, returned_mold.spawned_at
end

private

def assert_roundtrip(children)
Expand Down
1 change: 1 addition & 0 deletions test/unit/test_worker.rb
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ def test_dump_load
mold: false,
mold_ready: false,
service: false,
spawned_at: worker.spawned_at,
nr: 2,
pid: 1234,
requests_count: 0,
Expand Down
Loading