Table of Contents |
---|
Log Formats
Log files should be written so that each log entry follows these rules:
- Log entries are only text data. UTF-8 is allowed, ASCII is preferred, binary data is forbidden.
- Never log any security-critical values (passwords, keys, system secrets)
...
Level | Description |
---|---|
DEBUG | Developer messages needed only when debugging code. May include recording of such things as entry and exit from methods or internal branch tracking. |
INFO | Informational message used to trace system inputs and actions. Significant actions in the execution of some activity; |
NOTICE | Normal but significant events. Events that are expected but provide important context, such as service restarts and reloading configuration files. |
WARNING | Conditions that imply that some failure is possible, but not certain. Generally, external inputs that are not as expected and possibly invalid. Especially useful in low level routines that are going to return an error that may be recoverable by the caller. |
ERR | An unexpected condition likely to cause an end-user visible failure. |
CRIT | Endangers service operation beyond the current operation. |
ALERT | Fault to be communicated to operations. |
EMERG | Should be replaced with CRIT. |
...
Code written for the sipXecs project should use logging libraries from the project: the OsSysLog
class (in sipXportLib
) for C++. Java code should use the log4j logging framework and use the and the log4j Appender defined in org.sipfoundry.commons.log4j.SipFoundryAppender
and the log4j Layout defined in org.sipfoundry.commons.log4j.SipFoundryLayout
.
Where possible, third party code should have its logging wrapped to conform to these conventions.