Debug Logging
LiveCompare supports both server-side and client-side debug logging.
Server-Side Logging
As LiveCompare is used, time-stamped debug log files are generated and stored on the LiveCompare server. The following log files are always generated.
| File | Contents |
|---|---|
| Info_ServerMain_<YYYYMMDD>.txt | A summary of the XML input and output to and from the main server. |
| Info_ServerAux_<YYYYMMDD>.txt | A summary of the XML input and output from the auxiliary server. |
| Info_Dui_<YYYYMMDD>.txt | Summary log information recorded for the developer user interface. |
| Info_Pii_<YYYYMMDD>.txt | Log information detailing changes to personally-identifiable information. |
| Info_Table_<YYYYMMDD>.txt | Summary log information recorded for tables to ignore. |
| Info_<Workspace>_<Workflow>_Run_<YYYYMMDD>.txt | Summary log information recorded when <Workflow> is run in <Workspace>. |
| Log_Apps_<YYMMDD_HHMMSS>.txt | The XML input and output to and from the Apps user interface. |
The following log files are generated if debug logging has been turned on in the Configuration - Logging screen. Enabling or disabling debug logging requires LiveCompare Administrator privileges.
| File | Contents |
|---|---|
| Debug_ServerMain_<YYYYMMDD>.txt | Detailed XML input and output to and from the main server. |
| Debug_ServerAux_<YYYYMMDD>.txt | Detailed XML input and output from the auxiliary server. |
| Debug_Dui_<YYYYMMDD>.txt | Detailed log information recorded for the developer user interface. |
| Debug_Pii_<YYYYMMDD>.txt | Log information detailing changes to personally-identifiable information. |
| Debug_Table_<YYYYMMDD>.txt | Detailed log information recorded for tables to ignore. |
| Debug_<Workspace>_<Workflow>_Run_<YYYYMMDD>.txt | Detailed log information recorded when <Workflow> is run in <Workspace>. |
At the start of each day, old ‘Info’ and ‘Debug’ log files are closed and new ones for the current day are opened, so that each file stores at most one day’s worth of logging information.
The following log files are generated when testing the connections to Test Repositories.
| File | Contents |
|---|---|
| tccontst_<YYMMDD_HHMMSS>.txt | Detailed log information recorded for Tosca connection tests. |
| qttestconnection_<YYMMDD_HHMMSS>.txt | Detailed log information recorded for qTest connection tests. |
| qccontst_<YYMMDD_HHMMSS>.txt | Detailed log information recorded for ALM connection tests. |
| vststestconnection_ <YYMMDD_HHMMSS>.txt | Detailed log information recorded for Azure DevOps connection tests. |
| certifytestconnection_<YYMMDD_HHMMSS>.txt | Detailed log information recorded for Certify connection tests. |
| exceltestassistant_<YYMMDD_HHMMSS>.txt | Detailed log information recorded for Excel connection tests. |
| ssmtestconnection_<YYMMDD_HHMMSS>.txt | Detailed log information recorded for SAP Solution Manager connection tests. |
Browsing Log Files
If you have LiveCompare Administrator privileges, the log files on the LiveCompare server may be displayed by clicking ‘Browse Logs’ in the Configuration - Logging screen.
In the Logs screen, select a link in the Name column to display the log file, or choose ‘Save target as…’ from the link’s context menu to save the log file to your own machine. Debug log files may be sent to Tricentis Technical Support for problem diagnosis or troubleshooting.
Exporting Log Files
If you have LiveCompare Administrator privileges, LiveCompare’s server log files may be exported to a time-stamped ZIP file by clicking ‘Export Logs’ in the Configuration - Logging screen. Click the ‘Download the file’ link in the Export screen to download the ZIP file to your own machine.
Purging Log Files
If you have LiveCompare Administrator privileges, the ‘Info’ and ‘Debug’ log files on the LiveCompare server may be deleted by clicking ‘Purge Logs’ in the Configuration - Logging screen.
Log files older than the specified number of days (based in their last modification date) may be purged automatically by setting a value in the Logging section’s ‘DaysToKeepLogs’ field. The default value is 7. Log files older than the specified number of days are purged by a scheduled task named ‘Tricentis LiveCompare Purge Reports’ that runs each night on the LiveCompare server.
If the ‘DaysToKeepLogs’ value is set to 0, no automatic purging of log files will occur. If the ‘DaysToKeepLogs’ value is set to 1, log files generated on the previous day will not be purged.
Purging Temporary Files
Temporary files generated by LiveCompare may be purged by setting the following DWORD registry entry on your LiveCompare server.
HKEY_LOCAL_MACHINE\Software\Tricentis\LiveCompare\4.3\Settings\DaysToKeepTemps
Temporary files older than the specified number of days (based in their last modification date) are purged by a scheduled task named ‘Tricentis LiveCompare Purge Reports’ that runs each night on the LiveCompare server.
If the ‘DaysToKeepTemps’ value is set to 0 or if the registry entry does not exist, no automatic purging of temporary files will occur. If the ‘DaysToKeepTemps’ value is set to 1, log files generated on the previous day will not be purged.
Client-Side Logging
Client-side logging displays log information in your browser’s Developer Tools console window. Client-side logging may be enabled for all users by setting the following DWORD registry entry on your LiveCompare server machine.
HKEY_LOCAL_MACHINE\Software\Tricentis\LiveCompare\4.3\Settings\ClientLogLevel
ClientLogLevel may be set to any of the following values. After setting or changing the value, press Ctrl+F5 in your LiveCompare browser window to perform a full refresh.
| Value | Description |
|---|---|
| 0 | Logs a full stack trace. |
| 1 | Logs debug messages. |
| 2 | Logs information messages. |
| 3 | Logs warning messages. |
| 4 | Logs error messages. |
You should not normally enable client-side logging unless you are asked to by Tricentis Technical Support.