Logging

Log files are often the only way to get reliable data. The task of analyzing output can become easier when the log files are used and recording appropriate levels of output.

At a minimum log files need to contain:

• Utility name
• Utility version
• Parameter names and values
• Record of files modified/written (when appropriate)
• Record of individual changes made to modified files (when appropriate)

The log message format should be as follows:

hh:mm:ss<tab>message type<tab>message

Message types can include INFO, WARN, ERROR, SEVERE, or DEBUG. These are generally self-explanatory, but SEVERE should not be used unless there is an abend (in Perl the die() command). Add new message types if the situation calls for it. For example, BRP has a SETUP message type.