Skip to content

Add new logging docs #2254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 4, 2019

Conversation

TylerLeonhardt
Copy link
Member

@TylerLeonhardt TylerLeonhardt commented Oct 24, 2019

PR Summary

Add new section on getting the payloads of the messages. Keep in mind, the "old way" is still needed as it will still give us:

vscode-powershell logs
Start up logs (from Start-EditorServices.ps1)
PSES logs (without the payloads)

PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an x between the square brackets.
Please mark anything not applicable to this PR NA.

  • PR has a meaningful title
  • Summarized changes
  • PR has tests (N/A)
  • This PR is ready to merge and is not work in progress
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

Copy link
Contributor

@rjmholt rjmholt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any information that is no longer relevant and needs to come out (like about logs on the filesystem)?

Copy link
Collaborator

@SydneyhSmith SydneyhSmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me, I am sure we will quickly find out through issues if these instructions are not clear to users/need refinement

@@ -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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we specify that this only applies to certain versions of the extension i.e. if you have 2019-10 or above?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added!

@TylerLeonhardt
Copy link
Member Author

@rjmholt

Is there any information that is no longer relevant and needs to come out (like about logs on the filesystem)?

No we will still use that as the first attempt to diagnose the problem. That gives us:

vscode-powershell logs
Start up logs (from Start-EditorServices.ps1)
PSES logs (without the payloads)

TylerLeonhardt and others added 2 commits October 24, 2019 15:28
Co-Authored-By: Robert Holt <rjmholt@gmail.com>
@TylerLeonhardt
Copy link
Member Author

We can wait to merge this until the release. Just to be safe.

@TylerLeonhardt TylerLeonhardt merged commit 3862d2a into PowerShell:master Nov 4, 2019
@TylerLeonhardt TylerLeonhardt deleted the new-logging-docs branch November 4, 2019 05:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants