Signal metrics

The Signal service brokers WireGuard handshake messages between peers. Its metrics describe peer connectivity, message forwarding, and the gRPC server itself.

Endpoint

SettingDefault
Address0.0.0.0
Port9090
Path/metrics
Flag--metrics-port
netbird-signal run --metrics-port 9090

In the combined container, the metrics port is set with server.metricsPort in config.yaml and is shared with Management and Relay. See Combined.

Peer connectivity

MetricTypeDescription
active_peersGaugeCurrently connected peers.
peer_connection_duration_secondsHistogramDuration of a peer's stream connection. Unit: seconds.
registrations_totalCounterPeer registrations on the Signal stream.
deregistrations_totalCounterPeer deregistrations.
registration_failures_totalCounterPeer registration failures.
registration_delay_millisecondsHistogramDelay between stream open and successful registration. Unit: milliseconds.
get_registration_delay_millisecondsHistogramLookup time for a registered peer. Unit: milliseconds.

Message forwarding

MetricTypeDescription
messages_forwarded_totalCounterMessages successfully relayed between peers.
message_forward_failures_totalCounterForward attempts that failed (peer offline, send error, etc.).
message_forward_latency_millisecondsHistogramEnd-to-end forward latency. Unit: milliseconds.
message_size_bytesHistogramSize of forwarded messages. Unit: bytes.

Grafana dashboard

A ready-made Signal dashboard is available under Dashboards.