dispergo

PRIVATE ALPHA

Runtime server module

Configure the operational listener, control API, health endpoints and shutdown lifecycle.

server

output.http.listener serves media and viewer routes. The runtime listener is configured under server.operational and is usually on the same host with a different port.

FieldDefaultPurpose
server.operational.hostmedia listener hostBind address for API, health and metrics.
server.operational.port9091Must not overlap output.http.listener.
server.shutdownTimeout10sUpper bound on graceful shutdown.

The operational listener has no application authentication. Keep it on a trusted network. Enabled routes can start pulls, start pushes and stop streams.

API and health

Method and pathPurpose
GET /livezShallow process liveness.
GET /readyzWhether the node can accept new traffic.
GET /metricsLow-cardinality Prometheus metrics.
GET /api/v1/streamsActive stream list.
GET /api/v1/streams/{streamId}Identity, tracks, health and module state.
DELETE /api/v1/streams/{streamId}Stop an eligible active stream.
GET /api/v1/capacityAdvisory resource and worker snapshot.
GET /api/v1/pullsManaged source-pull list.
GET, PUT, DELETE /api/v1/pulls/{streamId}One managed source-pull lifecycle.
GET /api/v1/pushesOutbound SRT push list.
GET, PUT, DELETE /api/v1/pushes/{pushId}One outbound push lifecycle.

Path identifiers are URL-encoded. Sensitive request data is never added to metric labels.

Wall-clock provenance

In GET /api/v1/streams/{streamId}, the stream-detail wallClockProvenance field reports the time source of the node-local active mapping as source, cascade, or server, and is omitted rather than null until the current epoch has a mapping.

source means an explicit UTC-to-media correlation accepted directly from an external source. PCR, PTS, or DTS alone does not establish source. cascade means a usable anchor received from an upstream dispergo node, whether that upstream node used source or its own server fallback. server means the current node's local clock fallback.

The same contract applies to local push, managed source pull, and cascade input, including nodes with no local output or only cascade output. A later accepted usable upstream anchor can change server to cascade in the same epoch. Reset, reconnect, or generation replacement withdraws the old value; the field remains omitted until the new mapping exists. Reading this field never creates a mapping or samples the clock. Clients that accepted legacy origin, source, and edge values must migrate: this is a contract change, not a string rename.

Configuration reference

The configuration document rules apply to every runtime module. The complete field reference covers every accepted option; the maximal composition shows how modules fit together.

Runtime overviewTranscode