qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 08:54:45 -07:00
Code Releases Activity

gopls/doc: improve troubleshooting docs with specifics

Browse Source 
Add the exact VS Code settings that users need to capture valuable logs.

Change-Id: If6b4874d1d3beab2fa6da054615dd7973b6e3fa9
Reviewed-on: https://go-review.googlesource.com/c/tools/+/214940
Reviewed-by: Heschi Kreinick <heschi@google.com>
This commit is contained in:
Rebecca Stambler 2020-01-15 13:25:56 -05:00
parent 497c7f156c
commit 20e5918576
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
gopls/doc/troubleshooting.md
View File

@ -33,9 +33,35 @@ Much of this information is filled in for you if you use `gopls bug` to file the
### Capturing logs
For VSCode users, the gopls log can be found by going to `"View: Debug Console" -> "Output" -> "Tasks" -> "gopls"`. For other editors, you may have to directly pass a `-logfile` flag to gopls.
#### VS Code
To increase the level of detail in your logs, start `gopls` with the `-rpc.trace` flag. To start a debug server that will allow you to see profiles and memory usage, start `gopls` with `serve --debug=localhost:6060`.
For VSCode users, the gopls log can be found by navigating to `View` -> `Output` (or `Ctrl+K Ctrl+H`). There will be a drop-down menu titled `Tasks` in the top-right corner. Select the `gopls` item, which will contain the `gopls` logs.
To increase the level of detail in your logs, add the following to your VS Code settings:
```json5
"go.languageServerFlags": [
"-rpc.trace"
]
```
To start a debug server that will allow you to see profiles and memory usage, add the following to your VS Code settings:
```json5
"go.languageServerFlags": [
"serve",
"-rpc.trace",
"--debug=localhost:6060",
],
```
You will then be able to view debug information by navigating to `localhost:6060`.
#### Other editors
For other editors, you may have to directly pass a `-logfile` flag to gopls.
To increase the level of detail in your logs, start `gopls` with the `-rpc.trace` flag. To start a debug server that will allow you to see profiles and memory usage, start `gopls` with `serve --debug=localhost:6060`. You will then be able to view debug information by navigating to `localhost:6060`.
If you are unsure of how to pass a flag to `gopls` through your editor, please see the [documentation for your editor](user.md#editors).