SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-07-27 16:32:34 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

[PR #4350] Add 'Generate Debug Bundle' feature via Management server and Dashboard #4211

New Issue
Open
opened 2025-11-20 08:07:56 -05:00 by saavagebueno · 0 comments
saavagebueno commented 2025-11-20 08:07:56 -05:00
Owner
Copy Link

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

State: closed
Merged: No

Describe your changes

We’re adding a "Generate Debug Bundle" feature to the Dashboard.
When clicked, this button will:

  1. Send a request from the Dashboard to the Management server.
  2. The Management server will send a notification to the target peer’s NetBird client over the existing Management stream.
  3. The client will run the built-in debug bundle or debug for 1m command.
  4. The client uploads the logs to the configured storage backend.
  5. The Management server returns an upload key to the Dashboard so the user can retrieve the logs.

Implementation Details

  • Extend the existing Management ↔ Client stream to support custom message types (e.g., CONFIG_UPDATE, DEBUG).
  • Use a oneof in the protobuf to allow flexible payloads for different message types.
  • Implement debug triggering logic on the client side.
  • Add server logic to relay debug requests and return the upload key to the dashboard.

TODO

  • Protocol changes

    • Extend protobuf with:
      • enum NotificationType { CONFIG_UPDATE = 1; DEBUG = 2; }
      • oneof payload { ... } for flexible request/response payloads.
      • Add NotificationType to both request and response messages.

  • fix all tests and make sure current functionality is still working

  • add debugging call

  • implement the api endpoint and make sure it will call the debugging

**Original Pull Request:** https://github.com/netbirdio/netbird/pull/4350 **State:** closed **Merged:** No --- ## Describe your changes We’re adding a "Generate Debug Bundle" feature to the Dashboard. When clicked, this button will: 1. Send a request from the Dashboard to the Management server. 2. The Management server will send a notification to the target peer’s NetBird client over the existing Management stream. 3. The client will run the built-in debug bundle or debug for 1m command. 4. The client uploads the logs to the configured storage backend. 5. The Management server returns an upload key to the Dashboard so the user can retrieve the logs. ### Implementation Details - Extend the existing Management ↔ Client stream to support custom message types (e.g., `CONFIG_UPDATE`, `DEBUG`). - Use a `oneof` in the protobuf to allow flexible payloads for different message types. - Implement debug triggering logic on the client side. - Add server logic to relay debug requests and return the upload key to the dashboard. ### TODO - [x] **Protocol changes** - Extend protobuf with: - enum NotificationType { CONFIG_UPDATE = 1; DEBUG = 2; } - oneof payload { ... } for flexible request/response payloads. - Add NotificationType to both request and response messages. - [ ] fix all tests and make sure current functionality is still working - [ ] add debugging call - [ ] implement the api endpoint and make sure it will call the debugging
saavagebueno added the pull-request label 2025-11-20 08:07:56 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#4211
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?