Previous Topic: Supported Log LevelsNext Topic: Customizing ArcotID PKI Client Behavior

CA ArcotID PKI Client Reference Guide › ArcotID PKI Client Features › Client Logging › Log File Configurations

Log File Configurations

To set the ArcotID PKI Client log file configurations, you need to use the [arcot/WebClient/LogLibrary<n>] section of the WebClient.ini file. This file is available at the following location:

<%SYSTEMDRIVE%>:\Program Files\Common Files\Arcot Shared\conf

The log parameters are defined as name-value pairs. Set the ParamSupported parameter to the number of the name-value pairs that you plan to define. By default, the value of ParamSupported is set to 4, which means four logging parameters can be configured.

The following table lists the default logging parameters and their values that the ArcotID PKI Client supports:

Parameter

Name

Description

Param1

LOG_FILE_NAME

Specify the log file name and the location where the ArcotID PKI Client logs must be written to.

By default, the ArcotID PKI Client log file name is ArcotClientLog.txt and is created in the

<%SYSTEM_DRIVE%>\windows\system32\ folder.

Param2

LOG_FILE_ROLLOVER_INTERVAL

Specify the duration after which the log file contents must be moved to the backup file. Supported values are:

  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY

By default, the rollover interval is set to DAILY, which indicates that the rollover happens when the first messaged is logged after the midnight.

Note: If you do not set any value for this parameter, then the log rollover happens when the log file size is equal to MAX_LOG_FILE_SIZE.

Param3

MAX_LOG_FILE_SIZE

Specify the maximum size of the log file.

By default, the maximum log file size is 10 MB.

Param4

BACKUP_LOG_FILE_LOCATION

Specify the location where the backup log file must be saved.

By default, the ArcotID PKI Client backup log file is created in the

<%SYSTEM_DRIVE%>\windows\system32\ folder.

Param5

Note: By default, this parameter is not enabled.

LOG_LINE_FORMAT

Specify the attributes that should be logged on each log line. Following attributes are supported:

  • Time stamp (TS1L)
    The time and date when the entry was logged, translated to the local time zone. The format of logging this information is as follows:
    day month date HH:MM:SS.mis year.
    Here, mis represents milliseconds.
  • Log level (SEV)
    The severity level of the logged entry. See "Supported Log Levels" for more information.
  • Process ID (PID)
    The ID of the process that logged the entry.
  • Thread ID (TID)
    The ID of the thread that logged the entry.
  • Message ID (MID)
    The unique identifier of the message.
  • Message (MSG)
    The log message.
  • Logging ID (LID)
    The ID of the logger.

    Note: This attribute is currently not supported.