Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

tia Core uses Log4J2 Framework for logging. So the general documentation of this framework applies.

External link to the Apache Log4J project web page: https://logging.apache.org/log4j/2.x/

 

Log rotation can be configured by Log4J2 appender or on Linux using utilities like logrotate (external link: https://linux.die.net/man/8/logrotate). logrotate utility is not shipped with the tia Core cloud image and therefore not available for cloud deployment.

By default, tia Core implements log rotation using Log4Js RollingFileAppender (see file <webapp>\WEB-INF\classes\log4j2.xml):

·        tia Core writes the log file core-of-tia.log in the logs sub directory of the web application base directory.

·        At 0:00am and in case the log file exceeds 1GB, it is gz-compressed and renamed to core-of-tia-<n>.log.gz.

·        Up to 10 compressed log files will be kept before removal.

 

Use Spring Boot 2 configuration to specify the location of a custom log4j2.xml file and to specify log level for specific components overruling the default settings in the file.

 

Best practice for modifications to Log4J2 configuration is to copy existing log4j2-spring.xml file to a custom version (e.g. my.log4j2.xml) that then is modified and linked in by setting logging.conf parameter (see below).

 

tia Core builds also on top of Spring Boot 2 framework, so that at the start of the system, the configuration is applied via this framework.

External link to the Spring Framework web page: https://spring.io/projects/spring-boot

The required parameters are listed below:

Key

Description

Supported Values

Required

logging.level.<package>

Definition of the log level for the package

OFF; ERROR; WARN; INFO; DEBUG

n

logging.config

Specifies a location for the log4j2.xml to be used instead of the default

A path specified absolute or relative to the working directory of tomcat service, e.g. <tomcat installation directory>/bin.

n

 

How exactly to specify these parameters depends on the deployment option selected.

Note: kgs recommends to stick with the described best practice configuration described in the subchapters to this topic. It is possible that more advanced configuration may lead to system behavior that is hard to analyze.

Especially, it is not advisable to modify the parameter spring.config.location, as tia Core default configuration then may not be applied.

  • No labels