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

Add logging levels to the Contribution Guide #302

Closed
osopardo1 opened this issue Apr 4, 2024 · 0 comments · Fixed by #308
Closed

Add logging levels to the Contribution Guide #302

osopardo1 opened this issue Apr 4, 2024 · 0 comments · Fixed by #308
Labels
type: documentation Improvements or additions to documentation

Comments

@osopardo1
Copy link
Member

As stated in #288 , we can have 4 levels of Logging information:

  • WARN level is supposed to be critical and actionable. If the user sees a WARN, then something bad happened and it might require user intervention.
  • INFO level provides information about the execution, but not necessarily actionable and it avoids being verbose. It is not uncommon to see INFO level on in production, so it is expected to be lightweight with respect to the volume of messages generated.
  • DEBUG provides debug level info when debugging the code. It can be verbose as it is not expected to be on in production.
  • TRACE provides further detail to DEBUG on execution paths, and in particular, it indicates critical the methods that been executed.

We should add this information with more detailed cases in our Contribution Guide.

@osopardo1 osopardo1 added the type: documentation Improvements or additions to documentation label Apr 4, 2024
@fpj fpj closed this as completed in #308 May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant