Diag/webapp-imap-logs

From Scalix Wiki
Jump to: navigation, search

IMAP Protocol Logging

Note, this facility is present in Scalix versions 11.3 and later for the platform and Scalix versions 11.4.1 and later for SWA. The Platform and SWA have the capability to optionally output the debug logging messages from the IMAP client access library (JavaMail). These messages include all the protocol data exchanged with the IMAP server as well as various diagnostic messages relating to connection management.

Platform

Add this line to the file /var/opt/scalix/<instance>/platform/platform.properties:

jm.debug.enabled=true

Restart scalix-tomcat. Log messages will now appear in the platform log, at the DEBUG level (therefore DEBUG level logging must also be enabled in log4j.properties). The platform log file's default location is /var/opt/scalix/<instance>/tomcat/logs/scalix-api.log

SWA

Add this line to the file /var/opt/scalix/<instance>/webmail/swa.properties:

jm.debug.enabled=true

Restart scalix-tomcat. Log messages will now appear in the platform log, at the DEBUG level (therefore DEBUG level logging must also be enabled in log4j.properties). The platform log file's default location is /var/opt/scalix/<instance>/tomcat/logs/scalix-swa.log SWA also has the ability to selectively enable IMAP protocol logging only for a set of specified users. This is done by adding a line like this to swa.properties:

swa.debug.listOfUsersToLogImap=<list of accounts to log>

Note that the global logging configuration should be turned off when specifying a set of users (if a user is not in the list, then the global setting is used, which would mean that all users would have logging enabled unless the global setting is disabled).