Brief doc on feedback/logging/data systems#13554
Brief doc on feedback/logging/data systems#13554rainersigwald wants to merge 2 commits intodotnet:mainfrom
Conversation
We discussed this with some new team members yesterday; writing it down.
There was a problem hiding this comment.
Pull request overview
Adds a short internal-facing document describing MSBuild’s primary data collection surfaces (loggers, tracing/events, telemetry) and how they differ in purpose and audience.
Changes:
- Introduces a new overview doc for MSBuild logging/feedback/data collection systems.
- Summarizes key built-in loggers and common post-build analysis workflows.
- Documents tracing (EventSource/ETW) and telemetry at a high level with links to existing docs.
There was a problem hiding this comment.
Expert Review — Documentation PR
Clean documentation-only PR providing a useful overview of MSBuild's three data-collection systems. All internal cross-references (Logging-behavior.md, specs/event-source.md, VS-Telemetry-Data.md) resolve to existing files, and the external link to (msbuildlog.com/redacted) is correct. Content is technically accurate.
Findings
One inline NIT on curly/smart quotes vs ASCII quotes inconsistency.
Minor suggestion (not blocking): Consider adding a link to this new file from documentation/README.md — e.g. in the "Logging" section — so it's discoverable from the docs index.
Dimension Summary
| # | Dimension | Verdict |
|---|---|---|
| 1 | Backwards Compatibility | ✅ LGTM |
| 2 | ChangeWave Discipline | ✅ LGTM |
| 3 | Performance & Allocation | ✅ LGTM |
| 4 | Test Coverage | ✅ LGTM |
| 5 | Error Message Quality | ✅ LGTM |
| 6 | Logging & Diagnostics | ✅ LGTM |
| 7 | String Comparison | ✅ LGTM |
| 8 | API Surface Discipline | ✅ LGTM |
| 9 | Target Authoring | ✅ LGTM |
| 10 | Design Before Implementation | ✅ LGTM |
| 11 | Cross-Platform Correctness | ✅ LGTM |
| 12 | Code Simplification | ✅ LGTM |
| 13 | Concurrency & Thread Safety | ✅ LGTM |
| 14 | Naming Precision | ✅ LGTM |
| 15 | SDK Integration Boundaries | ✅ LGTM |
| 16 | Idiomatic C# Patterns | ✅ LGTM |
| 17 | File I/O & Path Handling | ✅ LGTM |
| 18 | Documentation Accuracy | |
| 19 | Build Infrastructure Care | ✅ LGTM |
| 20 | Scope & PR Discipline | ✅ LGTM |
| 21 | Evaluation Model Integrity | ✅ LGTM |
| 22 | Correctness & Edge Cases | ✅ LGTM |
| 23 | Dependency Management | ✅ LGTM |
| 24 | Security Awareness | ✅ LGTM |
Note
🔒 Integrity filter blocked 2 items
The following items were blocked because they don't meet the GitHub integrity level.
- #13554
pull_request_read: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #13554
pull_request_read: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
To allow these resources, lower min-integrity in your GitHub frontmatter:
tools:
github:
min-integrity: approved # merged | approved | unapproved | noneGenerated by Expert Code Review (on open) for issue #13554 · ● 1.8M
We discussed this with some new team members yesterday; writing it down.