CoreMedia Digital Experience Platform 8 Developer Manual, Version 7.5.45-10
4.3.7. Adding Common Infrastructure Components | 4.3.7.1. The Logging Component

This component provides a common logging infrastructure based on the logback framework. The component adds some new features:

Adding the Logging Component

You can simply add the CoreMedia logging component to your CoreMedia web application as described below. For your custom services and code, you should use slf4j as a logging interface. When using the logging component, slf4j will be automatically bound to the logback logger implementation.

Adding dependency

Adding the component simply consists of adding the following dependency to your web application's project:

<dependency>
 <groupId>com.coremedia.cms</groupId>
 <artifactId>logging-component</artifactId>
 <scope>runtime</scope>
</dependency>

Adding log configuration

If you want to use your own log configuration, add a file /WEB-INF/logback.xml to your application that looks like the following:

<configuration>
  <!--
    includes a common configuration that dispatches to
    "coremedia-development-profile.xml"
    or
    "coremedia-production-profile.xml" depending
    on property "coremedia.logging.profile".

    You can define a custom log pattern ("log.pattern") or a custom log file name ("log.file") like this:
    <property name="log.pattern" value="%d %-7([%level]) %logger - [%X{tenant}] %message \\(%thread\\)%n" />

  -->
  <include resource="logging-common.xml"/>

  <!-- adds project specific logger and references a common appender -->
  <logger name="com.coremedia" additivity="false" level="info">
    <appender-ref ref="file"/>
  </logger>

  <root level="warn">
    <appender-ref ref="file"/>
  </root>
</configuration>

Changing log directory

By default, logs are written in the ./logs directory. If you want to change this directory you have to either pass a system property coremedia.logging.directory or a JNDI property java:comp/env/coremedia/logging/directory to the application. For example, when you use Tomcat you can add the following code to context.xml:

<Context ...>
 ...
  <Environment name="coremedia/logging/directory"
   value="./my-log-dir" type="java.lang.String" override="true"/>
 ...
</Context>

See the Tomcat documentation for more details.

Switching the log profile

If you want to switch the logging profile from the default "production" to "development", you have to either set the system property coremedia.logging.profile or the JNDI property java:comp/env/coremedia/logging/profile to the "development" value.

Changing log configuration at runtime

If you want to change the logback configuration during runtime, there are two options: You can either use JMX or logback's automatic reloading mechanism. To let logback reload the configuration, you have to add the scan attribute to the configuration element.

<configuration scan="true" scanPeriod="30 seconds">
  ...
</configuration>

	Note
	Consider that the scan feature only works for configuration loaded from the file system. It does not work for classpath or web application resources. To this end you have to override the property coremedia.logging.configuration and provide a file URL pointing to the logback configuration (such as file:/path/to/logback.xml). The property can be set via JNDI or as system property.