How can we help?

Enable Trace Logging

Anthony - Versasec Support
Anthony - Versasec Support
  • Updated

Introduction

This article provides guidance on enabling extensive trace logging for vSEC:CMS, facilitating troubleshooting of issues encountered within the vSEC:CMS product suite environment.

Trace Logging for Admin and Agent Console

If operators encounter issues with the vSEC:CMS Admin or Agent application console, enabling trace logging can aid Versasec Support engineers in identifying the root cause.

Method 1 - Using PowerShell Script

  1. Run PowerShell as Administrator.
  2. Navigate to the script folder named 'Enable_TraceLog' within the vSEC:CMS installation directory.
  3. Execute the script '.\Enable-Or-Disable-Trace-Logging-Script.ps1'.
  4. Choose the desired component (e.g., vSEC_console_trace) to generate trace logs.
  5. Trace files will be created in the 'C:\vSEC-trace' directory.
  6. Disable logging after investigations by running the script and selecting the component to disable logging.

Method 2 - Via Registry

  1. Create the following directory 'C:\vSEC-trace'.
  2. Open 'regedit'.
  3. Set registry entries under:
[HKEY_CURRENT_USER\SOFTWARE\Versatile Security\vSEC_CMS_T]
    • Name: log.level DWORD, hex value 5
    • Name: log.Enable DWORD, hex value 1
    • Name: log.FileName STRING, value: C:\vSEC-trace\vSEC_console_trace_#p#.txt
    • Name: log.maxsize DWORD, hex value 64000000
    • Name: log.minsize DWORD, hex value 20000000
    • Name: log.archive DWORD, hex value 1
  1. Recreate the issue and trace files will be generated in 'C:\vSEC-trace'.
  2. Disable logging by setting 'log.Enable' to 0.

Provide the trace file to your Versasec support engineer for further analysis.

Important
It is recommended to disable trace logging in the registry once the issue is resolved. This can be done by setting the registry entry 'log.Enable' to 0.

Method 3 - Via Admin or Agent Application

  1. Start trace logging from 'Help - Diagnostic' menu.
  2. Recreate the issue.
  3. Stop trace logging from 'Help - Diagnostic' menu.
  4. Save the trace file.

Trace Logging for vSEC:CMS Service

If issues arise within your vSEC:CMS system, enabling trace logging for the service might become necessary. This service runs on the server where vSEC:CMS is installed and is named 'vSEC:CMS Service'. There are two methods for capturing service logs.

Method 1 - Using PowerShell Script

Follow similar steps as outlined in Method 1 for Admin and Agent Console, and select the service logging component instead.

Method 2 - Via Registry

  1. Create the following directory 'C:\vSEC-trace'.
  2. Open 'regedit'.
  3. Set registry entries under:
[HKEY_LOCAL_MACHINE\SOFTWARE\Versatile Security\VSEC_CMS_T\Service]
    • Name: log.level DWORD, hex value 5
    • Name: log.Enable DWORD, hex value 1
    • Name: log.FileName STRING, value: C:\vSEC-trace\vSEC_service_trace_#p#.txt
    • Name: log.maxsize DWORD, hex value 64000000
    • Name: log.minsize DWORD, hex value 20000000
    • Name: log.archive DWORD, hex value 1
  1. Recreate the issue and trace files will be generated in 'C:\vSEC-trace'.
  2. Disable logging by setting 'log.Enable' to 0.

Trace Logging for vSEC:CMS User Application

If issues are occurring on a client machine that is using the vSEC:CMS User Application, it may be necessary to enable trace logging to determine the root cause.

Three methods can be used to generate trace logging for this application.

Method 1 - Using PowerShell Script

Follow similar steps as outlined in Method 1 for Admin and Agent Console.

Method 2 - Via Registry

  1. Create the following directory 'C:\vSEC-trace'.
  2. Open 'regedit'.
  3. Set registry entries under:
[HKEY_CURRENT_USER\SOFTWARE\Versatile Security\VSEC_CMS_T\USS]
    • Name: log.level DWORD, hex value 5
    • Name: log.Enable DWORD, hex value 1
    • Name: log.FileName STRING, value: C:\vSEC-trace\vSEC_trace_logging_#p#.txt
    • Name: log.maxsize DWORD, hex value 64000000
    • Name: log.minsize DWORD, hex value 20000000
    • Name: log.archive DWORD, hex value 1
  1. Recreate the issue and trace files will be generated in 'C:\vSEC-trace'.
  2. Disable logging by setting 'log.Enable' to 0.

Method 3 - Via User Application Console

It is possible to create trace logging directly from the application console session.

  1. From Help - Diagnostic click the Start trace button and click Close.
  2. Recreate the issue that you may be experiencing.
  3. When complete with recreating the issue go back to Help - Diagnostic and click the Stop trace button.
  4. Click the Save button and save the trace to a file.