View source for Diag/api-logs

<h1>Web App Activity Logging</h1>
<h2>Introduction</h2>
<p>Activity logging with in the web apps provides a picture of the 
operations which are taking place on the server.&nbsp; This is a different 
function than error logging which provides information only when unexpected 
events occur.&nbsp; Typical activities audited are login / logout events, 
message retrieval, database operations, and IMAP and SMTP operations.&nbsp; 
Activity logs tend to grow quickly, so adequate space should be available on the 
disk for the log, and any log backups.&nbsp; Maximum log sizes may be customized 
per webapp in the log4j.properties file for each.</p>
<h2>SWA</h2>
<p>To enable activity logging for SWA edit the log4j.properties file.  In <= 11.0.3, this file is located at 
<font face="Courier New" size="2">/var/opt/scalix/instance/tomcat/webapps/webmail/WEB-INF/classes/log4j.properties</font>; in 11.0.4+ this files has been relocated to <font face="Courier New" size="2">/var/opt/scalix/instance/webmail/log4j.properties</font>.  Set the log level to INFO or DEBUG for 
each of the '*-ACTIVITY' loggers.&nbsp; INFO is the standard log level used in 
SWA for output.&nbsp; The DEBUG level is used only for large items, such as 
message bodies.</p>
<p><font face="Courier New" size="2"># use a level of INFO or higher to trace activity<br>
log4j.logger.SWA-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.MIME-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.SOAP-ACTIVITY=INFO, rollingActivity</font></p>
<p>Tomcat (<font face="Courier New" size="2">/etc/init.d/scalix-tomcat restart</font>) 
will need to be restarted for the changes to take effect.&nbsp; Using the 
default appender, log output will go to <font face="Courier New" size="2">/var/opt/scalix/instance/tomcat/logs/scalix-swa-activity.log</font>.&nbsp; 
The default maximum size of the log is 20MB, with five previous log files 
retained.</p>

<h2>Platform</h2>
<p>To enable activity / access logging for Platform edit
<font face="Courier New" size="2">/var/opt/scalix/instance/tomcat/webapps/api/WEB-INF/classes/log4j.properties</font> 
to change the log level from the default level of FATAL to INFO or DEBUG for 
each of the '*-ACTIVITY' loggers.&nbsp; INFO is the standard log level used by 
Platform for output.&nbsp; The DEBUG level is used only for large items, such as 
message bodies.</p>
<p><font size="2" face="Courier New"># use a level of INFO or higher to trace activity<br>
log4j.logger.GENERAL-ACTIVITY=INFO, rollingActivity</font></p>
<p><font size="2" face="Courier New">log4j.logger.CALENDAR-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.DISPATCH-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.CONTAINER-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.REST-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.MAILBOX-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.NOTIF-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.DBPOOL-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.IMAP-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.SEARCH-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.DIRECTORY-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.DELIVERY-ACTIVITY=INFO, rollingActivity<br>
log4j.logger.MAPI-ACTIVITY=INFO, rollingActivity</font></p>
<p>Tomcat (<font face="Courier New" size="2">/etc/init.d/scalix-tomcat restart</font>) 
will need to be restarted for the changes to take effect.&nbsp; Using the 
default appender, log output will go to /<font face="Courier New" size="2">var/opt/scalix/instance/tomcat/logs/scalix-api-activity.log</font>.&nbsp; 
The default maximum size of the log is 20MB, with five previous log files 
retained.</p>