Document toolboxDocument toolbox

Logging and Trace Levels

Owned by Matthew Wren
Jan 29, 2024
1 min read

On This Page:

ServiceManager uses the Log4J framework to produce its textual trace files.  These are configured by modifying the logging.properties file located within the svm_properties directory. There are three sections: logger definitions, appenders and patterns:

Logger Definitions

The definition of a logger can have two parameters after the assignment symbol. 

The first defines the level of logging information and can be any of DEBUG, INFO, WARN, ERROR and FATAL. 

The second acts as a notional key for the actual appender in question.

# define the appropriate loggers used within SERVICEManager
# logger responsible for logging within SERVICEManager
#
log4j.logger.com.servicepower.servicemanager=DEBUG, DEBUG
 
# logger responsible for logging from within SERVICEManager's
# authorisation framework (by default this is not used)
#
# log4j.logger.com.servicepower.authorisation=DEBUG, DEBUG
 
# logger responsible for audit information within SERVICEManager
#
log4j.logger.com.servicepower.servicemanager.wal=INFO, AUDIT

Appender Definitions

Appenders control where the log information is written two. 

Each defined logger should have an appender matching the name specified within the logger definition. 

ServiceManager is configured to use a file writing appender.

In the shown appender opposite (used by the com.servicepower.servicemanager logger) DEBUG writes to a cyclic set of tiles

located within Tomcat's logs directory.  The maximum size of each log file will be 10000Kbytes

# DEBUG is set to be a FileAppender.
log4j.appender.DEBUG=org.apache.log4j.RollingFileAppender

# define the location, and name of the log file
# note ${catalina.base} will resolve to Tomcat's base install directory
log4j.appender.DEBUG.File=${catalina.base}/logs/SERVICEManager_trace.log

# how large the file should be
log4j.appender.DEBUG.MaxFileSize=10000KB

# how many backup files to create before cycling
log4j.appender.DEBUG.MaxBackupIndex=5

Pattern Definitions

A pattern definition controls what/how the log information is written to the appender.

See the Log4J web site (http://logging.apache.org/log4j/docs/api/org/apache/log4j/PatternLayout.html) for Layout Patterns.

log4j.appender.DEBUG.layout=org.apache.log4j.PatternLayout
log4j.appender.DEBUG.layout.ConversionPattern=%d{dd
MMM yyyy HH:mm:ss,SSS} [%t] %-5p %c{1} %X{username} %X{action} - %m%n

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Â