-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Adds Console Log Formatting APIs #38616
Conversation
maryamariyan
commented
Jun 30, 2020
•
edited
Loading
edited
- APIs approved from issue: Flexible and efficient optionally-structured console logging out of the box #34742
- Apply API review feedback
- Add implementation for the APIs.
- Updated ConsoleLoggerTests -> contains existing test cases (supporting deprecated workflow and using obsolete APIs to ensure 3.1 workflow is not regressed.)
- minor styling bugfixes (e.g. exception log did not have proper padding on Default format)
- The Log workflow would handle VT100 parsing for basic cases only. The parser ignores the escape codes we don't support. When a full parser is implemented later in the BCL, we'll switch the logger code to use that one instead
- add new test cases
Note regarding the This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change. |
10355e1
to
3d8de0c
Compare
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs
Outdated
Show resolved
Hide resolved
@maryamariyan I'll wait till the design review occur and then will review this PR. CC @davidfowl |
public const string Json = "json"; | ||
public const string Systemd = "systemd"; | ||
} | ||
[System.ObsoleteAttribute("ConsoleLoggerFormat has been deprecated.", false)] |
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.
ObsoleteAttribute [](start = 12, length = 17)
Do we need to file and fill the breaking change template for such changes?
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.
I'd say we don't. @PriyaPurkayastha?
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.
We actually do document APIs marked obsolete as a breaking change using https://github.com/dotnet/docs/issues/new?template=dotnet-breaking-change.md.
You can look up https://docs.microsoft.com/en-us/dotnet/core/compatibility/aspnetcore for examples.
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.
- TODO
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.
/cc: @shirhatti
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLogger.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLogger.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/StringWriter.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerFactoryExtensions.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerOptions.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerOptions.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProcessor.cs
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLoggerProvider.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/StringWriter.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/StringWriter.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Logging.Console/src/StringWriter.cs
Outdated
Show resolved
Hide resolved
Was CI green on this before this was merged? I am seeing failures introduced by this change in number of PRs. |
yes. it was green and I did a rebase to resolve a conflict on ConsoleLoggerTest |
this git page is incorrectly saying 168 files were changed, but it is actually 47 files: see 69d98ee |
I'm investigating the failure and I believe this is because of: #39209
I'm doing a run without #39209 |