DYNR/netbird
2
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-08-05 00:15:26 -04:00
Code Issues 23.5k Packages Projects Releases 10 Wiki Activity

[PR #1471] Extend netbird status command to include health information #15430

New Issue
Closed
opened 2026-08-05 03:07:38 -04:00 by saavagebueno · 0 comments
saavagebueno commented 2026-08-05 03:07:38 -04:00
Owner
Copy Link

Original Pull Request: https://github.com/netbirdio/netbird/pull/1471

State: closed
Merged: Yes

Describe your changes

  1. Added probes to query the signal server, the management server, the and the current relays whenever netbird status is run.
  • The signal server grpc connection is tested by sending to a dummy peer.
  • The management grpc connection is tested by retrieving the public key.
  • The STUN servers are tested by trying to bind to an address.
  • The TURN servers are tested by trying to allocate a session.
  1. The iface code was extended to return wireguard status (last handshake, tx/rx bytes) by peer. It is also retrieved on demand when netbird status is run.

New status output:

image

image

Issue ticket number and link

As a user who is troubleshooting our client’s connectivity, I want to know if there are connection issues between the client and the management system.

We have 3 main layers that are used in connection discovery:

  • signal server (for message exchange)

  • management server (for network map)

  • stun/turn server(s) (for public IP discovery and relay connections)

For each of these components, we should validate if they are working as intended.

Another missing piece in our status command is the Wireguard handshake status, the peer transfer stats, and the endpoints used by NetBird in the connection from both ends.

Below, you can see a draft of the detailed status output after the changes are applied:

Peers detail:
 raspberrypi.netbird.cloud:
  NetBird IP: 100.127.45.118
  Public key: qNqWct63/h1uL+2wPS3LZKodFOar5N4Lpj4KUunrIng=
  Status: Connected
  -- detail --
  Connection type: P2P
  Direct: true
  ICE candidate (Local/Remote): srflx/host
  ICE candidate endpoints (Local/Remote): 54.35.10.87:51820/101.12.32.16:51820
  Last connection update: 2024-01-08 17:16:42
  Last Wireguard handshake: 2024-01-08 20:16:42
  Transfer status (received/sent): 41.83 KiB/174.65 KiB

iphone.netbird.cloud:
  NetBird IP: 100.127.45.25
  Public key: qNqWct63/h1uL+lkndkvlnsdkvndslfkvndklf=
  Status: Connected
  -- detail --
  Connection type: Relay
  Direct: true
  ICE candidate (Local/Remote): srflx/relay
  ICE candidate endpoints (Local/Remote): 54.35.10.87:51820/35.10.23.111:23345
  Last connection update: 2024-01-08 17:16:42
  Last Wireguard handshake: 2024-01-08 20:16:42
  Transfer status (received/sent): 41.83 KiB/174.65 KiB

Daemon version: 0.25.3
CLI version: 0.25.3
Management: Connected to https://api.netbird.io:443
Signal: Not connected to https://signal.netbird.io:443, reason: ...
Relay: 
  https://turn.netbird.io:5555 is Available
  https://turn.netbird.io:5555 is Unavailable, reason: stun or turn error
FQDN: maycons-mbp-2.netbird.cloud
NetBird IP: 100.127.197.64/16
Interface type: Userspace
Peers count: 1/1 Connected

For the summarized status:

Daemon version: 0.25.3
CLI version: 0.25.3
Management: Connected 
Signal: Disconnected, reason: ...
Relay: 1/2 Available
FQDN: maycons-mbp-2.netbird.cloud
NetBird IP: 100.127.197.64/16
Interface type: Userspace
Peers count: 1/1 Connected

Let’s store a state that indicates when the last probe was performed against management, signal, and relay, and if the checks were positive, do not perform the probe again by default. A user can force probe with a --force-health-probe flag. If the probe check fails, next time user runs the status command we query again, regardless of the last check time.

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)
  • Extended the README / documentation, if necessary
**Original Pull Request:** https://github.com/netbirdio/netbird/pull/1471 **State:** closed **Merged:** Yes --- ## Describe your changes 1. Added probes to query the signal server, the management server, the and the current relays whenever ```netbird status``` is run. - The signal server grpc connection is tested by sending to a dummy peer. - The management grpc connection is tested by retrieving the public key. - The STUN servers are tested by trying to bind to an address. - The TURN servers are tested by trying to allocate a session. 2. The `iface` code was extended to return wireguard status (last handshake, tx/rx bytes) by peer. It is also retrieved on demand when `netbird status` is run. New status output: ![image](https://github.com/netbirdio/netbird/assets/17948409/730c0884-cf54-4290-9bde-7f6f71247c94) ![image](https://github.com/netbirdio/netbird/assets/17948409/995b67c9-0cc7-4bb4-9dbc-824c12c6ad87) ## Issue ticket number and link As a user who is troubleshooting our client’s connectivity, I want to know if there are connection issues between the client and the management system. We have 3 main layers that are used in connection discovery: - signal server (for message exchange) - management server (for network map) - stun/turn server(s) (for public IP discovery and relay connections) For each of these components, we should validate if they are working as intended. Another missing piece in our status command is the Wireguard handshake status, the peer transfer stats, and the endpoints used by NetBird in the connection from both ends. Below, you can see a draft of the detailed status output after the changes are applied: ``` Peers detail: raspberrypi.netbird.cloud: NetBird IP: 100.127.45.118 Public key: qNqWct63/h1uL+2wPS3LZKodFOar5N4Lpj4KUunrIng= Status: Connected -- detail -- Connection type: P2P Direct: true ICE candidate (Local/Remote): srflx/host ICE candidate endpoints (Local/Remote): 54.35.10.87:51820/101.12.32.16:51820 Last connection update: 2024-01-08 17:16:42 Last Wireguard handshake: 2024-01-08 20:16:42 Transfer status (received/sent): 41.83 KiB/174.65 KiB iphone.netbird.cloud: NetBird IP: 100.127.45.25 Public key: qNqWct63/h1uL+lkndkvlnsdkvndslfkvndklf= Status: Connected -- detail -- Connection type: Relay Direct: true ICE candidate (Local/Remote): srflx/relay ICE candidate endpoints (Local/Remote): 54.35.10.87:51820/35.10.23.111:23345 Last connection update: 2024-01-08 17:16:42 Last Wireguard handshake: 2024-01-08 20:16:42 Transfer status (received/sent): 41.83 KiB/174.65 KiB Daemon version: 0.25.3 CLI version: 0.25.3 Management: Connected to https://api.netbird.io:443 Signal: Not connected to https://signal.netbird.io:443, reason: ... Relay: https://turn.netbird.io:5555 is Available https://turn.netbird.io:5555 is Unavailable, reason: stun or turn error FQDN: maycons-mbp-2.netbird.cloud NetBird IP: 100.127.197.64/16 Interface type: Userspace Peers count: 1/1 Connected ``` For the summarized status: ``` Daemon version: 0.25.3 CLI version: 0.25.3 Management: Connected Signal: Disconnected, reason: ... Relay: 1/2 Available FQDN: maycons-mbp-2.netbird.cloud NetBird IP: 100.127.197.64/16 Interface type: Userspace Peers count: 1/1 Connected ``` Let’s store a state that indicates when the last probe was performed against management, signal, and relay, and if the checks were positive, do not perform the probe again by default. A user can force probe with a --force-health-probe flag. If the probe check fails, next time user runs the status command we query again, regardless of the last check time. ### Checklist - [ ] Is it a bug fix - [ ] Is a typo/documentation fix - [x] Is a feature enhancement - [ ] It is a refactor - [x] Created tests that fail without the change (if possible) - [x] Extended the README / documentation, if necessary
saavagebueno added the pull-request label 2026-08-05 03:07:38 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2021 Q4
2021 Q4
2022 Q1
2022 Q1
2022 Q1
2022 Q1
2022 Q1
2022 Q1
accessibility
accessibility
accessibility
acl
acl
acl
agent
agent
agent
agent
agent
agent
Android
Android
Android
Android
Android
Android
api
api
api
authentik
authentik
authentik
automation
automation
automation
azure
azure
azure
battery-usage
battery-usage
battery-usage
bug
cache
cache
cache
client
client
client
client-ui
client-ui
client-ui
cloud
cloud
cloud
cloud-only
cloud-only
cloud-only
cloudflare
cloudflare
cloudflare
community
community
community
compatibility
compatibility
compatibility
config-idp
config-idp
config-idp
config-issue
config-issue
config-issue
connection
connection
connection
contribution
contribution
contribution
coturn
coturn
coturn
cross-vpn
cross-vpn
cross-vpn
dashboard
dashboard
dashboard
data-usage
data-usage
data-usage
distribution
distribution
distribution
dns
dns
dns
docker
docker
docker
documentation
documentation
documentation
duplicate
duplicate
duplicate
enhancement
enhancement
event-stream
event-stream
event-stream
feature-request
feature-request
feature-request
freebsd
freebsd
freebsd
getting-started
getting-started
getting-started
go
go
go
good first issue
good first issue
good first issue
gui
gui
gui
help wanted
help wanted
help wanted
home-assistant
home-assistant
home-assistant
idp
idp
idp
inconsistency
inconsistency
inconsistency
integration
integration
integration
integrations
integrations
integrations
ios
ios
ios
ipv6
ipv6
ipv6
jwt
jwt
jwt
k8s
k8s
k8s
keycloak
keycloak
keycloak
linux
linux
linux
login
login
login
macos
macos
macos
management-service
management-service
management-service
Medium
Medium
Medium
missing-docs
missing-docs
missing-docs
mobile
mobile
mobile
moved-internal
moved-internal
moved-internal
needs-review
needs-review
needs-review
netbird-ui
netbird-ui
netbird-ui
networking
networking
networking
new-platform
new-platform
new-platform
nginx
nginx
nginx
notification
notification
notification
okta
okta
okta
openwrt
openwrt
openwrt
P2
P2
P2
packaging
packaging
packaging
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
performance
performance
performance
postgres
postgres
postgres
posture-checks
posture-checks
posture-checks
psk
psk
psk
pull-request
Mirrored from GitHub Pull Request
 question
question
question
refactor
refactor
refactor
relay
relay
relay
release
release
release
rfc
rfc
rfc
routes
routes
routes
security
security
security
security-improvement
security-improvement
security-improvement
security-related
security-related
security-related
self-hosting
self-hosting
self-hosting
server
server
server
signal
signal
signal
sleep-issue
sleep-issue
sleep-issue
ssh
ssh
ssh
ssl
ssl
ssl
status
status
status
store
store
store
synology
synology
synology
system-compatibility-issue
system-compatibility-issue
system-compatibility-issue
test-suite
test-suite
test-suite
third-party-integration
third-party-integration
third-party-integration
triage
triage
triage
triage
triage
triage
triage-needed
triage-needed
triage-needed
troubleshooting
troubleshooting
troubleshooting
UX
UX
UX
waiting-feedback
waiting-feedback
waiting-feedback
windows
windows
windows
wontfix
wontfix
wontfix
zitadel
zitadel
zitadel
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
dynr-servers saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: DYNR/netbird#15430
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?