Wikiadmin: Created page with "{{(!)| Starting from '''PR19Q1''' Openbravo uses [https://logging.apache.org/log4j/2.x/ log4j2] for logging. If you're using this version or newer, please refer to How_To_Co..."

2021-12-16T01:05:54Z

Created page with "{{(!)| Starting from '''PR19Q1''' Openbravo uses [https://logging.apache.org/log4j/2.x/ log4j2] for logging. If you're using this version or newer, please refer to How_To_Co..."

New page

{{(!)| Starting from '''PR19Q1''' Openbravo uses [https://logging.apache.org/log4j/2.x/ log4j2] for logging. If you're using this version or newer, please refer to [[How_To_Configure_Log]] to configure log using log4j 2.x. }}
== Introduction ==

Logging allows developers to insert messages when code is executed, these messages can be used to understand different issues in the backend code, such as errors, performance problems, etc.

Openbravo uses [http://logging.apache.org/log4j/1.2/ log4j] to log.

== Configuration ==

Logging is configured by <code>log4j.lcf</code> file in Openbravo's <code>config</code> directory.

=== File ===

Typically log is redirected to a file. This file is determined by log4j.appender.*.File property. The defaults are:

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=${catalina.base}/logs/openbravo.log

log4j.appender.HB=org.apache.log4j.RollingFileAppender
log4j.appender.HB.File=${catalina.base}/logs/openbravo_hibernate.log

With this configuration, regular log will be placed in <code>openbravo.log</code> file in tomcat's log directory and log for hibernate will be in the same directory in <code>openbravo_hibernate.log</code> file.

=== Log Verbosity ===

Verbosity in the log is defined by the log levels:

ERROR
WARN
INFO
DEBUG

Developer decides which is the level of each of the messages sent to the log.

It is possible to configure the log to display messages starting from any of these levels. Default configuration shows INFO and above. Log level can be configured globally and/or per class/package.

This can be modified in 2 ways:

* In <code>log4j.lcf</code>, it requires to deploy the changes (<code>ant smartbuild</code>) and restart Tomcat after modifying.
** Globally: Change <code>log4j.rootCategory='''INFO'''</code> to the desired level.
** Per Java class or package: add lines like <code>log4j.category.''your.path.here''=DEBUG</code> where <code>''your.path''</code> is the fully qualified class name or pacakage.
* At runtime. The change doesn't require Tomcat to be restarted to be effective, but after restarting it configuration will be read from <code>log4j.lcf</code> and changes will be lost. To do it, log in the application as System Administrator, open ''Session Preferences'' window, click on ''Change Logs'' button, select the class you want to modify the log level for, select log level and click on ''Process'' button.

[[Image:Log-config.png|center|600px]]

== Rotation ==
In order to prevent log file to constantly increase, rotation is defined. Rotation sets up the policy to decide when log file will be archived and how many archives will be maintained.

It is configured with the following properties:

log4j.appender.R.MaxFileSize=10000KB
log4j.appender.R.MaxBackupIndex=10

In this example, log file will have at most 10MB. When this size is reached, current log is archived and a new log empty file is created, it will also keep up to 10 files, so when a new archive is created, the oldest existing one will be deleted.

[[Category:HowTo]]

How To Configure Log Using Log4j1.x - Revision history

Wikiadmin: Created page with "{{(!)| Starting from '''PR19Q1''' Openbravo uses [https://logging.apache.org/log4j/2.x/ log4j2] for logging. If you're using this version or newer, please refer to How_To_Co..."