Skip to content

Commit b70f3c0

Browse files
committed
docs/troubleshooting: ask to use '-rpc.trace' when collecting traces
And mention gopls.verboseOutput. Change-Id: Ie0040a7a803768a5b764442544ada8561bd1b04b Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/326813 Trust: Hyang-Ah Hana Kim <[email protected]> Run-TryBot: Hyang-Ah Hana Kim <[email protected]> Reviewed-by: Rebecca Stambler <[email protected]>
1 parent 1bc09d8 commit b70f3c0

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/troubleshooting.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,23 @@ Errors may also be logged to the Developer Tools console. These errors may be mo
4646

4747
## Collect `gopls` information
4848

49-
The gopls log can be found by navigating to `View` -> `Output`. There will be a drop-down menu titled `Tasks` in the top-right corner. Select the `gopls (server)` item, which will contain the `gopls` logs.
50-
51-
To increase the level of detail in your logs, add the following to your settings:
49+
Enable `gopls` tracing by adding the following to your settings:
5250

5351
```json5
5452
"go.languageServerFlags": [
5553
"-rpc.trace"
5654
]
5755
```
5856

57+
The gopls log can be found by navigating to `View` -> `Output`. There will be a drop-down menu titled `Tasks` in the top-right corner. Select the `gopls (server)` item, which will contain the `gopls` logs.
58+
59+
In special cases, you may want to increase the verbosity further:
60+
61+
```json5
62+
"gopls": {
63+
"verboseOutput": true
64+
}
65+
```
5966
## File an issue
6067

6168
We can't diagnose a problem from just a description. When filing an issue, please include as much as possible of the following information:
@@ -66,6 +73,6 @@ We can't diagnose a problem from just a description. When filing an issue, pleas
6673
1. Your Go extension version: `Extensions: Show Installed Extensions`
6774
1. Your Go environment: `go env` in the workspace folder
6875
1. Relevant VS Code settings: run `Preferences: Open Settings (JSON)` and include anything in a `[go]` block, and anything that starts with `go.` or `gopls.`
69-
1. Extension and `gopls` logs as seems appropriate for the bug.
76+
1. Extension and `gopls` logs as seems appropriate for the bug. (Include from the beginning of the logs if possible.)
7077

7178
Once you've collected that information, [file your issue](https://github.com/golang/vscode-go/issues/new/choose).

0 commit comments

Comments
 (0)