analytics/configuration/ipfclientconfig.xml.template

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM

    IBM Cognos Products: ccllogging

    (C) Copyright IBM Corp. 2005, 2010

    US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
	<renderer renderedClass="com.cognos.indications.LogIndication" renderingClass="com.cognos.indications.LogIndicationRenderer"/>
	<renderer renderedClass="com.cognos.indications.LogAuditIndication" renderingClass="com.cognos.indications.LogAuditRenderer"/>
	<renderer renderedClass="com.cognos.indications.LogAuditAccessIndication" renderingClass="com.cognos.indications.LogAuditAccessRenderer"/>
	<renderer renderedClass="com.cognos.indications.LogPerfIndication" renderingClass="com.cognos.indications.LogPerfRenderer"/>
	<renderer renderedClass="com.cognos.indications.LogTraceIndication" renderingClass="com.cognos.indications.LogTraceRenderer"/>
	<renderer renderedClass="com.cognos.indications.LogValueTraceIndication" renderingClass="com.cognos.indications.LogValueTraceRenderer"/>
	<!-- This appender is used to log output to stdout -->
	<!--appender name="clientSTDOUT" class="org.apache.log4j.ConsoleAppender">
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%m%n"/>
		</layout>
	</appender-->
	<!-- This file appender contains a filter, i.e. only the WARN level logs can be logged to this appender. -->
	<!--appender name="fileWithFilter" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="../logs/cogclientWarn.log"/>
		<param name="MaxBackupIndex" value="1"/>
		<param name="MaximumFileSize" value="10485760"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%m%n"/>
		</layout>
		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<param name="LevelMin" value="WARN"/>
			<param name="LevelMax" value="WARN"/>
		</filter>
	</appender-->
	<!--______________________________________________________________________________________-->
	<!--                                                                                                                                                                             -->
	<!--    Developers: Change the appender name below to use your component short name       		         -->
	<!--                                                                                                                                                                            -->
	<!--______________________________________________________________________________________-->
	<appender name="ipfLocalFile" class="org.apache.log4j.RollingFileAppender">
		<!--______________________________________________________________________________________-->
		<!--    Developers: Change the log file name (e.g. cogIPF.log) below to use your component short name              -->
		<!--______________________________________________________________________________________-->
		<!--______________________________________________________________________________________-->
		<!--    The setting for the File attribute below has been tested with ReportNet while running under Tomcat.         -->
		<!--    For other application servers (e.g. WebLogic),  because of their COG_ROOT setting, the below                -->
		<!--    file attribute  may require that an absolute path to the log file be specified. Ensure the log directory is writable.  -->
		<!--    For a distributed install on a single machine ensure only one application writes to any given log file           -->
		<!--______________________________________________________________________________________-->
		<param name="File" value="../logs/cogIPF.log"/>
		<!--______________________________________________________________________________________-->
		<!--    The "MaxBackupIndex" is set to 10, which means up to 10 backup log files will be kept,       -->
		<!--    with logfilename.1, logfilename.2, etc. This will keep more log data but take more disk space.  -->
		<!--    To save the disk space, please set this value to a smaller number.     -->
		<!--______________________________________________________________________________________-->
		<param name="MaxBackupIndex" value="10"/>
		<param name="MaximumFileSize" value="10485760"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%m%n"/>
		</layout>
	</appender>
	<appender name="clientRemote" class="com.cognos.indications.LogLocalUDPAppender">
		<!--______________________________________________________________________________________-->
		<!--                                                                                                                                                                             -->
		<!--    Change the Port value below to match the Log Server Port Number in Cognos Configuration                       -->
		<!--                                                                                                                                                                            -->
		<!--______________________________________________________________________________________-->
		<param name="Port" value="9362"/>
	</appender>
	<appender name="clientTCP" class="com.cognos.indications.LogTCPSocketAppender">
		<param name="remoteHost" value="127.0.0.1"/>
		<!--______________________________________________________________________________________-->
		<!--                                                                                                                                                                             -->
		<!--    Change the Port value below to match the Log Server Port Number in Cognos Configuration                       -->
		<!--                                                                                                                                                                            -->
		<!--______________________________________________________________________________________-->
		<param name="Port" value="9362"/>
		<param name="LocationInfo" value="false"/>
		<param name="ReconnectionDelay" value="30000"/>
	</appender>
		<!--______________________________________________________________________________________-->
		<!--                                                                                                                                                                             -->
		<!--    Specify a conversion pattern to define the indication fields to be rendered in the log file                       	-->
		<!--			C U R R E N T L Y    T H I S    I S    A    J A V A    O N L Y    F E A T U R E											-->
		<!--    Specify one conversion pattern for each type of logging indication									                       	-->
		<!--    Conversion patterns start with the percent sign, followed by three characters					                      	-->
		<!--    Literals are also supported                       																									-->
		<!--      Valid  conversion specifiers are:                                                                                                               	-->
		<!--      IPA	-	ip address (header)																														-->
		<!--      PRT	-	port (header)																																	-->
		<!--      PID	-	process ID (header)																														-->
		<!--      TST	-	timestamp (header)																															-->
		<!--      TZN	-	timezone (header)																															-->
		<!--      SID	-	session ID (header)																														-->
		<!--      RID	-	request ID (header)																														-->
		<!--      SUD	-	subrequest ID (header)																													-->
		<!--      STD	-	step ID (header)																																-->
		<!--      TID	-	thread ID (header)																															-->
		<!--      CID	-	component ID (header)																													-->
		<!--      BNM	-	build number (header)																													-->
		<!--      LVL	-	logging level (header)																														-->
		<!--      LOG	-	logger name (header)																														-->
		<!--      OPP	-	operation (audit indications)																											-->
		<!--      OBT	-	object type (aidit access and trace indications)																				-->
		<!--      OBP	-	object path (audit access indications)																							-->
		<!--      STA	-	status (audit access and performance indications)																		-->
		<!--      ERR	-	error message (audit access indications)																						-->
		<!--      LDA	-	logged data (all indication)																												-->
		<!--      RES	-	resource ID (performance indications)																							-->
		<!--      CPU	-	CPU counter (performance indications)																							-->
		<!--      MEM	-	memory counter (performance indications)																					-->
		<!--      DOP	-	diskops counter (performance indications)																					-->
		<!--      DIO	-	diskIO counter (performance indications)																						-->
		<!--      COP	-	commops counter (performance indications)																					-->
		<!--      CIO	-	commio counter (performance indications)																					-->
		<!--      EPT	-	elapsed time (performance indications)																							-->
		<!--      CLS	-	class ID (performance indications)																									-->
		<!--      MID	-	message ID (performance indications)																							-->
		<!--      SEQ	-	sequence ID (performance indications)																							-->
		<!--      EID	-	execution ID (performance indications)																							-->
		<!--      NAM	-	name (trace indications)																													-->
		<!--      VAL	-	value (trace indications)																													-->
		<!--______________________________________________________________________________________-->
	<appender name="cogclientWithIPFLayout" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="../logs/crnclientWithIPFLayout.log"/>
		<param name="MaxBackupIndex" value="1"/>
		<param name="MaximumFileSize" value="10485760"/>
		<layout class="com.cognos.indications.LogIPFIndLayout">
			<param name="TraceConversionPattern" value="Logger=%LOG\tTimestamp=%TST\tData=%LDA\n"/>
			<param name="AuditConversionPattern" value="%TST %LOG %OPP %LDA\n"/>
			<param name="AuditAccessConversionPattern" value="%TST %LOG %OPP %OBT %OBP %STA %ERR %LDA\n"/>
		</layout>
	</appender>
	<appender name="cogclientTraceDataOnly" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="../logs/crnclientWithIPFLayout.log"/>
		<param name="MaxBackupIndex" value="1"/>
		<param name="MaximumFileSize" value="10485760"/>
		<layout class="com.cognos.indications.LogIPFIndLayout">
			<param name="TraceConversionPattern" value="%LDA\n"/>
		</layout>
	</appender>
	
	<!--______________________________________________________________________________________-->
	<!--                                                                                                                                                                             -->
	<!--    This appender contains a special filter which is used to filter the IPF loggings on certain user, i.e. only the indications  -->
	<!--   which are logged by a perticular user will be logged to this appender, others will be dropped.                     -->
   	<!--                                                                                                                                                                            -->
	<!--    To use this feature, just add this appender to the categories you are insterested in.  -->
   	<!--    For example, the category "Perf.IPF.Traceme" will only log to dyetrace_output.log file for specified user.   -->
   	<!--                                                                                                -->
	<!--______________________________________________________________________________________-->	
	<appender name="DyeTraceOutput" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="../logs/dyetrace_output.log"/>
		<param name="MaxBackupIndex" value="1"/>
		<param name="MaximumFileSize" value="10485760"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%m%n"/>
		</layout>
		<filter class="com.cognos.indications.LogIPFDyeTraceFilter"/>		
	</appender>
	
	<!--______________________________________________________________________________________-->
	<!--                                                                                                                                                                             -->
	<!--    For the next three categories, do not change the name attribute. Nor the level values.		         -->
	<!--                                                                                                                                                                            -->
	<!--______________________________________________________________________________________-->
	<category name="Audit" class="com.cognos.indications.LogTypedLogger">
		<level value="warn"/>
		<!--______________________________________________________________________________________-->
		<!--                                                                                                                                                                             -->
		<!--    Change the appender refence below to match the Log Server Enable TCP in Cognos Configuration            -->
		<!--    If Enable TCP is False, use clientRemote; otherwise use clientTCP                                                                 -->
		<!--______________________________________________________________________________________-->
		<appender-ref ref="clientRemote"/>
	</category>
	<category name="Trace" class="com.cognos.indications.LogTypedLogger">
		<level value="off"/>
	</category>
	<category name="Perf" class="com.cognos.indications.LogTypedLogger">
		<level value="off"/>
	</category>
	<!--______________________________________________________________________________________-->
	<!--                                                                                                                                                                             -->
	<!--    Developers: Add below your application specific categories          					         -->
	<!--    To avoid duplicate entries in the local log file, do not reference the same appender from categories           -->
	<!--     in a parent-child relation; reference the appender only on the parent category (see example below)         -->
	<!--______________________________________________________________________________________-->
	<category name="Trace.IPF" class="com.cognos.indications.LogTypedLogger">
		<level value="warn"/>
		<appender-ref ref="ipfLocalFile"/>
	</category>
	<category name="Trace.IPF.ASubComp" class="com.cognos.indications.LogTypedLogger">
		<level value="info"/>
	</category>
	<category name="Perf.IPF" class="com.cognos.indications.LogTypedLogger">
		<level value="debug"/>
		<appender-ref ref="ipfLocalFile"/>
	</category>
	<category name="Perf.IPF.Traceme" class="com.cognos.indications.LogTypedLogger">
		<level value="debug"/>
		<appender-ref ref="DyeTraceOutput"/>
	</category>
	<categoryFactory class="com.cognos.indications.LogTypedFactory"/>
</log4j:configuration>