gopls/doc: improve troubleshooting docs with specifics
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>
diff --git a/gopls/doc/troubleshooting.md b/gopls/doc/troubleshooting.md
index 3d8efe3..faadf4a 100644
--- a/gopls/doc/troubleshooting.md
+++ b/gopls/doc/troubleshooting.md
@@ -33,9 +33,35 @@
### 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).
