Implement LogOutputWindow for Logging by JustinGrote · Pull Request #5065 · PowerShell/vscode-powershell · GitHub

Implements the LogOutputWindow vscode API for PowerShell extension and PSES logs received via LSP.

Recording.2024-10-18.170017.mp4

There will now be 3 separate log output panels:
PowerShell Messages logged for the PowerShell client and messages sent via the LSP adapter (prepended with [PSES])
PowerShell: Trace LSP Traces the LSP messages back and forth. Omnisharp messages will show up as traces here
PowerShell: Trace DAP Traces the DAP messages back and forth (already implemented)

This has several benefits:

Output to file is handled by vscode, we don't need our own custom handler anymore
Log levels and switching log levels handled by vscode, our code related to this (settings etc.) can be removed
Logs can be tailed and opened in separate editors within vscode, providing a very nice experience. Logs are visible using the log syntax highlighting which can be enhanced by my Crisp Logs Highlighter
Centralizes to vscode extension log folder that will be used with Issue Reporter, there's a contribution API for issue reporter where we can gather additional data as well (PR forthcoming)

Log windows do not appear unless enabled.

Right now the Log Verbosity with "Set Log Level" only controls the client-side logging level, but I hope in a future PR to be able to update the logging level of PSES dynamically. Has a minor LSP performance benefit but difficult to implement due to MEL not having dynamic log level change support natively, but I think I found a way with IOptionsMonitor to do it.

Should be merged with PowerShell/PowerShellEditorServices#2200

Fixes #5079

Andy Jordan (@andyleejordan) I think you'll like this new utility function too for taking action on a config change:

vscode-powershell/src/utils.ts

Lines 89 to 113 in d617194

    
           /** 
        
            * Invokes the specified action when a PowerShell setting changes 
        
            * @param setting a string representation of the setting you wish to evaluate 
        
            * @param action the action to take when the setting changes 
        
            * @param scope the scope in which the vscode setting should be evaluated. Defaults to 
        
            * @param workspace 
        
            * @param onDidChangeConfiguration 
        
            * @example onPowerShellSettingChange("settingName", (newValue) => console.log(newValue)); 
        
            * @returns a Disposable object that can be used to stop listening for changes 
        
            */ 
        
           // Because we actually do use the constraint in the callback 
        
           // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters 
        
           export function onPowerShellSettingChange<T>( 
        
               setting: string, 
        
               listener: (newValue: T | undefined) => void, 
        
               section: "powershell", 
        
               scope?: vscode.ConfigurationScope, 
        
           ): vscode.Disposable { 
        
               return vscode.workspace.onDidChangeConfiguration(e => { 
        
                   if (!e.affectsConfiguration(section, scope)) { return; } 
        
                   const value = vscode.workspace.getConfiguration(section, scope).get<T>(setting); 
        
                   listener(value); 
        
               }); 
        
           }

EDIT: I see a flaw here, will fix :)

Currently pending microsoft/vscode-languageserver-node#1116 otherwise all of our log messages surface as "trace" with a header which is not ideal.

This is going to be so nice though.

No longer pending that, I wrote a new trace handler :).

Currently debating if I want to add realtime logging changes based on changing the LSP setting to this PR or save that for another one.

Love it, yay.

Ok nice that there's more information now.

… Thanks Copilot...

…ervices from options definitions

Justin Grote (JustinGrote) self-assigned this Oct 18, 2024

Justin Grote (JustinGrote) force-pushed the feature/logImprovements branch from 9471227 to 69e3209 Compare October 29, 2024 17:28

This was referenced Nov 1, 2024

vscode-powershell logs rotation #5079

Closed

Support VS Code 'Set Log Level' #4441

Closed

Justin Grote (JustinGrote) mentioned this pull request Nov 15, 2024

Enhanced Logging PowerShell/PowerShellEditorServices#2200

Merged

Justin Grote (JustinGrote) marked this pull request as ready for review November 15, 2024 07:29

Justin Grote (JustinGrote) requested a review from a team as a code owner November 15, 2024 07:29

Justin Grote (JustinGrote) requested review from Patrick Meinecke (SeeminglyScience) and Andy Jordan (andyleejordan) November 15, 2024 07:29

Andy Jordan (andyleejordan) approved these changes Nov 15, 2024

View reviewed changes

Justin Grote (JustinGrote) added 16 commits November 15, 2024 13:53

Implement LogOutputChannel and move settings to UI

a02cd34

Remove unnecessary comment

a315bc7

Remove File Logging (done by LogOutputWindow automatically)

87d3e6a

First Connect

ec58325

Add output adapters, LSP restart settings

237a2f1

Fix Log Uri Test

2b9a927

Forgot to add to extension facing API

1846910

Accidentally made a recursive rather than reference what I wanted to.…

9b77ed3

… Thanks Copilot...

Pre-Restart Experiments

8b98126

Move Commands out of logger temporarily

f8e11f0

Initial Cleanup of Logging, looks good ATM

15838c6

Merge client and server editorservices logs

5b57a63

Add new MergedOutputChannel log

bff22ed

Remove unnecessary Import

cb3f2f2

Update settings for new EditorServicesLogLevels

f3e73f7

Wire up loglevels in-band due to LSP bug

db3aefb

Justin Grote (JustinGrote) added 6 commits November 15, 2024 13:53

Rework multiple classes into a parser function injection

cd8aea9

Fix some glyphs

1bf5e41

Revert extra config settings for dynamic log configuration for now

1c521c5

Remove SetLSPTrace for now

5b30d0f

Clean import

60ddcce

Align logging terminology to vscode output windows and remove editorS…

79954e2

…ervices from options definitions

Andy Jordan (andyleejordan) force-pushed the feature/logImprovements branch from 6d6f23c to 79954e2 Compare November 15, 2024 21:53

Andy Jordan (andyleejordan) enabled auto-merge (squash) November 15, 2024 21:54

Andy Jordan (andyleejordan) added the Issue-Enhancement A feature request (enhancement). label Nov 15, 2024

Andy Jordan (andyleejordan) merged commit 400fd75 into main Nov 15, 2024

Andy Jordan (andyleejordan) deleted the feature/logImprovements branch November 15, 2024 22:04

                           vscode.commands.registerCommand("PowerShell.RestartSession", async () => { await this.restartSession(); }),
                           vscode.commands.registerCommand(this.ShowSessionMenuCommandName, async () => { await this.showSessionMenu(); }),
-                          vscode.workspace.onDidChangeConfiguration(async () => { await this.onConfigurationUpdated(); }),
+                          vscode.workspace.onDidChangeConfiguration((e) => this.restartOnCriticalConfigChange(e)),

Implement LogOutputWindow for Logging by JustinGrote · Pull Request #5065 · PowerShell/vscode-powershell · GitHub

Implement LogOutputWindow for Logging - #5065

Implement LogOutputWindow for Logging#5065
Andy Jordan (andyleejordan) merged 22 commits into
mainfrom
feature/logImprovements

Justin Grote (JustinGrote) commented Oct 18, 2024 •
edited
Loading

Uh oh!

Uh oh!

Justin Grote (JustinGrote) commented Oct 19, 2024 •
edited
Loading

Uh oh!

Uh oh!

Justin Grote (JustinGrote) commented Oct 29, 2024 •
edited
Loading

Uh oh!

Uh oh!

Andy Jordan (andyleejordan) commented Nov 4, 2024

Uh oh!

Justin Grote (JustinGrote) commented Nov 4, 2024

Uh oh!

Andy Jordan (andyleejordan) left a comment

Uh oh!

Uh oh!

Andy Jordan (andyleejordan) Nov 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Implement LogOutputWindow for Logging by JustinGrote · Pull Request #5065 · PowerShell/vscode-powershell · GitHub

Implement LogOutputWindow for Logging - #5065

Implement LogOutputWindow for Logging#5065Andy Jordan (andyleejordan) merged 22 commits intomainPowerShell/vscode-powershell:mainfrom feature/logImprovementsPowerShell/vscode-powershell:feature/logImprovementsCopy head branch name to clipboard

Conversation

Justin Grote (JustinGrote) commented Oct 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Justin Grote (JustinGrote) commented Oct 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Justin Grote (JustinGrote) commented Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Andy Jordan (andyleejordan) commented Nov 4, 2024

Uh oh!

Justin Grote (JustinGrote) commented Nov 4, 2024

Uh oh!

Andy Jordan (andyleejordan) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Andy Jordan (andyleejordan) Nov 15, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Implement LogOutputWindow for Logging#5065
Andy Jordan (andyleejordan) merged 22 commits into
mainfrom
feature/logImprovements

Justin Grote (JustinGrote) commented Oct 18, 2024 •
edited
Loading

Justin Grote (JustinGrote) commented Oct 19, 2024 •
edited
Loading

Justin Grote (JustinGrote) commented Oct 29, 2024 •
edited
Loading