Log configuration

Logback based Log Configuration 

Caution

Available since 6.4.28 version.

OpenKM uses logback which is a Java-based loggin utility. This is useful, for example when you need to get more information about something that is not working properly in OpenKM, for example third-party application configuration or Spring authentication. By default only log messages with INFO level are shown, but you can increase this log information by raising the log level to WARN or DEBUG. The log configuration file is $TOMCAT_HOME/logbackConfig.xml here you can change the error level message generated by a give class or package.

Note

When OpenKM detect a modification in the logbackConfig.xml file, it will reload it so you don’t need to stop and start OpenKM to make these changes effectives.

Third-party application execution

This is useful when something like a document preview fails, because this way OpenKM will log every external program execution:

<logger name="com.openkm.util" level="DEBUG" />

Enable log authentication

If you need to debug the security configuration, edit the logbackConfig.xml file and add this line:

<logger name="org.springframework.security" level="DEBUG" />

Log4j based Log Configuration 

Caution

Deprecated since 6.4.28 version.

OpenKM uses log4j which is a Java-based loggin utility. This is useful, for example when you need to get more information about something that is not working properly in OpenKM, for example third-party application configuration or Spring authentication. By default only log messages with INFO level are shown, but you can increase this log information by raising the log level to WARN or DEBUG. The log configuration file is $TOMCAT_HOME/conf/log4j.properties here you can change the error level message generated by a give class or package.

Note

When OpenKM detect a modification in the log4j.properties file, it will reload it so you don’t need to stop and start OpenKM to make these changes effectives.

Third-party application execution

This is useful when something like a document preview fails, because this way OpenKM will log every external program execution:

log4j.logger.com.openkm.util.ExecutionUtils=DEBUG

Enable log authentication

If you need to debug the security configuration, edit the log4j.properties file and add this line:

log4j.logger.org.springframework.security=DEBUG