-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Update logging docs #51429
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
Update logging docs #51429
Conversation
There was a problem hiding this 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 reorganizes the logging documentation by moving all logging-related docs and snippets into a dedicated "logging" subfolder under docs/core/extensions/. The PR also modernizes the high-performance logging documentation to prioritize source-generated logging (using LoggerMessageAttribute) over the legacy LoggerMessage.Define approach.
Changes:
- Moved 9 logging documentation files to
docs/core/extensions/logging/subfolder with appropriate redirections - Rewrote
high-performance-logging.mdto focus on source-generated logging as the primary approach, relegatingLoggerMessage.Defineto a legacy section - Updated 30+ files with corrected path references to moved logging documentation
Reviewed changes
Copilot reviewed 39 out of 43 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
high-performance-logging.md |
Complete rewrite focusing on source-generated logging with LoggerMessageAttribute as primary approach |
source-generation.md |
Updated snippet paths to reflect new folder structure |
overview.md |
Updated relative paths for snippets and cross-references |
providers.md |
Updated relative paths for snippets and cross-references |
console-log-formatter.md |
Updated relative paths and improved wording |
custom-provider.md |
Updated relative paths and improved contractions |
library-guidance.md |
Updated relative paths and improved style |
log-sampling.md |
Updated relative paths throughout |
log-buffering.md |
Updated relative paths throughout |
.openpublishing.redirection.core.json |
Added 9 redirect entries for moved files |
| Multiple cross-referencing files | Updated 20+ files to reference new logging documentation paths |
| Project files | Updated target frameworks to net10.0 (may need review) |
Comments suppressed due to low confidence (1)
docs/core/extensions/logging/console-log-formatter.md:14
- According to Markdown Writing Style Guidelines (Guideline 1000002), avoid using "you will" in instructions. Change "you will learn" to present tense "you learn" or use imperative mood. The sentence should read "In this article, you learn about console log formatters."
BillWagner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This LGTM @gewarren
Let's ![]()
|
Thanks @BillWagner |
Replaces #51382.
Fixes #40870.
Internal previews
Toggle expand/collapse
BackgroundService