Repository navigation
Document the usage report contents and add a coverage decision - #5944
Merged
Merged
Conversation
danielmarbach
approved these changes
Oct 5, 2026
danielmarbach
left a comment
danielmarbach
left a comment
Contributor
There was a problem hiding this comment.
I did not do an indepth review since this is more TF subject matter territory.
This was referenced Oct 7, 2026
Open
rbev
approved these changes
Oct 12, 2026
warwickschroeder
approved these changes
Oct 13, 2026
rbev
self-requested a review
October 13, 2026 03:13
rbev
approved these changes
Oct 13, 2026
Adds a catalog (`docs/usage-report.md`) that lists every key the usage report carries, every setting deliberately left out, and the reason for each exclusion. Also adds an architectural decision record explaining why the report should cover every setting or runtime choice rather than adding keys on demand. The catalog is the authoritative reference for analysis and the enforcement point for review: a pull request that adds a setting must either add a key or add an exclusion row, or it gets a review finding.
Revises the 2026-10-01 coverage decision: security settings (authentication, HTTPS, CORS, forwarded headers, transport/database auth and encryption) are no longer reported, since a security reviewer could otherwise block the whole signed report and licensing has no need for the data. Also narrows scope further: `SqlVersion` now reports only the major version (or `AzureSql`), and email notification details and licensed endpoint details are dropped as out of scope. Updates `docs/usage-report.md` to match, adding the "Security configuration" exclusion reason and removing the Security key table. Links PR #5945 as the first implementation PR.
…d clarify key combinations
Co-authored-by: Rhys Bevilaqua <rhys.bevilaqua@particular.net>
rbev
force-pushed
the
john/telemetry_data_docs
branch
from
October 13, 2026 04:06
877e48f to
1e04fb6
Compare
rbev
enabled auto-merge (squash)
October 13, 2026 04:06
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a catalog (
docs/usage-report.md) that lists every key the usage report carries, every setting deliberately left out, and the reason for each exclusion. Also adds an architectural decision record explaining why the report should cover every setting or runtime choice rather than adding keys on demand.The catalog is the authoritative reference for analysis and the enforcement point for review: a pull request that adds a setting must either add a key or add an exclusion row, or it gets a review finding.