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

Logging convensions #726

Open
RainbowMango opened this issue Nov 5, 2024 · 2 comments
Open

Logging convensions #726

RainbowMango opened this issue Nov 5, 2024 · 2 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@RainbowMango
Copy link
Member

What documentation would you like to be added:
Proposing to add documents for logging conversion, like https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#logging-conventions.

Why do you think this document is needed:
Creating a document for logging conventions is essential for maintaining consistency, ensuring readability, and facilitating effective troubleshooting and monitoring in the system.

Where do you think the document should be placed:
I think the document could be placed under https://github.com/karmada-io/website/tree/main/docs/contributor
More precisely, the document should be placed in this code directory:
https://github.com/karmada-io/website/tree/main/docs/contributor/logging-convension.md

@RainbowMango RainbowMango added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Nov 5, 2024
@MAVRICK-1
Copy link

Hi @RainbowMango,

I would like to work on adding a logging-conventions document for Karmada. I believe this document will help maintain consistency in logging practices, enhance debugging and monitoring, and align with best practices.

I’ve referred to the [Kubernetes Logging Conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#logging-conventions) as a baseline and drafted a basic outline covering logging levels, formatting guidelines, and examples.

Could you please guide me on:

  1. Any specific logging practices or patterns that are unique to Karmada and should be included.
  2. How we can ensure this document is integrated effectively into the contributor guide.
  3. Any additional sections or details you think would be valuable for this document.

Looking forward to your guidance and feedback.

@RainbowMango
Copy link
Member Author

Hi @MAVRICK-1 Thank you in advance.

Currently, the Karmada project doesn't have a logging convention. That's why I proposing a document for this. The main difference between Karmada and Kubernetes is Karmada has not yet fully adopted structured logging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

2 participants