Basic Rules

As of release 3.8, Atomikos uses any existing logging frameworks found by these rules :

• any implementation of SLF4J that can be found in the classpath (e.g., Logback), or
• if not found and Log4J is available in the classpath, then Log4J will be used, or
• otherwise, the built-in JDK logging is used

Log Levels

We use the following log level conventions:

Release 4.0 and higher

• FATAL: situations that probably require 1st line support attention - like (re)start errors. You probably want to let Atomikos know about these.
• ERROR: situations that require at least 2nd / 3rd line support attention - like heuristic exceptions. You probably want to let Atomikos know about these.
• WARN: situations that require developer attention as soon as time allows. You probably want to let Atomikos know about these.
• INFO: normal system messages indicating normal system operation.
• DEBUG: shows what is going on across APIs so per-transaction details are shown. Only produce these when asked by Atomikos support.
• TRACE: everything else, mostly inner workings of the Atomikos software. You probably only want these when asked by Atomikos support.

Pre-4.0

• WARN: abnormal situations
• INFO: shows what is going on across APIs so per-transaction details are shown
• DEBUG: everything else

Configuration Examples

Logback

<configuration>

  <!-- Optional: to enable JMX setting of log levels 
       cf http://logback.qos.ch/manual/jmxConfig.html -->
  <jmxConfigurator/> 

  <appender name="ATOMIKOS" class="ch.qos.logback.core.FileAppender">
    <file>tm.out</file>
    <append>true</append>

    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>

 <logger name="com.atomikos" level="WARN">
    <appender-ref ref="ATOMIKOS" />
  </logger>

</configuration>

Log4J

log4j.appender.Atomikos = org.apache.log4j.RollingFileAppender
log4j.appender.Atomikos.File = tm.out
log4j.appender.Atomikos.MaxFileSize = 100KB
log4j.appender.Atomikos.Append = false
log4j.appender.Atomikos.layout = org.apache.log4j.PatternLayout
log4j.appender.Atomikos.layout.ConversionPattern=%p %t %c - %m%n
log4j.logger.com.atomikos=WARN, Atomikos

Log4J2

<Configuration package="log4j.test" status="WARN">
   <Appenders>
      <Console name="Console" target="SYSTEM_OUT">
         <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
      </Console>
   </Appenders>
   <Loggers>
      <Logger name="com.atomikos" level="trace">
         <AppenderRef ref="Console" />
      </Logger>
      <Root level="trace">
         <AppenderRef ref="Console" />
      </Root>
   </Loggers>
</Configuration>

JDK logging

Note: This solution seems to disallow a separate file for separate loggers. In order to reproduce a separate tm.out you would need a Tomcat/apache utility library - see http://tomcat.apache.org/tomcat-5.5-doc/logging.html

# Set the default logging level for the logger named com.mycompany
com.atomikos.level = WARNING
com.atomikos.handlers = java.util.logging.FileHandler

java.util.logging.FileHandler.pattern=tm.out

java.util.logging.FileHandler.limit=50000

com.atomikos.useParentHandlers=false

java.util.logging.FileHandler.count=1
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Logging for the TCC Coordinator Service (4.0.48 and later releases)

By default, the TCC coordinator service starts with INFO logging enabled. To change this:

Create a custom log4j logging file called "log4j.properties"

log4j.rootCategory=info, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout.ConversionPattern=[%30.30c{1}] - %m%n
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

Launch the service

java -Dlog4j.configuration=file:log4j.properties -jar transactions-tcc-rest.jar 8080