Skip to content

Commit c433981

Browse files
committed
docs: add troubleshooting section to JetBrains Toolbox docs
1 parent 0950077 commit c433981

File tree

1 file changed

+27
-0
lines changed
  • docs/user-guides/workspace-access/jetbrains

1 file changed

+27
-0
lines changed

docs/user-guides/workspace-access/jetbrains/toolbox.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,30 @@ To connect to a Coder deployment that uses internal certificates, configure the
5555
1. Select **Settings**.
5656
1. Add your certificate path in the **CA Path** field.
5757
![JetBrains Toolbox Coder Provider certificate path](../../../images/user-guides/jetbrains/toolbox/certificate.png)
58+
59+
60+
## Troubleshooting
61+
62+
If you encounter issues connecting to your Coder workspace via JetBrains Toolbox, follow these steps to enable and capture debug logs:
63+
64+
### Enable Debug Logging
65+
66+
1. Open Toolbox
67+
1. Navigate to the **Toolbox App Menu (hexagonal menu icon) > Settings > Advanced**.
68+
1. In the screen that appears, select `DEBUG` for the Log level: section.
69+
1. Hit the back button at the top.
70+
1. Retry the same operation
71+
72+
### Capture Debug Logs
73+
74+
1. Access logs via **Toolbox App Menu > About > Show log files**.
75+
2. Locate the log file named `jetbrains-toolbox.log` and attach it to your support ticket.
76+
3. If you need to capture logs for a specific workspace, you can also generate a ZIP file using the Workspace action menu, available either on the main Workspaces page in Coder view or within the individual workspace view, under the option labeled **Collect logs**.
77+
78+
> [!Workspace]
79+
> Toolbox does not persist log level configuration between restarts.
80+
81+
## Additional Resources
82+
83+
- [JetBrains Toolbox documentation](https://www.jetbrains.com/help/toolbox-app)
84+
- [Coder JetBrains Toolbox Plugin Github](https://github.com/coder/coder-jetbrains-toolbox)

0 commit comments

Comments
 (0)