PowerShell / PowerShell/vscode-powershell
RFC: Standardize Logging Levels and Meanings
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 1.9k
- Fork
- 548
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Prerequisites
- I have written a descriptive issue title.
- I have searched all issues to ensure it has not already been reported.
Summary
Now that the logging infrastructure has been relatively standardized between vscode-powershell and PSES, I feel like we need to add some logging guidelines to the developer guide, and update severities for existing messages.
Proposed Design
I want there to be specific "layers" that you peel back as you need to investigate an issue, here's my thoughts in order of least verbose to most verbose:
- Critical: Fully unhandled exceptions or anything causing a hard stop/panic of PSES or the editor. These would almost always be surfaced as warning dialogs if at all possible.
- Error: Some functionality of the extension/LSP did not complete, but was handled and does not require a critical restart of the environment. Not necessarily surfaced to user outside of logs unless action required. No values shown unless it's explicitly relevant to the error (e.g. expected x but received y)
- Warning: Degraded but successfully completed behavior, Notify of deprecated functionality. Same rules as error (action required). Warning would be the default level, basically not logging anything and keeping performance up with logging noops unless something goes wrong (Maybe Info is better for newbies)
- Info/Verbose: Logs the high level steps of the initialization of PSES, and any configuration or operational changes.
- Debug: Logs the invocation of handlers, summary of request/response (without values), detail about steps such as launch process, etc.
- Trace: Full protocol logging including values
The overarching idea is that anything Debug or above would only contain values/potential PII about the environment itself, whereas trace may include everything the user did or requested including script contents, so users can feel fairly safe about analyzing and submitting debug level reports, whereas trace reports may require some sanitization.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo la guida per sviluppatori e l’infrastruttura di logging esistente in vscode-powershell e PSES. Mappa le severità attuali dei messaggi rispetto ai significati proposti da Critical-through-Trace, quindi documenta le linee guida e aggiorna le severità esistenti; il lavoro è completo quando la guida e i messaggi seguono uno standard coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- powershell, typescript, vscode
- Ambito
- documentation, observability
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100