Skip to content

A heartbeat that blocks forever is never detected, unlike one that fails #808

Description

@julik

(Written by Claude on @julik's behalf)

Follow-up to #763, which I filed and which was closed as completed by #778. #778 fixes the case I could reproduce at the time; this is the neighbouring case, which I have now hit in production and which I believe is still open.

The distinction

#778 stops a process whose heartbeats keep failing:

def heartbeat
  process&.heartbeat
rescue ActiveRecord::RecordNotFound
  stop_to_be_replaced
rescue => error
  stop_to_be_replaced if presumed_dead?
  raise error
end

Both new paths hang off a raise. But a heartbeat can also never return at all, and then neither branch is reachable.

SolidQueue::Process#heartbeat does a real round-trip:

restore_attributes
with_lock { touch(:last_heartbeat_at) }

If the socket under that connection is half-open - the server process is alive enough for its kernel to keep the connection, but nothing is being served - the thread blocks in the driver indefinitely. No exception is raised, so presumed_dead? is never evaluated.

Why the timer does not save you

launch_heartbeat runs the heartbeat inside a Concurrent::TimerTask. In concurrent-ruby (checked against 1.3.7), execute_task is:

_success, value, reason = @task.execute(self)
if completion.try?
  self.value = value
  schedule_next_task(calculate_next_interval(start_time))
  ...
  observers.notify_observers { [time, self.value, reason] }

The reschedule and the observer notification both happen after the task returns. A run that never returns is never rescheduled and never reported - the heartbeat thread goes quiet permanently, having neither succeeded nor failed.

There is also no configuration escape: TimerTask#timeout_interval is now a no-op that warns "TimerTask timeouts are now ignored as these were not able to be implemented correctly".

The supervisor has the same property

This is the part I think is most worth looking at. Supervisor::Maintenance#launch_maintenance_task is also a Concurrent::TimerTask, running prune_dead_processes. So when a supervisor's maintenance run blocks on the same unresponsive database, pruning stops too - the mechanism meant to notice dead processes is built from the same material that just died.

Meanwhile supervise only calls check_and_replace_terminated_processes, so a forked child that blocks without exiting is never replaced. Between the three, a process can be alive, registered, holding claimed executions, and doing nothing whatsoever, with nothing in the system positioned to notice.

What it looked like in production

A PgBouncer instance in front of our Postgres froze without dying - process alive, event loop wedged, kernel holding every TCP connection half-open. Our scheduler's heartbeat thread blocked mid-with_lock and stayed there. The recurring scheduler runs in exactly one process, so all 33 recurring tasks stopped for 101 minutes and only came back on a manual redeploy. The supervisor never replaced the child; other supervisors pruned the process row but pruning sends no signal, so it kept claiming jobs and those claims later failed as ProcessMissingError.

Left alone, the sockets would have cleared on Linux's default 7200s keepalive - about 2h11m.

What actually fixed it for us, and why I am not sure it is your problem

Setting client-side socket bounds in database.yml:

keepalives: 1
keepalives_idle: 30
keepalives_interval: 10
keepalives_count: 3
tcp_user_timeout: 60000
connect_timeout: 5

tcp_user_timeout is the load-bearing one - TCP keepalive only probes a socket with no unacknowledged data in flight, which is the wrong half of the problem. With it, the block becomes a raise after ~60s, and #778's logic then engages exactly as designed.

So one defensible answer is "this is a libpq configuration problem, document it and close". I would understand that. What makes me file anyway:

  • The gap is invisible. An app with default database.yml has no socket bound, and nothing in SolidQueue's own supervision will notice, so the failure mode is a silent stop rather than a loud one.
  • It is not Postgres-specific. Any adapter whose socket can go quiet has the same shape.
  • The supervisor's maintenance task sharing the defect seems worth fixing regardless of what the app does with its sockets.

Possible directions

Not a proposal, just what seems available:

  1. Track the last time a heartbeat completed in memory, separately from last_heartbeat_at, and have the run loop stop the process when that goes older than process_alive_threshold. This is the only option that does not depend on the blocked thread itself.
  2. Have supervisors act on prunable children rather than only on exited ones - prune currently deletes the row and sends nothing.
  3. At minimum, README guidance on socket-level timeouts for the database connection, since without one nothing else here can engage.

Happy to have a go at (1) if you think it is the right shape.

Refs

Versions: solid_queue 1.6.0, concurrent-ruby 1.3.7, Ruby 3.4.2, PostgreSQL via PgBouncer in transaction mode.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions