Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

RFC: Standardize Logging Levels and Meanings

Aperta
  • Qualcosa non va?
#5,101 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
powershell, typescript, vscode
Ambito
documentation, observability

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.

Descrizione

Area-Logging Issue-Enhancement
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.

Lingua principale
TypeScript
Stelle
1.9k
Fork
549
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PowerShell/vscode-powershell

Tutte le issue di PowerShell/vscode-powershell

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.