karmada-io
Logging convensions
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
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:
- Any specific logging practices or patterns that are unique to Karmada and should be included.
- How we can ensure this document is integrated effectively into the contributor guide.
- Any additional sections or details you think would be valuable for this document.
Looking forward to your guidance and feedback.
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.