Proposal: Basic Telemetry for PSSA

PSScript Analyzer Proposed Telemetry

Goal

To better understand how PSSA is being used both within PSES and in isolation in order to make informed investments in PSSA 2.0.

Questions

• What versions of PowerShell are being used with PSSA? What versions of PowerShell should we continue to support?
• What tasks are PSSA currently being used to accomplish?
  • To what extent is PSSA being used inside vs. outside of PSES? Which of these experiences is most important to optimize?
  • To what extent are custom rules vs. built in rules being used?
  • What is the proportional use of PSSA as a formatter vs "analyzer"?
• To what extent are the compatibility rules being used? Which platforms are being targeted the most?
• What rules are being turned off? What rules should we strip out?
• Which rules are causing the largest performance delays?

Proposed Metrics

• Version of PowerShell
• Inside vs Outside of PSES
• CI usage/environment type
• Time for each rule to complete
• Count of:
  • Known formatter type rules
  • Known analyzer type rules (tally for each one)
  • Custom rules (not on our known list)
  • Known compatibility profiles (tally for each one)
  • Use of a configuration

The issue names no files, tests, or entry points. Start by turning the listed questions and proposed metrics into a telemetry design for PSSA, covering use inside and outside PSES. Done is an agreed scope and implementation plan for collecting the proposed metrics.