This part of the Co:Z User's Guide contains information to help you diagnose problems with the Co:Z toolkit.
The following diagram illustrates the processes that occur when running the Co:Z toolkit:
Several aspects control the logging of messages and trace information in the Co:Z toolkit:
- The logging level
A threshold level: eMergency, Alert, Critical, Error, Warning, Notice, Info (default), Debug, and Trace. Each message has a level and will only be logged if that level is at or below the current logging threshold.
- The component's logger object
Each major component (C++ object) in the system will typically have its own logger, which can have its own threshold level set, or can use the default threshold.
- The common logging destination
All logger messages eventually go to the same logging logging destination, which defaults to stderr, but a specific file, a user-written routine, or the SYSLOG facility may also be used.
Logging options are set using either the -L
command-line switch or by by setting the COZ_LOG
environment variable. In either case, the value of the setting is a list of one
or more of the following values:
- M|A|C|E|W|N|I|D|T
The default logging threshhold: eMergency, Alert, Critical, Error, Warning, Notice, Info (default), Debug, Trace.
- t
Prefix log messages with a system timestamp.
- e
Include consumed cpu time in log messages.
- f=filepath
Messages are logged to the given filepath instead of stderr.
- s
Messages are logged to SYSLOG facility instead of stderr.
- logname=M|A|C|E|W|N|I|D|T
Set a specific log name to the given threshold
The following examples demonstrate how to enable logging for various Co:Z toolkit components:
The following example uses the -LD command switch to set the default logging level to "Debug" for all components in the batch launcher job (but not the target system components). The t option is also used to prefix all messages with a timestamp.
//COZLG1 JOB (),'COZ'
//STEP1 EXEC PROC=COZPROC,
// ARGS='-LD,t myuid@linux1.myco.com'
//STDIN DD *
# This is input to the remote shell
echo "We are running on: " `uname -sr`
//
The following example uses the agent-options property to set the -L command line switch to configure CoZAgent logging.
The example also sets the target system environment variable COZ_LOG
to set logging options for all other target components. Environment variables for
the target system can be set using the target-env- property prefix
in the Co:Z Launcher configuration properties DD (COZCFGD).
//COZLG1 JOB (),'COZ'
//STEP1 EXEC PROC=COZPROC,
// ARGS='myuid@linux1.myco.com'
//STDIN DD *
# This is input to the remote shell
echo "We are running on: " `uname -sr`
/*
//COZCFG DD *
agent-options=-LD,t
target-env-COZ_LOG=D,t
//
It is sometimes useful to increase the verbosity of ssh itself to determine
a problem source. To do this for the ssh client (used by the Co:Z Launcher process),
add one or more v switches to ssh-options property in
COZCFG:
//COZCFG DD *
ssh-options=-vv
//
More v's increase the debug level. Note that ssh can produce
lots of output.