load balancer fleet status

This block is part of the nginx group and was last modified in core v15.0.0.

load balancer fleet status condition v15.0.0

Ask every load balancer what it serves and whether the fleet agrees with itself. Reads only.

In pins 1 + flow

flow
flow
Load balancers required
array
Each {name, host, port, user, key_path, known_hosts_path}. Paths only : never key material.

Out pins 7 + flow

flow
flow
Success
condition
True when the fan-out itself could run.
Results
array
Per node: name, host, ok, nginx, sites, applied : or output/exit_code when unreachable.
Fleet in sync
condition
True only when every node answered, nginx is active everywhere, and all report identical state.
Sites
array
Union of the site names served across the fleet, sorted.
Reachable count
number
How many nodes answered with parseable status.
Node count
number
How many nodes were asked.
Error
value
Why the status could not run at all.

Asks every load balancer in the nodes list for its status (nginx active?, which sites, which applied-state stamp) and reports per node plus a fleet verdict. Reads only : nothing is written or reloaded. in_sync is deliberately strict: true only when every node answered, every nginx is active, and all nodes report the same applied stamp and the same site list. A node that cannot be reached makes the fleet out of sync by definition : 'two of three agree and the third is silent' is exactly the state a dashboard must show, not average away. sites is the union across nodes; per-node lists are in results. This is the read half the management dashboard builds its view on: list sites from here, edit a config, nginxsite_check it everywhere, nginxsite_push it, then read this again to confirm convergence.

nginx status

lb status

fleet status

A typical wiring for load balancer fleet status: a function trigger starts the flow; with values feeds the nodes pin; the flow out pin feeds debug.

Version history

Introduced in v15.0.0.

Back to nginx Return to the main group to view all sub-groups Back to Load balancers Return to the group to view all blocks within this group