This is not the latest version of Identity Director documentation.
View available documentation.

Create a trace file to troubleshoot the Windows Client

Trace files contain logging that can be used for troubleshooting.

The following registry values are available to configure logging for the Windows Client:

  • In the Windows registry, at HKLM\Software\RES\LoggingOptions:
    NameTypeDataRemarks
    EnableREG_DWORD0 (default) or 1 If this value is not set to 1, the values below are ignored.
    This value affects logging for all components.
  • In the Windows registry, at HKLM\Software\RES\ITStore\Client, the following values are available:
    NameTypeDataRemarks
    EnableFileLogsREG_DWORD0 (default) or 1 Enables logging to a trace file.
    FileLogLocationREG_SZ

    Example:
    C:\temp

    		Full path to the location of the log file.
    • The currently logged on user must have access to the specified path.
    • Specifying a path is mandatory, otherwise the log file will not be created.
    FileName

    REG_SZ

    		 Example:
    Client.log    		Name of the trace file. If no name is provided:
    • the file name starts with CLSvc_Log_
    • a new trace file is created at every Client (re)start, with a time stamp at the end of the file name
    LogFileDeleteExisting

    REG_DWORD

    		0 (default) or 1If this value is set to 1, the old trace file is deleted after every Client (re)start.
    FileLogThreshold

    REG_DWORD

    		1 through 7

    Specifies the level of detail in the trace file. Possible values are:

    • 1 (debug)
    • 2 (info)
    • 3 (status)
    • 4 (warning)
    • 5 (error)
    • 6 (critical)
    • 7 (fatal)
    MaxLogFileSizeMB

    REG_DWORD

    		Example:
    10    		Specifies the maximum size of the trace file in MB.
    • When the file reaches the maximum size, it overwrites the log from the start. Information that is overwritten, is lost.
    • If no maximum size is specified, the size of the file keeps increasing.

Restart the Windows Client to apply the changes you made by creating or changing the registry values.