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/
It is best practice for modifications to Log4J2 configuration 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.
...
Info |
---|
This article focuses on container-deployment of tia® Core products. |
By default, tia® Core logs to Standard out
.
There it may be read by observability tools.
Info | ||
---|---|---|
Hint: Logs written to
Using this command with option |
Custom configuration
The log level can be configured for the complete product (parameter logging.level.root
), or for a special module only (parameter logging.level.<package>
).
The log row format, the log location, and other can be configured in a log configuration file (the default file shipped with the product is logback-spring.xml
). It is recommended to create a new logging configuration file. Use parameter logging.config
to point to the custom configuration file.
Info |
---|
The logging framework included in tia® Content Server Core is SLFJ4-compliant. For documentation refer to the https://www.slf4j.org/manual.html. Since tia® Content Server Core Release 3.0.0 this is Logback framework (see https://logback.qos.ch/). |
tia® Content Server Core parameters for logging:
Parameter | Description | Supported Values | Required | Default value |
|
| Log Level for all logging. If log level for package is configured, package configuration will overrule. Recommended for Production is WARN or ERROR. |
| no |
|
|
Example:
| Definition of the log level for the package.
|
|
|
|
|
| no |
|
| Specifies a location for the configuration file of the logging framework |
A path specified absolute or relative to the working directory of web application server (e.g. for a Tomcat installation this is typically: <tomcat installation directory>/bin
).
no
.
| Path and filename | no |
|
For more information how to apply these parameters, please read Application wide settings.
Log rotation
In production systems, log files can grow large over time and consume disc space as well. Also handling of large log files for issue analysis is getting more difficult. Log rotation refers to an automatic set up to periodically or on trigger event (like log file exceeds a specified size) copy log files aside and keep only a certain number of copies.
Log rotation can be configured by Log4J2 appender.
By default, tia Core implements log rotation using Log4Js RollingFileAppender (see file <webapp>\WEB-INF\classes\log4j2.xml
) like this:
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.
...
Note: Utilities like logrotate for Linux (external link: https://linux.die.net/man/8/logrotate) provide similiar functionality on operating system level.
...
For example logging configuration files see: