Metrics

Norsk (and the underlying Erlang virtual machine) expose many metrics that are invaluable for building alerting and reporting dashboards. Internally, Norsk makes use of OpenTelemetry (https://opentelemetry.io) for the recording and gathering of these metrics, and currently makes them available for external systems through the Prometheus text format (https://prometheus.io), found at:

http://127.0.0.1:6791/metrics

(obviously change address and port if you are running norsk remotely and/or have changed the default startup configuration).

❯ curl  http://127.0.0.1:6791/metrics                                                                                                                                       ~/dev/norsk
# TYPE norsk_inbound_context_changes counter
# HELP norsk_inbound_context_changes Number of context changes processed
norsk_inbound_context_changes{mediaNodeClass="RTMP Source",mediaNodeId="rtmpInput",mediaNodeType="input",nodeClass="timestamp_corrector",telemetryId="timestamp_corrector_162_2",wfid="162"} 2
1684255580892
...

At current count, there are 85 different metrics logged - the above URL has help text for each one, so is the best place to explore. There is still work ongoing, particularly with regard to the labels applied to each metric - as that stablises, this page will be extended to document the details.