Versions Compared

Version Old Version 5 New Version 6
Changes made by

Ravikumar Babu CTOO (Unlicensed)

Ravikumar Babu CTOO (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Config Key

Mandatory/ Optional

Type

Purpose

LOGGING_ENABLED_IND

Mandatory

Boolean

This k key is used to turn on or off logging by CT Framework. Turning this off would mean that even exceptions faced are not be logged to any log files.

log.path

Mandatory

Folder Name

This configuration holds the path where the log files are created. This path configured must be relative to the root path that is configured as CT_WORK_FOLDER_PATH in the implementation property file.

log.level

Optional

LOV

This configuration is for controlling the logging level. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

Category: Module Wise Log Level

log.level.audit

Optional

LOV

This key provides logging level for the audit handling module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.alert

Optional

LOV

This key provides logging level for the Alert handling module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.session

Optional

LOV

This key provides logging level for the Session management module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.web

Optional

LOV

This key provides logging level for the Web layer module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.config

Optional

LOV

This key provides logging level for the Configuration module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.cache

Optional

LOV

This key provides logging level for the Cache module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.security

Optional

LOV

This key provides logging level for the Security module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.database

Optional

LOV

This key provides logging level for the Database module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.entitlement

Optional

LOV

This key provides logging level for the Entitlement module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.event

Optional

LOV

This key provides logging level for the Event definition and handling module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.export

Optional

LOV

This key provides logging level for the Export module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.vdf

Optional

LOV

This key provides logging level for the metadata module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.hal

Optional

LOV

This key provides logging level for the Host Access Layer module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.report

Optional

LOV

This key provides logging level for the Reporting module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.validator

Optional

LOV

This key provides logging level for the Validation module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

log.level.scheduler

Optional

LOV

This key provides logging level for the Scheduler module. Possible values are - debug, error, info, fatal, warn, and off. Default value is debug.

Category: Log file related




rollovermodel

Optional

LOV

This key enables you to choose any of the following two models supported by Canvas Log appender namely:

  • CREATENEW – Current logging happens in the file name having the current date pattern and the highest rolling index value. This means that logging happens while creating a new file.
  • BACKUPOLD – Current logging would always happen in file name without date pattern and rolling index. On rollover, the current file is made as a backup with a date pattern and index included in it.

The default value is BACKUPOLD.

datepattern

Optional

date format

This key defines the following:

1. When the rollover must happen in any one of the following formats:

  • yyyy-MM – Rollover at the beginning of each month.
  • yyyy-ww – Rollover at the first day of each week. The first day of the week depends on the locale.
  • yyyy-MM-dd-a – Rollover at midnight and midday of each day.
  • yyyy-MM-dd-HH – Rollover at the top of every hour.
  • yyyy-MM-dd-HH-mm – Rollover at the beginning of every minute.


2. Date for the generated log file name in any of the following formats:

  • ddMMMyyyy – Generates the file name with date stamp in the ddMMMyyyy format, e.g. 20MAR2010.
  • yyyy-MM-dd – Generates the file name with date stamp in the yyyy-MM-dd format, e.g. 2010-03-20.


The default value is yyyy-MM-dd.

maxsizelimit

Optional

Size in MB, KB, MB or GB

This attribute decides on the maximum file size of a log file considering the rollover period. When the file size exceeds the set value, a new file with same period is generated with rolling index incremented by one. The appender expects size value in "KB", "MB" or "GB". The default value is 10 MB.

suffixorprefix

Optional

LOV

This key expects any one of the following values to create the log file name:

  • SUFFIX – The appender creates the log file name as:<filename><patternSeparator><datePattern><patternSeparator><rollingIndex>.<extension>
  • PREFIX – The appender creates the log file name as:<filename>.<extension><patternSeparator><datePattern><patternSeparator><rollingIndex>

patternseparator

Optional

Any Character

This key provides the character that is used as a separator in the date pattern in the file name.
The default used is – (hyphen).

The following is a sample logger configuration loggerconfig.properties (as per the name given in the default descriptor):

Code Block
languageactionscript3bash
# This configuration provides the information to the CT framework for handling its logging.

# This flag is used to turn on off logging by CT Framework. 
# Turning this off would mean that even Exceptions faced will not be logged to any log file!!!
LOGGING_ENABLED_IND=true 

# This configuration holds the path where the log files are to be created.
# This path configured should be relative to the root path that is configured as 
# CT_WORK_FOLDER_PATH in implementation property file.
log.path=/logs 

# The below configuration is for controlling the logging level.
# Possible values are - debug, error, info, fatal, warn, off. Default if not provided # is "debug".
log.level=info 

# The log.level is set as the default log level for all modules within Canvas.
# In case you want to override at individual module level, then you can use the 
# below options to override the same.
# Module name Canvas Module
# ------------ -----------------------------------
# audit Audit handling module
# alert handling module
# session management layers
# web layer modules
# config Configuration module
# cache framework
# security module
# database module
# entitlement module
# event definition & handling module
# export framework
# vdf Meta data frameworks
# hal Host Access Layer
# report Reporting module
# validator Validation module
# scheduler module 
log.level.audit=debug
log.level.alert=error
log.level.session=info
log.level.web=debug
log.level.config=info
log.level.cache=debug
log.level.security=info
log.level.database=debug
log.level.entitlement=info
log.level.event=debug
log.level.export=debug
log.level.vdf=debug
log.level.hal=debug
log.level.report=debug
log.level.validator=debug
log.level.scheduler=debug 

# Canvas uses Log4J as the internal logging library and uses a RollingFileAppender for handling logging. 
# The following set of configuration apply for how the logging is handled.

# It should be noted the below configuration are optional. The default values if not provided is also 

# indicated against each configuration. 

# The belowfollowing attribute 'rolloverModel' allows to choose any of the 2 models supported by Canvas Log appender namely:

# A. CREATENEW - Current logging would happen in the file name having the current date pattern  
# and the highest rolling index value. (i.e., logging would happen by creating a new file)

# B. BACKUPOLD - Current logging would always happen in file name without date pattern and  
# rolling index, on roll over the current file would be made as a backup with a date pattern and 
# index included in it.

# The default used is BACKUPOLD 
rollovermodel=BACKUPOLD 

# The belowfollowing attribute 'datepattern' decides on the following 2 aspects:

# A. the period when the rollover should happen (i.e.,) daily, monthly, yearly etc.

# For Exampleexample:
 
# yyyy-MM >> Roll over at the beginning of each month

# yyyy-ww >> Roll over at the first day of each week. The first day of the week depends on the locale.

# yyyy-MM-dd >> Roll over at midnight each day.

# yyyy-MM-dd-a >> Roll over at midnight and midday of each day.

# yyyy-MM-dd-HH >> Roll over at the top of every hour.

# yyyy-MM-dd-HH-mm >> Roll over at the beginning of every minute.

# B. The Date format to be displayed in the log file name generated.
# For Example:

# ddMMMyyyy - generates log file name with date stamp in the file name as 20MAR2010

# yyyy-MM-dd - generates log file name with date stamp in the file name as 2010-03-20
# The default used is yyyy-MM-dd.
datepattern=yyyy-MM-dd 

# The belowfollowing attribute 'maxsizelimit' decides on the maximum file size of a log file 
# considering the rollover period.

# For a period if the file size exceeds the set value a new file with same period would 
# be generated with rolling index incremented by one.

# theThe appender expects size value in "KB", "MB" or "GB"

# The default usedvalue is 10MB.
maxsizelimit=10MB 

# theThe appender expects the following 2two options:

# -1. SUFFIX

# -2. PREFIX

# based on which the appender will create the log file name in the following format or pattern:


# a. <filename><patternSeparator><datePattern><patternSeparator><rollingIndex>.<extension> if the suffixOrPrefix option is 'PREFIX'

# Example: serverLogs-2010-03-26-01.log

# b. <filename>.<extension><patternSeparator><datePattern><patternSeparator><rollingIndex> if the suffixOrPrefix option is 'SUFFIX'

# Example: serverLogs.log-2010-03-26-01

# The default value is PREFIX.
suffixorprefix=PREFIX 

# theThe appender expects any character except ':'which that actually separates the date

# pattern in the file name with other components of the file name.

# The default usedvalue is -
patternseparator=-