Relay metrics
The Relay service forwards encrypted WireGuard traffic between peers that cannot establish a direct P2P connection. Its metrics cover connected peers, throughput, and the per-peer authentication and bookkeeping paths. All metric names are prefixed with relay_.
Endpoint
| Setting | Default |
|---|---|
| Address | 0.0.0.0 |
| Port | 9090 |
| Path | /metrics |
| Flag | --metrics-port |
netbird-relay --metrics-port 9090
In the combined container, the metrics port is set with server.metricsPort in config.yaml and is shared with Management and Signal. See Combined.
The relay also runs a separate healthcheck server on :9000 (configurable with --health-listen-address / -H). The healthcheck server does not expose metrics.
Peers
| Metric | Type | Description |
|---|---|---|
relay_peers | Gauge | Currently connected peers. |
relay_peers_active | Gauge | Peers that exchanged traffic within the last 30 seconds. |
relay_peers_idle | Gauge | Connected peers that have been idle for at least 30 seconds. |
relay_peer_authentication_time_milliseconds | Histogram | Time to authenticate a peer. Unit: milliseconds. |
relay_peer_store_time_milliseconds | Histogram | Time to register a peer in the in-memory store. Unit: milliseconds. |
relay_peer_reconnections_total | Counter | Peer reconnections (existing peer ID re-registering). |
Traffic
| Metric | Type | Description |
|---|---|---|
relay_transfer_sent_bytes_total | Counter | Bytes sent to peers. |
relay_transfer_received_bytes_total | Counter | Bytes received from peers. |
Grafana dashboard
A ready-made Relay dashboard is available under Dashboards.