Skip to content

Conversation

@meaghanlewis
Copy link
Contributor

@meaghanlewis meaghanlewis commented Dec 12, 2025

Summary

This pull request updates the .NET SDK telemetry documentation to improve clarity, privacy guidance, and formatting. The most important changes include a new section on avoiding inadvertent disclosure of sensitive information, a more readable and organized list of collected telemetry data by SDK version, and improved formatting of environment variable and agent tables.

  • Move Privacy and disclosure guidance to be earlier in the article
  • Replaced the previous data collection table with a version-organized, bulleted list, making it easier to see which telemetry data is collected in each SDK version.
  • Added a link to the Microsoft Privacy Statement for more information about privacy and personal data collection.
  • Updated environment variable and agent tables to use code formatting for variable names, improving readability and consistency.

Fixes #49866


Internal previews

📄 File 🔗 Preview link
docs/core/tools/telemetry.md .NET SDK and .NET CLI telemetry

The .NET SDK displays text similar to the following when you first run one of the [.NET CLI commands](index.md) (for example, `dotnet build`). Text might vary slightly depending on the version of the SDK you're running. This "first run" experience is how Microsoft notifies you about data collection.

> [!NOTE]
> **Breaking change:** The behavior of telemetry messages written to `stderr` has changed in recent versions of the .NET SDK. For more information, see [dotnet CLI commands log non-command-relevant data to stderr](../compatibility/sdk/10.0/dotnet-cli-stderr-output.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think it's good to remove this considering this is new behavior introduced in .NET 10?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved this note down 10 lines. The recommendation was to move the note so that the output isn't separated from its intro text.

@meaghanlewis meaghanlewis marked this pull request as ready for review December 15, 2025 19:29
@meaghanlewis meaghanlewis requested a review from a team as a code owner December 15, 2025 19:29
Copilot AI review requested due to automatic review settings December 15, 2025 19:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request addresses peer review feedback for the .NET SDK telemetry documentation by improving organization, clarity, and privacy guidance. The changes reorganize telemetry data collection information into a more scannable tabbed format by SDK version, enhance privacy disclosures, and improve formatting consistency throughout the document.

Key changes:

  • Reorganized telemetry data collection from a table format to version-specific tabs with bulleted lists for better readability
  • Enhanced privacy guidance with earlier placement, clearer language, and a link to the Microsoft Privacy Statement
  • Improved formatting consistency by using code formatting for environment variable names in tables

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Address feedback from peer review

2 participants