Document peer connection history
TE
4d ago+105+105+012345678901234567890123456789-2-2-0123456789
Docs for netbirdio/netbird#8615 (Management records peer connection events) and netbirdio/dashboard#896 (Connection History tab on the peer page). Related to https://github.com/netbirdio/netbird/issues/8616.
What changed
Peers, Connection History (new page)
- Explains what the history is for and what "connected" means: the peer's connection to Management, not tunnels between peers, with pointers to
netbird statusand Traffic Events Logging for those. - Lists the two events,
peer.connectandpeer.disconnect, what triggers each, and what each includes. Disconnects carry no source IP. - Covers the source IP (NAT, and self-hosted Management behind a reverse proxy) and the location (GeoLite2, recorded only when it was looked up for that connection's own IP).
- Shows where to find the history: the peer's Connection History tab and the permission it needs, Audit Events, and
GET /api/events/auditwith itsmetakeys. Notes that MCP agents read the same events throughlist_audit_events. - States the limits: no history from before the upgrade, gaps when a Management server stops unexpectedly, out-of-order entries on quick reconnects, audit log volume, the 10,000-event retrieval cap, and
NB_EVENT_ACTIVITY_LOG_ENABLED=falseon self-hosted.
Activity, Audit Events Logging
- Adds "Peer connected" and "Peer disconnected" to the list of tracked events and links to the new page. The existing note about future client-side connection events now separates connections to Management from tunnels between peers.
Navigation
- Adds Connection History under Peers, after Remote Jobs.
Summary by CodeRabbit
- Documentation
- Added a Connection History link under Manage NetBird → Peers.
- Documented peer connections and disconnections to Management, including where to view events, available connection details, access requirements, and limitations.
- Clarified that these events do not represent peer-to-peer tunnel connectivity or traffic.