Skip to content

Add breaking change documentation for Console JSON logging duplicate messages #47741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 5, 2025

This PR adds documentation for the breaking change introduced in .NET 10 Preview 7 that eliminates duplicate messages in Console logging when using the JSON formatter.

Changes Made

  • New breaking change document: Created /docs/core/compatibility/extensions/10.0/console-json-logging-duplicate-messages.md following the established documentation format
  • Updated index: Added entry to the Extensions table in /docs/core/compatibility/10.0.md
  • Updated navigation: Added entry to the Extensions section in /docs/core/compatibility/toc.yml

Breaking Change Summary

Previously, Console logging with JSON formatter produced duplicate messages:

{
  "EventId": 0,
  "LogLevel": "Information", 
  "Category": "Program",
  "Message": "This is an information message.",
  "State": {
    "Message": "This is an information message.",
    "{OriginalFormat}": "This is an information message."
  }
}

After the change, the duplicate Message within the State object is eliminated:

{
  "EventId": 0,
  "LogLevel": "Information",
  "Category": "Program", 
  "Message": "This is an information message.",
  "State": {
    "{OriginalFormat}": "This is an information message."
  }
}

This behavioral change reduces log output size, improves performance, and eliminates confusion from redundant information.

Validation

  • All markdown files pass linting validation (0 errors)
  • YAML syntax validated for table of contents
  • Document follows established breaking change format and style guidelines

Fixes #47006.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/core/compatibility/10.0.md Breaking changes in .NET 10
docs/core/compatibility/extensions/10.0/console-json-logging-duplicate-messages.md Message no longer duplicated in Console log output
docs/core/compatibility/toc.yml docs/core/compatibility/toc

@Copilot Copilot AI changed the title [WIP] [Breaking change]: Avoid duplicate messages in Console logging with Json formatter Add breaking change documentation for Console JSON logging duplicate messages Aug 5, 2025
@Copilot Copilot AI requested a review from gewarren August 5, 2025 23:47
Copilot finished work on behalf of gewarren August 5, 2025 23:47
@gewarren gewarren marked this pull request as ready for review August 7, 2025 18:46
@gewarren gewarren requested a review from a team as a code owner August 7, 2025 18:46
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.

[Breaking change]: Avoid duplicate messages in Console logging with Json formatter
2 participants