Appendix K. Logging Utility Functions For Unix Systems; Logging Utility Functions On Unix Systems - IBM Prerequisite Scanner User Manual

Appendix K. Logging utility functions for UNIX systems

Prerequisite Scanner has a set of common logging functions in
the/lib/common_function.sh file for writing debugging and trace data to log files.
Table 45 describes the logging utilities.
Table 45. Logging utility functions on UNIX systems
Function
wrlTrace log_str1 log_str2 Writes log_str1 and log_str2 strings to
wrlTraceFuncStart fn_name
wrlTraceFuncExit fn_name
wrlDebug log_str1 log_str2 Passes log_str1 and log_str2 strings to
wrlDebugFuncStart fn_name
wrlDebugFuncExit fn_name
wrlDebugFuncReturn
result_value
© Copyright IBM Corp. 2009, 2012
Description
the trace file, with the timestamp
Passes the fn_name function to wrlTrace() fn_name, trace string that represents the
Passes the fn_name function to wrlTrace() fn_name, trace string that represents the
wrlDebugGeneric()
Passes the fn_name function to wrlDebug() fn_name, debug string that represents the
Passes the fn_name function to wrlDebug() fn_name, debug string that represents the
Writes the returned result_value result
for the function to the log file
Input parameters
log_str1 and log_str2, trace strings that
represent the action and collector being
executed and which to log in the trace file.
For example:
`wrlTrace Starting os.lib`
`wrlTrace Executing os.lib`
`wrlDebug Starting os.lib`
`wrlDebug Expected libXp `
ss=`./os.lib libXp libXp`
`wrlTrace Finished os.lib`
echo "os.lib.libXp=$ss"
`wrlDebug Finished os.lib`
`wrlDebug OutPutValueIs $ss`
`wrlTrace Done os.lib`
function that is just called. For example:
`wrlTraceFuncStart "$1"`
function that just completed. For example:
`wrlTraceFuncExit "$1"`
log_str1 and log_str2, debug strings that
represent the action and collector being
executed and which to log in the debug
file. For example:
`wrlTrace Starting os.lib`
`wrlTrace Executing os.lib`
`wrlDebug Starting os.lib`
`wrlDebug Expected libXp `
ss=`./os.lib libXp libXp`
`wrlTrace Finished os.lib`
echo "os.lib.libXp=$ss"
`wrlDebug Finished os.lib`
`wrlDebug OutPutValueIs $ss`
`wrlTrace Done os.lib`
function that is just called. For example:
`wrlDebugFuncStart "$1"`
function that just completed. For example:
`wrlDebugFuncExit "$1"`
result_value, debug string that represents
the returned value from the function. For
example:
`wrlDebugFuncReturn "$versionCompare"`
149