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

Standardize logging #448

Open
4 tasks
Tracked by #375
marcelstanley opened this issue Jun 13, 2024 · 1 comment
Open
4 tasks
Tracked by #375

Standardize logging #448

marcelstanley opened this issue Jun 13, 2024 · 1 comment
Milestone

Comments

@marcelstanley
Copy link
Collaborator

marcelstanley commented Jun 13, 2024

📚 Context

Log standardization is a recurring issue on past node versions. In order to avoid that and to make the node logs concise and self-explainable, we should make our best effort for standardizing the node logs moving forward.

We should gather clients requirements (e.g., sunodo) an make sure to either do not break backward compatibility or document the changes properly.

✔️ Solution

Evaluate options and implement a standard for logging.
Here's a very nice writeup: https://betterstack.com/community/guides/logging/logging-in-go/

Some steps already made in the code base that could be leveraged/adjusted:

📈 Subtasks

  • Gather requirements
  • Evaluate options
  • Propose standard
  • Implement changes for 2.0 and document guidelines
@marcelstanley marcelstanley mentioned this issue Jun 13, 2024
49 tasks
@marcelstanley marcelstanley self-assigned this Jun 13, 2024
@marcelstanley marcelstanley changed the title Normalize component logs Normalize logging Jun 13, 2024
@marcelstanley marcelstanley changed the title Normalize logging Standardize logging Jun 13, 2024
@marcelstanley marcelstanley added this to the 2.0.0 milestone Jun 13, 2024
@marcelstanley marcelstanley moved this to 📋 Backlog in Node Unit Jun 13, 2024
@torives
Copy link
Contributor

torives commented Jun 19, 2024

Suggestion: remove all log calls from our libs. Let the caller code decide what should or shouldn't be logged and at what level.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants