This space contains the old OpenAthens SP documentation and is no longer maintained.
OpenAthens SP software is already out of support and will reach end of life in May 2020.

Check out OpenAthens Keystone instead. It's supercool and makes dealing with SAML much easier.

Search

Skip to end of metadata
Go to start of metadata

OpenAthens SP uses commons-logging to generate log messages to three channels

uk.org.eduserv

Messages from the underlying OpenAthens SP platform.

atacama.enterprise.protocol.log

Protocol level messages, including the xml messages that are passed between OpenAthens SP and the users' Identity Providers.

atacama.enterprise.log.module

Written to by the LogModule as configured via the atacama configuration. The default configuration file served via the OpenAthens SP Dashboard uses this module to surface audit type messages indicating whether or not a user successfully logged in.

Log4J

Configuration

Log4j can be configured using using one of two files (log4j.properties or log4j.xml), examples below. Prior to creating either you will need to create a new Classes directory in the WEB_INF directory or equivalent, e.g:

C:\Program Files (x86)\Apache Software Foundation\Tomcat 7.0\webapps\ROOT\WEB-INF

Your log4j.xml or log4j.properties, AND your log4j.jar files should all be placed in this new Classes directory.

..\path\log4j.xml
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
 
  <!-- APPENDERS -->
 
  <!--
  ########################################################################
  Appender for the platform logs.
  The Webserver user will need write access to the 
  C:/program files/atacama-platform/logs/ directory. 
  ########################################################################
  -->
  <appender name="platform" class="org.apache.log4j.RollingFileAppender">
    <param name="file" value="C:\Program Files (x86)\atacama-platform\logs\atacama-platform.log"/>
    <param name="MaxFileSize" value="1MB"/>
    <param name="MaxBackupIndex" value="10"/>
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="[%d{dd MMM yyyy HH:mm:ss}] %-5p %c{1} (%L) - %m%n"/>
   </layout>
  </appender>
 
  <!--
  ########################################################################
  Appender for the protocol logs.
  The Webserver user will need write access to the 
  C:/program files/atacama-platform/logs/ directory.
  ########################################################################
  -->
  <appender name="protocol" class="org.apache.log4j.RollingFileAppender">
    <param name="file" value="C:\Program Files (x86)\atacama-platform\logs\atacama-protocol.log"/>
    <param name="MaxFileSize" value="1MB"/>
    <param name="MaxBackupIndex" value="10"/>
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="[%d{dd MMM yyyy HH:mm:ss}] %-5p %c{1} (%L) - %m%n"/>
    </layout>
  </appender>
 
  <!--
  ########################################################################
  Appender for the audit (log module) logs.
  The Webserver user will need write access to the 
  C:/program files/atacama-platform/logs/ directory.
  ########################################################################
  -->
  <appender name="audit" class="org.apache.log4j.RollingFileAppender">
    <param name="file" value="C:\Program Files (x86)\atacama-platform\logs\atacama-audit.log"/>
    <param name="MaxBackupIndex" value="10"/>
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="[%d{dd MMM yyyy HH:mm:ss}] %-5p %c{1} (%L) - %m%n"/>
    </layout>
  </appender>
 
  <!-- LOGGERS -->
 
  <!--
  ########################################################################
  Write the platform messages as info level
  ########################################################################
  -->
  <logger name="uk.org.eduserv">
    <level value="info" />
    <appender-ref ref="platform" />
  </logger>
 
  <!--
  ########################################################################
  Write the protocol messages at debug level
  ########################################################################
  -->
  <logger name="atacama.enterprise.protocol.log" additivity="false">
    <level value="debug" />
    <appender-ref ref="protocol" />
  </logger>
 
  <!--
  ########################################################################
  Write the audit messages at debug level
  ########################################################################
  -->
  <logger name="atacama.enterprise.log.module" additivity="false">
    <level value="debug" />
    <appender-ref ref="audit"/>
  </logger>
 
</log4j:configuration>

 

 

..\path\log4j.properties
# Platform logger
# The Webserver user will need write access to the 
# C:\Program Files (x86)\atacama-platform\logs\ directory.

log4j.logger.uk.org.eduserv=info,PLATFORM
log4j.appender.PLATFORM=org.apache.log4j.RollingFileAppender
log4j.appender.PLATFORM.File=C:\Program Files (x86)\atacama-platform\logs\atacama-platform.log
log4j.appender.PLATFORM.MaxFileSize=100KB
log4j.appender.PLATFORM.MaxBackupIndex=1
log4j.appender.PLATFORM.layout=org.apache.log4j.PatternLayout
log4j.appender.PLATFORM.layout.ConversionPattern=%p %t %c - %m%n
 
# Protocol logger
# The Webserver user will need write access to the 
# C:\Program Files (x86)\atacama-platform\logs\ directory.

log4j.logger.atacama.enterprise.protocol.log=debug,PROTOCOL
log4j.appender.PROTOCOL=org.apache.log4j.RollingFileAppender
log4j.appender.PROTOCOL.File=C:\Program Files (x86)\atacama-platform\logs\atacama-protocol.log
log4j.appender.PROTOCOL.MaxFileSize=100KB
log4j.appender.PROTOCOL.MaxBackupIndex=1
log4j.appender.PROTOCOL.layout=org.apache.log4j.PatternLayout
log4j.appender.PROTOCOL.layout.ConversionPattern=%p %t %c - %m%n
 
# Audit logger
# The Webserver user will need write access to the 
# C:\Program Files (x86)\atacama-platform\logs directory.

log4j.logger.atacama.enterprise.log.module=debug,AUDIT
log4j.appender.AUDIT=org.apache.log4j.RollingFileAppender
log4j.appender.AUDIT.File=C:\Program Files (x86)\atacama-platform\logs\atacama-audit.log
log4j.appender.AUDIT.MaxFileSize=100KB
log4j.appender.AUDIT.MaxBackupIndex=1
log4j.appender.AUDIT.layout=org.apache.log4j.PatternLayout
log4j.appender.AUDIT.layout.ConversionPattern=%p %t %c - %m%n


 

 

 

 

 

  • No labels