Quick reference: how to modify log and trace levels

Quick reference information about how to modify log and tracing levels for all components.

Modifying HCL Workload Automation logging level

  1. Edit the TWSCCLog.properties file, located in the following path:
    On Windows operating systems
    <TWA_home>\TWS\
    On UNIX operating systems
    <TWA_DATA_DIR>
  2. Modify the tws.loggers.msgLogger.level property.
    This determines the type of messages that are logged. Change this value to log more or fewer messages, as appropriate, or on request from IBM® Software Support. Valid values are:
    INFO
    All log messages are displayed in the log. The default value.
    WARNING
    All messages except informational messages are displayed.
    ERROR
    Only error and fatal messages are displayed.
    FATAL
    Only messages which cause IBM Workload Scheduler to stop are displayed.
  3. Save the file. The change is immediately effective.
  4. Modify the Conman.ini to customize logging levels for conman commands.
    The Conman.ini file is located in the following path:
    On Windows™ operating systems
    TWA_home\TWS\ITA\cpa\config\template
    On UNIX™ operating systems
    TWA_DATA_DIR/ITA/cpa/config/template
  5. Save the file. The change is immediately effective.

Modifying HCL Workload Automation tracing level

  1. Edit the TWSCCLog.properties file, located in the following path:
    On Windows operating systems
    <TWA_home>\TWS\
    On UNIX operating systems
    <TWA_DATA_DIR>
  2. Modify tws.loggers.trc<component>.level.
    This determines the type of trace messages that are logged. Change this value to trace more or fewer events, as appropriate, or on request from IBM Software Support. Valid values are:
    DEBUG_MAX
    Maximum tracing. Every trace message in the code is written to the trace logs.
    DEBUG_MID
    Medium tracing. A medium number of trace messages in the code is written to the trace logs.
    DEBUG_MIN
    Minimum tracing. A minimum number of trace messages in the code is written to the trace logs.
    INFO
    All informational, warning, error and critical trace messages are written to the trace. The default value.
    WARNING
    All warning, error and critical trace messages are written to the trace.
    ERROR
    Only error and critical messages are written to the trace.
    CRITICAL
    Only messages which cause IBM Workload Scheduler to stop are written to the trace.
  3. Save the file. The change is immediately effective.
  4. Modify the Conman.ini to customize logging levels for conman commands.
    The Conman.ini file is located in the following path:
    On Windows™ operating systems
    TWA_home\TWS\ITA\cpa\config\template
    On UNIX™ operating systems
    TWA_DATA_DIR/ITA/cpa/config/template
  5. Save the file. The change is immediately effective.
Component names used in the tws.loggers.trc property names are for the most part self-explanatory, but the following short explanations might help:
Logger
The main internal component of HCL Workload Automation that performs the scheduling activities.
Sendevnt
The event processor.
Connectr
The connector.
Log format parameters
fomatters.basicFmt.dateTimeFormat
This contains a specification of the date and time format used by CCLog when adding the date and time stamp to the message header. The format uses the standard strftime format convention, used by many programming libraries. The full format details can be found by searching the Internet, but a synthesis of the commonly used definitions is included in Date and time format reference - strftime.
fomatters.basicFmt.separator
This defaults to the pipe symbol "|", and is used to separate the header of each log message, which contains information such as the date and time stamp and the process that issued the error, from the body, which contains the process-specific information such as the issuing process, the message number and the message text. You can change the separator to another character or characters, or set it to null.
twsHnd.logFile.className
This indicates if CCLog uses semaphore memory to write to the log file. The default setting (ccg_filehandler) tells CCLog to write each line of a multiline message separately. Each process interleaves each line of its multiline messages with messages from other processes, if necessary, improving performance. While this approach could potentially make the log files more difficult to read, this interleaving only occurs in extreme situations of very high use, for example when many jobs are running concurrently.

The setting ccg_multiproc_filehandler, defines that each process completes writing any log message, including multiline messages, before freeing the log file for another process to use. This can have an impact on performance when many processes are running concurrently.

tws.loggers.className
This indicates the type of log layout you want to use, determining the number of fields in the log record header. The default setting (ccg_basiclogger) tells CCLog to put just the date/time stamp and the process name in the header. The alternative setting is ccg_pdlogger, which contains more information in the header, thus reducing the length of the log records available for the message text.
tws.loggers.organization
This defaults to IBM® and is used to differentiate between log entries from applications from different suppliers when the same instance of CCLog is being used by more than one software supplier. HCL Workload Automation is supplied with a unique instance, and thus unique log files, so if this value is prefixed to your log messages, you can set the value of this parameter to null to avoid it being displayed.
tws.loggers.product
This defaults to TWS and is used to differentiate when the same log files are used by more than one product. HCL Workload Automation is supplied with unique log files, so if this value is prefixed to your log messages, you can set the value of this parameter to null to avoid it being displayed.
Other parameters
No other parameters must be modified. To do so risks compromising the logging or tracing facility, or both.
Making your changes effective depends on the type of change:
Changes to log or trace levels
If you change the tws.loggers.msgLogger.level or the tws.loggers.trc<component>.level, the change is immediately effective after the file has been saved.
All other changes
Restart HCL Workload Automation to make overall changes effective; restart a process to make process-specific changes effective.

Modifying HCL Workload Automation and Dynamic Workload Console logging level

Edit the logging_config.xml file, located in the following paths on the master domain manager:
On UNIX operating systems
TWA_home/usr/servers/engineServer/configDropins/defaults
On Windows operating systems
TWA_home\usr\servers\engineServer\configDropins\defaults
and in the following paths on the Dynamic Workload Console:
On UNIX operating systems
DWC_home/usr/servers/dwcServer/configDropins/defaults
On Windows operating systems
DWC_home\usr\servers\dwcServer\configDropins\defaults
The file contains the following properties:
maxFileSize
Rotates the log files when their size reaches the specified value. The default value is 20 MB.
maxFiles
Keeps the specified number of log files. The default value is 5 files.
maxFfdcAge="30"
Keeps First Failure Data Capture (FFDC) data for the specified number of days. The default value is 30.
To modify the logging_config.xml file, complete the following steps:
  1. Copy the logging_config.xml file from the defaults folder to a working folder.
  2. Edit the logging_config.xml file in the working folder with the desired configuration.
  3. Optionally, create a backup copy of the relevant configuration file present in the overrides directory in a different directory. Ensure you do not copy the backup file in the path where the template files are located.
  4. Copy the updated logging_config.xml file to the overrides folder. Maintaining the original folder structure is not required.
  5. Stop and restart WebSphere Application Server Liberty to make the changes effective.

Modifying Dynamic Workload Console tracing level

To activate the Dynamic Workload Console traces at run time, locate and edit the trace.xml template.

To modify the trace.xml template, follow this procedure:

  1. Copy the template file from the templates folder to a working folder.
  2. Edit the template file in the working folder with the desired configuration.
  3. Optionally, create a backup copy of the relevant configuration file present in the overrides directory in a different directory. Ensure you do not copy the backup file in the path where the template files are located.
  4. Copy the updated template file to the overrides folder. Maintaining the original folder structure is not required.
  5. Changes are effective immediately.

See: Activating and deactivating traces in Dynamic Workload Console for more details.

Modifying WebSphere Application Server Liberty Base tracing level

To modify the trace level on the WebSphere Application Server Liberty Base, edit the trace.xml file as necessary.

  1. Copy the template file from the templates folder to a working folder.
  2. Edit the template file in the working folder with the desired configuration.
  3. Optionally, create a backup copy of the relevant configuration file present in the overrides directory in a different directory. Ensure you do not copy the backup file in the path where the template files are located.
  4. Copy the updated template file to the overrides folder. Maintaining the original folder structure is not required.
  5. Changes are effective immediately.

See Setting the traces on the application server for the major HCL Workload Automation processes for more details.

Managing dynamic agent tracing level

To manage traces for the dynamic agent, refer to the following sections:

You can also configure the traces when the agent is not running by editing the [JobManager.Logging] section in the JobManager.ini file as described in Configuring the agent. This procedure requires that you stop and restart the agent.