Skip to content

Commit 3862d2a

Browse files
[Ignore] Add new logging docs (#2254)
* add new logging docs * nicer words Co-Authored-By: Robert Holt <[email protected]> * add note of what it applies to * update version
1 parent a938420 commit 3862d2a

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

docs/troubleshooting.md

+29-7
Original file line numberDiff line numberDiff line change
@@ -137,18 +137,13 @@ Logs provide context for what was happening when the issue occurred.
137137
**Note: You should skim through your logs for any sensitive information you would not like to share online**
138138

139139
- Before sending through logs, try and reproduce the issue with
140-
**log level set to Verbose** or **Diagnostic**. You can set this
140+
**log level set to Diagnostic**. You can set this
141141
in the [VSCode Settings] (<kbd>Ctrl</kbd>+<kbd>,</kbd>) with:
142142

143-
```json
144-
"powershell.developer.editorServicesLogLevel": "Verbose"
145-
```
146-
147-
or for diagnostic logging:
148-
149143
```json
150144
"powershell.developer.editorServicesLogLevel": "Diagnostic"
151145
```
146+
152147
After you have captured the issue with the log level turned up,
153148
you may want to return it (since verbose logging can use disk space):
154149

@@ -185,6 +180,33 @@ Logs provide context for what was happening when the issue occurred.
185180
[email protected]. Please still open an issue though
186181
so we can track the work &mdash; other users may have the same issue.
187182

183+
#### Provide Language Server Protocol payload logs
184+
185+
> NOTE: This currently only applies to the PowerShell Preview extension and only if you have version
186+
> 2019.11.0 or higher.
187+
188+
The PowerShell extension works mostly from sending and receiving messages from [PowerShell Editor Services](httos://github.com/PowerShell/PowerShellEditorServices).
189+
In some cases, getting to the bottom of a bug will require looking at the payloads of these messages. To do this:
190+
191+
- Add the following setting to your settings file:
192+
193+
```json
194+
"powershell editor services.trace.server":"verbose"
195+
```
196+
197+
- Restart Visual Studio Code and reproduce the issue.
198+
199+
- Go into the "Output" panel (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>U</kbd> or <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>U</kbd>).
200+
201+
- In the drop down on the right, select "PowerShell Editor Services".
202+
203+
- Copy the entire contents of the Output panel and paste it into the GitHub issue in the browser.
204+
At this point, you may delete the setting if you want.
205+
206+
- Again, if you prefer to share your logs privately, you can send them to
207+
[email protected]. Please still open an issue though
208+
so we can track the work &mdash; other users may have the same issue.
209+
188210
### Visual Studio Code Version
189211

190212
[Your VSCode version] can be obtained from the Integrated Console

0 commit comments

Comments
 (0)