Tracing preferences

HSM for Windows client processing, from both the GUI and the commands, creates several log files, trace files, and list files.

You can set the logging levels, log file sizes, and log file locations in the Trace Preferences window in the HSM for Windows client GUI. You can also set the log levels with HSM for Windows client commands. You cannot set the log file location or the size with HSM for Windows client commands.

In normal production, the defaults log values are sufficient. The default level records warnings and errors and does not record trace-level messages. Increase the logging level only when you must complete advanced diagnostic tasks. The Severe and Error logging levels are active by default and cannot be deactivated.

When you change log levels in the hsmservice, hsmtasks, hsmmonitor or dsmgui tab, you are not required to restart those programs for those settings to become active. Other changes require a restart. You are notified when a restart is required.

There are three types of settings you define for the logs: their recording level, their size, the log file location. To access these settings from the HSM for Windows client GUI, select Tools > Trace Preferences.

Table 1 describes the trace levels settings.

Table 1. Tracing preferences: Trace levels
Field Description
  Severe Records HSM Windows messages that are categorized as severe.
  Error Records HSM Windows messages that are categorized as errors.
  Warning If checked, records HSM Windows messages that are categorized as warnings.
  Info If checked, records HSM Windows messages that are categorized as information only.
  Trace If checked, turns on the tracing of program events and is used for advanced diagnostic tasks or for problem analysis.
  Debug If checked, records special debugging information and codes is used for advanced diagnostic tasks or for problem analysis.
  Library If checked, records specific library information and is used for advanced diagnostic tasks or for problem analysis.
  Dump If checked, records more information about issues and is used for advanced diagnostic tasks or for problem analysis.
  Events If checked, records diagnostic information such as function entries and exits.
  Flush If checked, records each message to disk before processing continues instead of buffering them. This records all messages one-by-one but might affect system performance. Use this setting for advanced diagnostic tasks.
  Default Returns the settings in the Trace Levels section of this window to their default values.
  Full Returns all available logging and tracing levels.

Table 2 describes the trace file size settings.

Table 2. Tracing preferences: Trace file size
Field Description
  Maximum file size Sets a size limit in megabytes for the selected trace file. The default is 10.
  File wrapping at Defines the percentage of the log file that is kept when the Maximum file size value is reached. The default is 66.

Table 3 describes the log file size settings.

Table 3. Tracing preferences: Log file size settings
Field Description
  Maximum file size Sets a size limit in megabytes for the selected log file. The default is 10.
  File wrapping at Defines the percentage of the log file that is kept when the Maximum file size value is reached. The default is 66.

The Path Configuration tab contains three text boxes where you select the path of the three different files: trace files, log files, and list files. Click Browse to select an existing directory.