GitHub user JoaoJandre added a comment to the discussion: logging standards in 
CloudStack

Here are some guidelines I think would be a good start (adapted from 
@DaanHoogland 's post on the mailing list)

Fatal:
- Include a reason why the system can not function anymore;
- Be followed by a System.exit() call;
- Include a stack trace.

Error:
- Include a reason why the system can not execute a user request or
why part of the system is degraded;
- If the error is happening because a user request cannot be executed, do not 
include a stack trace; however, if the system is degraded in some form, that 
is, some feature will stop working or some component of the system is 
compromised, and the stack trace might bring helpful information, then include 
the stack trace.

Warn:
- Include a reason why the system might not behave as the user is
expecting;
- Should not include a stack trace.

Info:
- Informational messages to tell the operator what the system is doing at the 
moment;
- Should not include a stack trace.

Debug:
- Useful troubleshooting information. This information should not be needed for 
normal operation;
- If a thrown exception is caught, not rethrown, and the Fatal/Error levels do 
not apply, the stack trace of such exception.

Trace:
- Granular information that is useful during development of a 
feature/enhancement/fix/improvement that is not needed in any kind of 
operational way.

GitHub link: 
https://github.com/apache/cloudstack/discussions/8746#discussioncomment-8710928

----
This is an automatically sent email for users@cloudstack.apache.org.
To unsubscribe, please send an email to: users-unsubscr...@cloudstack.apache.org

Reply via email to