Logging

Search…
Logging
Introduction
Orbeon Forms uses log4j for logging and has a logging configuration file under WEB-INF/resources/config/log4j.xml.
Selecting a specific file path
By default, logging information is output to a file path relative to the directory where you start your application server. This is usually not what you want, as that makes it hard to know where the log file is.
1
<appender name="SingleFileAppender" class="org.apache.log4j.FileAppender">
2
    <param name="File" value="../logs/orbeon.log"/>
3
    <param name="Append" value="false" />
4
    <param name="Encoding" value="UTF-8"/>
5
    <layout class="org.apache.log4j.PatternLayout">
6
        <param name="ConversionPattern" value="%d{ISO8601} %-5p %c{1} %x - %m%n"/>
7
    </layout>
8
</appender>
Copied!
You can change this by modifying the File parameter and set an absolute file path to the log file:
1
<appender name="SingleFileAppender" class="org.apache.log4j.FileAppender">
2
    <param name="File" value="/path/to/logs/orbeon.log"/>
3
    <param name="Append" value="false" />
4
    <param name="Encoding" value="UTF-8"/>
5
    <layout class="org.apache.log4j.PatternLayout">
6
        <param name="ConversionPattern" value="%d{ISO8601} %-5p %c{1} %x - %m%n"/>
7
    </layout>
8
</appender>
Copied!
Note that on Windows, you must use forward slashes:
1
<appender name="SingleFileAppender" class="org.apache.log4j.FileAppender">
2
    <param name="File" value="C:/My Path/To/Logs/orbeon.log"/>
3
    <param name="Append" value="false" />
4
    <param name="Encoding" value="UTF-8"/>
5
    <layout class="org.apache.log4j.PatternLayout">
6
        <param name="ConversionPattern" value="%d{ISO8601} %-5p %c{1} %x - %m%n"/>
7
    </layout>
8
</appender>
Copied!
The benefit of changing this configuration is that you know exactly where the file is stored. This can be really handy when trying to troubleshoot issues.
Reducing the amount of logging
By default, Orbeon Forms logs quite a lot of information at the info level. In case this is too much, you can set the level to warning or even error:
1
<appender name="SingleFileAppender" class="org.apache.log4j.FileAppender">
2
    <param name="File" value="/path/to/logs/orbeon.log"/>
3
    <param name="Append" value="false" />
4
    <param name="Encoding" value="UTF-8"/>
5
    <layout class="org.apache.log4j.PatternLayout">
6
        <param name="ConversionPattern" value="%d{ISO8601} %-5p %c{1} %x - %m%n"/>
7
    </layout>
8
    <filter class="org.apache.log4j.varia.LevelRangeFilter">
9
        <param name="LevelMin" value="error"/>
10
    </filter>
11
</appender>
Copied!
See also
​XForms logging​
​Relational database logging​
Installation
Tomcat
Last modified 2yr ago
Copy link
Contents
Introduction
Selecting a specific file path
Reducing the amount of logging