Logs Analysis

Logging Configuration

Nuxeo logging is compliant with common Java logging frameworks Log4J, SLF4J and JUL.

Logging in Nuxeo is configured through a Log4J XML file: $NUXEO_HOME/lib/log4j.xml

Editing that file, you can set the logging rules (log level per file and component, files rotation, ...).

Log4J log levels are: ERROR, WARN, INFO, DEBUG and TRACE.

You can increase or decrease the logs for specific services. Here are some useful categories:

• org.nuxeo.runtime.deployment.preprocessor.DeploymentPreprocessor logs the pre-processing order,

• org.nuxeo.osgi.application.loader.FrameworkLoader writes the configuration summary,

• org.nuxeo.runtime.osgi.OSGiRuntimeService provides the final startup summary.

Related pages:

• Log4J
• How to change the JBoss log files rotation
• Where Are the Log and Configuration Files in Windows?

Log Files

The log files location depends on the nuxeo.log.dir parameter. By default, Nuxeo generates the following log files (also available from the platform Admin tab and the Control Panel):

• Launcher logs

  • nuxeoctl.log Logs activity from NuxeoCtl.
  • console.log Logs output written to the console (stdout).

• Server logs

  • server.log Server logs.
  • nuxeo-error.log Gathers errors raised to the user.
  • stderr.log Gathers errors written to the console (stderr).
  • classloader.log Gathers class loading errors from Catalina.
  • tomcat.log Gathers Tomcat logs.

Tomcat Specific

$NUXEO_HOME/conf/logging.properties has no effect; you can safely remove it.

Because Tomcat uses java.util.logging of which Log4J is not aware, Tomcat logs (org.apache.catalina.*) have to be redirected to Apache Commons Logging (compliant with Log4J).

Nuxeo provides a bridge for that redirection (in org.nuxeo.common.logging.JavaUtilLoggingHelper) with a default threshold set at INFO level. You can customize it by adding into nuxeo.conf:

JAVA_OPTS=$JAVA_OPTS -Dorg.nuxeo.runtime.redirectJUL.threshold=CONFIG

But that redirection is only available after Nuxeo Framework initialization whereas most of the startup logs from org.apache.catalina happen before (when the redirection is not yet active).

Note also that FINER and FINEST logs will be ignored anyway.

Common Logs

Here are descriptions of the most common logs coming from Nuxeo or its third-parties. The list is not exhaustive but aims at helping to understand the most common logs you may encounter while using the Nuxeo Platform. If you don't find what you need here, you can check answers.nuxeo.com if someone already asked about it. You can also search the web about third parties logs if they are not in this list.