Configuring Email Marketing Server Logging

This topic describes how to configure the type and amount of information that is logged by the Email Marketing Server.

The Email Marketing Server components are Java based applications that use the standard logging library for Java, log4j2, to control the logging behavior for the esd.log, ctd.log, and bhd.log files. You can configure the information that is written to each of the main component log files by editing the log4j2.properties configuration file for each component. This task is described in the following procedure.

To configure Email Marketing Server logging

1. Using a text editor, open the log4j2.properties file for the component for which you want to configure logging.

   The log4j2.properties file is located in the lib folder of the main installation directory for each of the ESD, CTD, and BHD components.

2. The Email Marketing Server logs information for specific SMPT classes, and logging levels are set for each SMTP class.

   For example, the following line in the log4j2.properties file records details in the log file of each individual to whom an email was successfully delivered:

     log4j.logger.com.siebel.sem.smtp.MailingState=DEBUG
   

   In the previous command, smtp.MailingState is the SMTP class that is logged and DEBUG is the log level. If you choose, you can enable logging for all SMTP classes by adding the following line to the end of the log4j2.properties file for a component:

     log4j.logger.com.siebel.sem.smtp=DEBUG
   

3. To change the amount of information that is logged for a class, navigate to the statement in the log4j2.properties file that enables logging for the class, then set the logging level to one of the following values, where DEBUG3 generates the maximum amount of information in the log file and FATAL generates the minimum amount of information:

   • Trace

   • All

   • DEBUG

   • INFO

   • WARN

   • ERROR

   • FATAL

   • OFF

   In general, set log levels to DEBUG only when you are running the Email Marketing Server for debugging purposes. Running a component with DEBUG levels of logging can impact the performance of the component.

4. To configure the size of the component log files, and the number of archived log files maintained by the Email Marketing Server, edit the log4j2.properties file to specify values for the following parameters:

   • #appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
     #appender.rolling.policies.time.interval = 2
     #appender.rolling.policies.time.modulate = true

   • appender.rolling2.policies.size.type = SizeBasedTriggeringPolicy
     appender.rolling2.policies.size.size=1MB
     appender.rolling2.strategy.type = DefaultRolloverStrategy
     appender.rolling2.strategy.max = 5

5. To archive the component log files based on the time interval, edit the log4j2.properties file and configure the parameters as follows:

   • appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
     appender.rolling.policies.time.interval = 2
     appender.rolling.policies.time.modulate = true

   • #appender.rolling2.policies.size.type = SizeBasedTriggeringPolicy
     #appender.rolling2.policies.size.size=1MB
     #appender.rolling2.strategy.type = DefaultRolloverStrategy
     #appender.rolling2.strategy.max = 5

For additional information on logging, see Setting Up Administrator Alerts for Email Marketing and About Email Marketing Log Files.