Previous Topic: Configuring the Log InformationNext Topic: Deploying and Configuring the Custom Application


Setting Up Log Parameters

The following table describes the log parameters defined in the [arcot/integrations/smadapter/LogLibraryn] section.

Parameter

Required/
Optional

Description

DLLName

Optional

Specify the name of the library file that performs the logging.

Note: Do not specify the suffix of the file name, because it is automatically added during run time.

Default value: ArcotLog2FileSC

HandleLevel

Optional

Specify the log level, which defines the details that must be included in the log messages. Messages with the specified severity level and higher levels are logged. For example, if the value is set to 2, then the messages of severity level 2 to 7 are logged.

Supported values are:

  • 1=low
  • 2=info
  • 3=notice
  • 4=warning
  • 5=error
  • 6=alert
  • 7=fatal

Default value: 3

EntryPoint

Optional

Specify the function within the library that must be called to get a handle to the logging object.

Note: This is fixed for a given log handler DLL.

Default value: CreateFileLogHandler

ParamSupported

Optional

Specify the number of parameters to pass to the logging object.

Default value: 4

Param1=LOG_FILE_NAME

Optional

Specify the name and location of the log file.

Default value:

installation_dir/logs/arcotadaptershim.log

Param2=LOG_FILE_
ROLLOVER_INTERVAL

Optional

Specify how often you want to roll over the log file to a backup file.

Supported values are:

  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY

    Note: The LOG_FILE_ROLLOVER_INTERVAL parameter and the MAX_LOG_FILE_SIZE parameter (described in the next row) are both mutually exclusive. If you set one of these parameters, then you must comment the other one. The LOG_FILE_ROLLOVER_INTERVAL parameter is commented by default.

     

Param2=MAX_LOG_FILE_
SIZE

Optional

Specify the maximum size of the log file. This is an alternative way to indicate rollover, if the rollover interval is not set. The size is expressed in bytes.

For example:

Param3=MAX_LOG_FILE_SIZE=10000000

The above value indicates that the size of the log file is approximately 10 MB.

Note: If this parameter is set to 0, the log file will continue to grow indefinitely. In addition, the MAX_LOG_FILE_SIZE parameter and the LOG_FILE_ROLLOVER_INTERVAL parameter (described in the previous row) are both mutually exclusive. If you set one of these parameters, then you must comment the other one. The MAX_LOG_FILE_SIZE parameter is enabled by default.

 

Param3=BACKUP_LOG_
FILE_LOCATION

 

Optional

Specify the complete path where the backup log file is stored. The path provided must be valid.

Default value: installation_dir/logs/backup

Param4=LOG_LINE_
FORMAT

 

Optional

Specify the format of the logging string. This indicates the attributes that will be logged on each line of the file.

Note: If this parameter is not set, the legacy format will be used.

Supported values are:

  • LTZ=System Timezone, Date, and Time
  • SEV=Severity
  • PID=ProcessID
  • TID=ThreadID
  • MID=MessageIDNumber
  • MSG=Log Message Text
  • LID=LoggingID