mirror of
https://github.com/netbirdio/docs.git
synced 2026-05-03 07:46:35 +00:00
@@ -187,6 +187,60 @@ issue that recovers when restarting the client.
|
||||
</p>
|
||||
Once the bundle generation is complete, you can click on `Copy Key` to get the uploaded key and share with NetBird\'s team.
|
||||
|
||||
### Remote debug bundle generation
|
||||
|
||||
Administrators can remotely request debug bundles from peer clients through the Management API or Dashboard. This is
|
||||
particularly useful when troubleshooting issues on remote machines where local access is limited or when working with
|
||||
end-users who may not be familiar with command-line tools.
|
||||
|
||||
When a remote debug bundle is requested:
|
||||
1. The management server sends a job request to the target peer
|
||||
2. The peer client receives the job and generates the debug bundle automatically
|
||||
3. The generated bundle is uploaded to a centralized location
|
||||
4. The administrator receives the upload key to access the bundle
|
||||
|
||||
#### Using the Management API
|
||||
|
||||
You can also trigger remote debug bundles programmatically via the Management API.
|
||||
|
||||
See the [Peers API documentation](/ipa/resources/peers#create-peer-debug-bundle-job) for complete API reference, including:
|
||||
- Creating debug bundle jobs
|
||||
- Listing all jobs for a peer
|
||||
- Getting job status and upload keys
|
||||
|
||||
#### Using the Dashboard
|
||||
|
||||
You can trigger remote debug bundles directly from the NetBird Dashboard without requiring CLI access.
|
||||
|
||||
**To generate a remote debug bundle:**
|
||||
|
||||
1. Navigate to **Peers** in the dashboard
|
||||
2. Click on the peer you want to troubleshoot
|
||||
3. Click the **Run Remote Job** button (the peer must be online and connected)
|
||||
4. Select **Debug Bundle** from the dropdown menu
|
||||
5. Configure the debug bundle options:
|
||||
- **Log File Count**: Number of log files to include (1-50, default: 10)
|
||||
- **Enable Bundle Duration** (optional): Collect logs for a specific time period (1-5 minutes) before generating the bundle
|
||||
- **Anonymize Log Data**: Remove sensitive information like IP addresses and domains
|
||||
6. Click **Create Debug Bundle**
|
||||
|
||||
**Viewing job status and results:**
|
||||
|
||||
Once triggered, the job appears in the **Remote Jobs** section on the peer details page. The table shows:
|
||||
- **Type**: The job type (Debug Bundle)
|
||||
- **Status**: Pending (yellow), Completed (green), or Failed (red)
|
||||
- **Created/Updated**: Timestamps for job lifecycle
|
||||
- **Output**: Once completed, displays the upload key that you can copy and share with NetBird support
|
||||
|
||||
The upload key is automatically copyable by clicking on it. Share this key through GitHub Issues, Slack, or support channels.
|
||||
|
||||
#### Limitations
|
||||
|
||||
- The peer must be online and connected to the management server to receive the job
|
||||
- Debug bundle generation may take a few seconds to a few minutes depending on log size and system information
|
||||
- Bundles are automatically uploaded to NetBird's secure storage (or your configured upload endpoint for self-hosted deployments)
|
||||
- Upload keys expire after 30 days for security
|
||||
|
||||
## Enabling debug logs on agent
|
||||
|
||||
Logs can be temporarily set using the following command.
|
||||
|
||||
Reference in New Issue
Block a user