Skip to content
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

New docs for Log Formatter APIs #19224

Closed
shirhatti opened this issue Jul 16, 2020 · 3 comments
Closed

New docs for Log Formatter APIs #19224

shirhatti opened this issue Jul 16, 2020 · 3 comments
Labels
doc-idea Pri0 Urgent priority

Comments

@shirhatti
Copy link
Contributor

shirhatti commented Jul 16, 2020

Describe the new topic

dotnet/runtime#38616 adds a few new features to ILogger:

  • A new in-box JSON format for Console logs
  • Support for custom log formatters

Explain why this topic is needed.

In environments where folks scrape/redirect console logs for structured logging, they want to know how to enable JSON formatted logs

Suggest a location in the Table of Contents.

https://docs.microsoft.com/aspnet/core/fundamentals/logging/

Write an abstract. In one short paragraph, describe what this topic will cover.

Console log formatting APIs

The Console Logger provides built-in formatters and the ability author your own custom formatter.

Create an outline for the new topic. We'll help review the outline and approve it before anyone writes a topic.

  • What is a console log formatter?
  • What are the in-box console log formatters?
    • Simple
    • JSON
    • SystemD
    • Compact
  • How do register a new formatter?
  • How do I select which formatter to use (via both code and config)?
  • How do I author a new formatter?

@maryamariyan

@Rick-Anderson
Copy link
Contributor

@shirhatti @maryamariyan can you suggest someone to prove code samples and the first draft?

@Rick-Anderson Rick-Anderson added doc-idea Pri0 Urgent priority and removed ⌚ Not Triaged labels Jul 20, 2020
@maryamariyan
Copy link
Member

@Rick-Anderson I can help out.

@shirhatti
Copy link
Contributor Author

Closing this issue as it was addressed in dotnet/docs#21189

@Rick-Anderson Rick-Anderson removed their assignment Feb 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-idea Pri0 Urgent priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants