Because the Java Client SDK client code uses the log4j logging mechanism all aspects of
logging can be controlled thru the log4j.xml configuration file. This file should be placed
in the directory from which the client program is launched. A sample of the log4j.xml file
that is used by the Avaya sample client can be found in
IC_INSTALL_DIR\IC71\sdk\design\java\sample\config. Copy this file to the custom client's
directory. For more information on the log4j logging mechanism see
http://logging.apache.org/log4j/docs. What follows is a short discussion along with examples
for manipulating the most common elements of logging: setting the log level, creating
application specific loggers and causing the logs to go to a file.
Application specific loggers can be created that control custom code log statements
separately from Client SDK client log statements. Simply add an entry similar to the one
below to the log4j.xml file.
<!-- custom client code -->
<logger name="myclient" additivity="false">
<level value ="info"/>
<appender-ref ref="DebugAppender"/>
</logger>
Then, in the application code, open this logger like this:
import org.apache.log4j.Logger;
public static void main(String[] args) {
Logger mylogger = Logger.getLogger("myclient");
logger.debug("test log message");
}
This will produce a log message (provided that the log level is set at least to debug level)
to the effect of:
2006-06-01 10:19:01,045|DEBUG|myclient|main|test log message
By convention it is common and useful to encode the class name in the log message. This can
easily be done with the following technique:
<!-- custom client code -->
<logger name="com.mycompany.crm.client" additivity="false">
<level value ="info"/>
<appender-ref ref="DebugAppender"/>
</logger>
This assumes that the root path to the custom application classes is
com.mycompany.crm.client. Then open the logger as follows:
public class myclass {
import org.apache.log4j.Logger;
public static void main(String[] args) {
Logger mylogger = Logger.getLogger(myclass.class.getname());
logger.debug("test log message");
}
}
Because the log4j logger uses a partial match of the logger name when choosing the logger
definition, this produces:
2006-06-01 10:19:01,076|INFO |com.mycompany.crm.client.myclass|main||||test log message
The sample log4j.xml file defaults to sending Java log messages to the console. Log messages
can be configured to go to a file by modifying the definition of the Appenders. The
log4j.xml delivered with the sample client has the definition for writing to a file
commented out. So simply comment out the definition for the console and uncomment the
definition for using a file as follows:
<!--appender name="DebugAppender" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{ISO8601}|%-5p|%c|%t|%m%n"/>
</layout>
</appender-->
<appender name="DebugAppender" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="logs/AvayaSDKSampleClientDebug.log"/>
<param name="MaxBackupIndex" value="250"/>
<param name="MaxFileSize" value="20MB"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{ISO8601}|%-5p|%c|%t|%m%n"/>
</layout>
</appender>
An application specific Appender can be created for handling custom application log
statements separately by copying the above Appender definition and changing the Appender
"name" attribute and the "File" value. Then reference this Appender in the logger
definition.
<appender name="myAppender" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="logs/myClientDebug.log"/>
<param name="MaxBackupIndex" value="250"/>
<param name="MaxFileSize" value="20MB"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{ISO8601}|%-5p|%c|%t|%m%n"/>
</layout>
</appender>
<!-- custom client code -->
<logger name="com.mycompany.crm.client" additivity="false">
<level value ="info"/>
<appender-ref ref="myAppender"/>
</logger>
To manipulate the log level, change the "value" attribute of the level tag in the logger
definition. The possible values are: debug, info, warn, error, fatal.
Last Release: 7.3.10 (Aug 2021)
