From 10df9512de39fc94857e2e52ec1fa737073b5bca Mon Sep 17 00:00:00 2001 From: Tyler Leonhardt Date: Thu, 24 Oct 2019 12:19:38 -0700 Subject: [PATCH 1/4] add new logging docs --- docs/troubleshooting.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index caa16fd15d..1012737a68 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -137,18 +137,13 @@ Logs provide context for what was happening when the issue occurred. **Note: You should skim through your logs for any sensitive information you would not like to share online** - Before sending through logs, try and reproduce the issue with - **log level set to Verbose** or **Diagnostic**. You can set this + **log level set to Diagnostic**. You can set this in the [VSCode Settings] (Ctrl+,) with: - ```json - "powershell.developer.editorServicesLogLevel": "Verbose" - ``` - - or for diagnostic logging: - ```json "powershell.developer.editorServicesLogLevel": "Diagnostic" ``` + After you have captured the issue with the log level turned up, you may want to return it (since verbose logging can use disk space): @@ -185,6 +180,30 @@ Logs provide context for what was happening when the issue occurred. vscode-powershell@microsoft.com. Please still open an issue though so we can track the work — other users may have the same issue. +#### Provide Language Server Protocol payload logs + +The PowerShell extension works mostly from sending and receiving messages from [PowerShell Editor Services](httos://github.com/PowerShell/PowerShellEditorServices). +If we need more information, we may ask to see the payloads of these messages. To do this: + +- Add the following setting to your settings file: + + ```json + "powershell editor services.trace.server":"verbose" + ``` + +- Restart Visual Studio Code and reproduce the issue. + +- Go into the "Output" panel (Ctrl+Shift+U or Cmd+Shift+U). + +- In the drop down on the right, select "PowerShell Editor Services". + +- Copy the entire contents of the Output panel and paste it into the GitHub issue in the browser. +At this point, you may delete the setting if you want. + +- Again, if you prefer to share your logs privately, you can send them to + vscode-powershell@microsoft.com. Please still open an issue though + so we can track the work — other users may have the same issue. + ### Visual Studio Code Version [Your VSCode version] can be obtained from the Integrated Console From eaf019dbe209fb22d4aef6239f32abde36bff6d8 Mon Sep 17 00:00:00 2001 From: Tyler James Leonhardt Date: Thu, 24 Oct 2019 15:28:34 -0700 Subject: [PATCH 2/4] nicer words Co-Authored-By: Robert Holt --- docs/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 1012737a68..71cde6233f 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -183,7 +183,7 @@ Logs provide context for what was happening when the issue occurred. #### Provide Language Server Protocol payload logs The PowerShell extension works mostly from sending and receiving messages from [PowerShell Editor Services](httos://github.com/PowerShell/PowerShellEditorServices). -If we need more information, we may ask to see the payloads of these messages. To do this: +In some cases, getting to the bottom of a bug will require looking at the payloads of these messages. To do this: - Add the following setting to your settings file: From fa0900418bd146e96190f732c4b57dd026a26cb2 Mon Sep 17 00:00:00 2001 From: Tyler James Leonhardt Date: Thu, 24 Oct 2019 15:31:24 -0700 Subject: [PATCH 3/4] add note of what it applies to --- docs/troubleshooting.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 71cde6233f..4b553c7998 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -182,6 +182,9 @@ Logs provide context for what was happening when the issue occurred. #### Provide Language Server Protocol payload logs +> NOTE: This currently only applies to the PowerShell Preview extension and only if you have version +> 2019.10.0 or higher. + The PowerShell extension works mostly from sending and receiving messages from [PowerShell Editor Services](httos://github.com/PowerShell/PowerShellEditorServices). In some cases, getting to the bottom of a bug will require looking at the payloads of these messages. To do this: From d4e6b009e8d89dbfc0d1f0b374012e3485586b7e Mon Sep 17 00:00:00 2001 From: Tyler James Leonhardt Date: Tue, 29 Oct 2019 11:30:57 -0700 Subject: [PATCH 4/4] update version --- docs/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 4b553c7998..4f0155c252 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -183,7 +183,7 @@ Logs provide context for what was happening when the issue occurred. #### Provide Language Server Protocol payload logs > NOTE: This currently only applies to the PowerShell Preview extension and only if you have version -> 2019.10.0 or higher. +> 2019.11.0 or higher. The PowerShell extension works mostly from sending and receiving messages from [PowerShell Editor Services](httos://github.com/PowerShell/PowerShellEditorServices). In some cases, getting to the bottom of a bug will require looking at the payloads of these messages. To do this: