Skip to content

Commit

Permalink
Update troubleshooting debug cli (#214)
Browse files Browse the repository at this point in the history
  • Loading branch information
lixmal authored Aug 12, 2024
1 parent 2808b4d commit b225b06
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/pages/how-to/troubleshooting-client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,25 +83,25 @@ You can analyze the logs to identify the root cause of the problem. If you need
A debug archive containing the recent logs and the status at the time of execution can be generated with the following command.

Adding the `-A` flag will anonymize the logs, removing sensitive information such as public IP addresses and domain names.
Adding the `-S` flag will add system information like network routes and interfaces

```shell
netbird debug bundle -A
netbird debug bundle -AS
```

This will output the path of the generated file, which can be accesses with administrative privileges.
This will output the path of the generated file, which can be accessed with administrative privileges.

### Debug for a specific time

To capture logs for a specific time, you can use the `debug for` command. This will generate a debug bundle after the specified time has elapsed.
To capture logs for a specific time period, you can use the `debug for` command. This will generate a debug bundle after the specified time has elapsed.

```shell
netbird debug for 5m -A
netbird debug for 5m -AS
```

To capture any issues arising during a full `up`/`down` cycle, this will bring netbird `down`, set the log level to `trace`, and bring it back `up`.
After 5 minutes netbird will be brought down again and the debug bundle will be generated.
To capture any issues arising during the `up` and `down` processes, this will set the log level to `TRACE` and bring netbird `up` and `down` up to a few times.
After 5 minutes the netbird status will be restored to the previous state and the debug bundle will be generated.

Afterwards the netbird `up`/`down` state and the log level will be restored to the previous state.


## Enabling debug logs on agent
Expand Down

0 comments on commit b225b06

Please sign in to comment.