Choosing a Logging Framework

Three logging frameworks are available to plugins:

  • Log4j 1.2.15
  • Commons Logging 1.1.1
  • SLF4J 1.5

We recommend Simple Logging Facade for Java (SLF4J) as a the primary logging framework.

You should ensure that none of these libraries are bundled with your plugin (in META-INF/lib) as this will prevent the host application from logging any of your plugin's log messages.

You can check your plugin's dependencies by using mvn dependency:tree and then exclude any transitive dependencies in the pom.xml:

<exclusions>
   <exclusion>
     <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
  </exclusion>
  <exclusion>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
  </exclusion>
</exclusions>
Was this page helpful?
Powered by Confluence and Scroll Viewport