Skip to main content

Function: startProbeListener()

startProbeListener(registry, options): Promise<ProbeListener>

Defined in: packages/common/src/health.ts:173

Serves the three health paths for services that listen on NATS only, bound to the loopback interface INSIDE the container. Nothing on the network can reach it, so it is not an ingress; the container healthcheck (or a Kubernetes exec probe) runs bin/probe.ts in the container against it.

Parameters​

registry​

HealthRegistry

options​

ProbeListenerOptions

Returns​

Promise<ProbeListener>

Throws​

If host is not a loopback address. Binding wider would turn an unauthenticated endpoint into an ingress, so the type rejects it and so does the runtime, for callers that cast.