feat: lint undocumented telemetry - #9567
Conversation
|
Azure Pipelines: Successfully started running 2 pipeline(s). 19 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash: pwsh: WindowsPowerShell install MSI install Standalone Binary
MSI
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
|
Hi @Hui Miao (@huimiu). Thank you for your interest in helping to improve the Azure Developer CLI experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days. |
Why
Telemetry events and attribute keys are defined in Go but documented in separate references. Without an automated check, new telemetry can be emitted without being added to the public telemetry reference or metrics audit schema, causing documentation drift.
What changed
telemetrylinttool that checks core event and field definitions, statictracing.Startevent names, and staticattribute.*keys.ReportUsageRequestevents and fixed attributes, while leaving dynamic extension keys to extension authors.cmd.,mcp., andvsrpc.dynamic prefixes.mage preflightand a dedicated pull request workflow covering core and extension changes.The checker uses Go AST parsing rather than executing code or collecting runtime telemetry so it is deterministic, cross-platform, and safe to run in preflight and CI.
Validation
go test ./tools/telemetrylint -count=1go run ./tools/telemetrylintCloses #9525