analytics/configuration/xqe.diagnosticlogging.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
	Licensed Materials - Property of IBM
	IBM Cognos Products: XQE
	(C) Copyright IBM Corp. 2009, 2017
    US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM corp.
-->
<LoggingConfiguration>	
	<!-- Controls whether the logging configuration is checked for changes periodically and reloaded or not.  
	     The refreshInterval is in milliseconds -->
	<reload enabled="true" refreshInterval="30000"/>	
	<!-- Controls logging settings related to query execution. -->
	<queryExecution>
		<iteratorLogging>
			<!-- This is the list of iterators which could be logged:
			EmptyRowAxisIterator, EmptyValueSetAxisIterator, OLAPEdgeMappingIterator, V5BuildRowFromAncestorEdgeIterator,
			V5ReinsertEdgePathElementsIterator, XSortIterator -->
			<XIterator classList=""/>
			<RSAPITabularIterator traceEnabled="false"/>
		</iteratorLogging>
	</queryExecution>
	<!-- Controls logging level for Apache Parquet loggers. -->
	<!-- Valid level values are defined in java.util.logging.Level. -->
	<dataset>
		<parquet>
			<logger name="org.apache.parquet" level="OFF"/>
			<logger name="org.apache.parquet.filter2.compat.FilterCompat" level="OFF"/>
			<logger name="org.apache.parquet.hadoop.ColumnChunkPageWriteStore" level="OFF"/>
			<logger name="org.apache.parquet.hadoop.ParquetFileReader" level="OFF"/>
			<logger name="org.apache.parquet.hadoop.InternalParquetRecordReader" level="OFF"/>
			<logger name="org.apache.parquet.hadoop.InternalParquetRecordWriter" level="OFF"/>
			<logger name="shaded.org.apache.hadoop.io.compress.CodecPool" level="WARN"/>
		</parquet>
	</dataset>
	<!-- Controls diagnostic logging settings. Valid level values are 0 (only major events) to 2 (detailed logging).  -->
	<diagnostics enabled="true" appender="file" level="warn">
		<XQE>
			<appenders>
				<appender name="file" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="includeTimestamp" value="true"/>
					<param name="rollOverSize" value="10000"/>
					<!-- value in KB -->
				</appender>
				<appender name="console" class="com.cognos.xqe.trace.appender.XQEConsoleAppender"/>
				<appender name="remote" class="com.cognos.xqe.trace.appender.XQERemoteAppender"/>
				<appender name="IPFAudit" class="com.cognos.xqe.trace.appender.XQEIPFAppender">
					<param name="ipfLoggerPrefix" value="Audit.RTUsage"/>
				</appender>
				<appender name="IPFTrace" class="com.cognos.xqe.trace.appender.XQEIPFAppender">
					<param name="ipfLoggerPrefix" value="Trace"/>
				</appender>
				<appender name="queryProcessing" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="fileName" value="queryProcessingTrace"/>
				</appender>
				<appender name="cubeReuseFile" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="fileName" value="cubeReuseLog"/>
					<param name="includeComponent" value="false"/>
					<param name="includeLevel" value="false"/>
					<param name="includeOp" value="false"/>
					<param name="includeThread" value="false"/>
					<param name="includeAttributes" value="false"/>
					<param name="includeTimestamp" value="true"/>
				</appender>
				<appender name="CubeletStatsFile" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="fileName" value="CubeletStatsFile"/>
					<param name="includeOp" value="false"/>
					<param name="includeThread" value="false"/>
					<param name="includeTimestamp" value="true"/>
				</appender>
				<appender name="QueryStrategyStatsFile" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="fileName" value="QueryStrategyStatsFile"/>
					<param name="includeOp" value="false"/>
					<param name="includeThread" value="false"/>
					<param name="includeTimestamp" value="true"/>
				</appender>
				<appender name="OriginalAndPrimingQueryFile" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="fileName" value="OriginalAndPrimingQueryFile"/>
					<param name="includeTimestamp" value="true"/>
				</appender>
				<appender name="automaticAggregateOptimizationFile" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="fileName" value="automatic_aggregate_optimization_log"/>
					<param name="includeComponent" value="false"/>
					<param name="includeLevel" value="false"/>
					<param name="includeOp" value="false"/>
					<param name="includeThread" value="false"/>
					<param name="includeAttributes" value="true"/>
					<param name="includeTimestamp" value="true"/>
				</appender>
				<!-- Meant to be used for ad-hoc logging, eg for grouping together ROLAPCubes.AggregateCache, ROLAPCubes.AggregateStrategy, QueryService.SQL -->
				<appender name="adhoc" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="fileName" value="adhoc"/>
					<param name="includeComponent" value="false"/>
					<param name="includeLevel" value="false"/>
					<param name="includeOp" value="false"/>
					<param name="includeThread" value="false"/>
					<param name="includeAttributes" value="false"/>
					<param name="includeTimestamp" value="true"/>
				</appender>
			</appenders>
			<components>
				<component name="XQE">
					<eventGroup name="QueryService" appender="IPFAudit"/>
					<eventGroup name="Disp"/>
					<eventGroup name="Resources"/>
					<eventGroup name="Resources.Monitor"/>
					<eventGroup name="Console" appender="console"/>
					<eventGroup name="InitTerm"/>
					<eventGroup name="QueryEngine"/>
					<eventGroup name="RequestAdapter"/>
					<eventGroup name="RSAPI" level="warn"/>
					<eventGroup name="MetadataService"/>
					<eventGroup name="MetadataConnection"/>
					<eventGroup name="ProviderManager"/>
					<eventGroup name="CacheManager"/>
					<eventGroup name="QueryReuseManager"/>
					<eventGroup name="Connection"/>
					<eventGroup name="Connection.Factory"/>
					<eventGroup name="Connection.Pool"/>
					<eventGroup name="FJO"/>
					<eventGroup name="JDBC"/>
					<eventGroup name="JDBCAPITrace"/>
					<eventGroup name="HTTPClient"/>
					<eventGroup name="MoserCommand"/>
					<eventGroup name="ModuleManager"/>
					<eventGroup name="ODATA"/>
					<eventGroup name="Memory"/>
					<eventGroup name="FormatService"/>
					<eventGroup name="FormatService.Parser.Resource"/>
					<eventGroup name="FormatService.Parser.String"/>
					<eventGroup name="FormatService.Formatter"/>
					<eventGroup name="Cancel"/>
					<eventGroup name="MasterDetailOptimization"/>
					<eventGroup name="MDXEngine"/>
					<eventGroup name="MDXEngine.ResultSetCache"/>
					<eventGroup name="MDXEngine.ExpressionCache"/>
					<eventGroup name="CubeletStatistics" appender="CubeletStatsFile" level="error"/>
					<eventGroup name="QueryStrategyStatistics" appender="QueryStrategyStatsFile" level="error"/>
					<eventGroup name="ROLAPCubes"/>
					<eventGroup name="ROLAPCubes.Audit" appender="IPFAudit"/>
					<eventGroup name="ROLAPCubes.Management"/>
					<eventGroup name="ROLAPCubes.Loader"/>
					<eventGroup name="ROLAPCubes.Reservation"/>
					<eventGroup name="ROLAPCubes.Security"/>
					<eventGroup name="ROLAPCubes.IncrementalUpdates"/>
					<eventGroup name="ROLAPCubes.Info" level="info"/>
					<eventGroup name="ROLAPQuery"/>
					<eventGroup name="ROLAPQuery.Performance"/>
					<eventGroup name="ROLAPPipeline"/>
					<eventGroup name="ROLAPQuery.AggregateStrategy"/>
					<eventGroup name="ROLAPCubes.AggregateCache"/>
					<eventGroup name="ROLAP.AggregateWorkload"/>
					<eventGroup name="ROLAPAggregateAdvisor"/>
					<eventGroup name="ROLAPAggregateAdvisor.Management"/>
					<eventGroup name="ROLAPCubes.AutomaticAggregateOptimization" appender="automaticAggregateOptimizationFile" level="info"/>
					<eventGroup name="ROLAPCubes.Virtual"/>
					<eventGroup name="LockManagement"/>
					<eventGroup name="Hooks"/>
					<eventGroup name="PrimingQuery" appender="OriginalAndPrimingQueryFile"/>
					<!--<eventGroup name="Nag" appender="IPFTrace"/>-->
					<!--<eventGroup name="CubeReuse" appender="cubeReuseFile" level="info"/>-->
					<!--<eventGroup name="TupleStorage" appender="cubeReuseFile" level="info"/>-->
					<!--eventGroup name="Delta" appender="delta" level="warn"/-->
					<!--eventGroup name="QueryProcessing" appender="queryProcessing" level="info"/-->
					<!--eventGroup name="MemberStorage" appender="file" level="info"/-->
					<!--<eventGroup name="Timing" level="info"/>-->   <!-- Use to enable logging of the overall v5 request time to XQE. -->
					<!--<eventGroup name="BlockIteration" level="info"/>-->   <!-- INFO logs ordinal used, TRACE also logs object values. -->
					<!--<eventGroup name="Configuration" level="trace"/> -->	<!-- TRACE logs configuration reload events -->
					<!--<eventGroup name="Parameters" level="info"/>-->  <!-- Logging for unresolved parameters exceptions and related SOAP faults. -->
					<!--<eventGroup name="SymmetricSubqueryIterator" level="trace"/>-->  <!-- Logging if an unsymmetric query is split into multiple more precise queries. -->					
					<eventGroup name="InteractiveHTMLHelper"/>
					<eventGroup name="ERP" appender="file"/>
					<eventGroup name="ParameterMapQueryItem.Freshness"/>
					<eventGroup name="PreLoadCells"/>
				</component>
			</components>
		</XQE>
		<XQEODP>
			<appenders>
				<appender name="file" class="com.cognos.xqe.trace.appender.XQEFileAppender">
					<param name="includeTimestamp" value="true"/>
				</appender>
				<appender name="console" class="com.cognos.xqe.trace.appender.XQEConsoleAppender"/>
				<appender name="ipf" class="com.cognos.xqe.trace.appender.XQEIPFAppender"/>
			</appenders>
			<components>
			
				<!-- The logging described below is common to all XQEODP providers. Each provider component can log additional 
				messages in these groups. -->

				<!-- Metadata
					error: Emits exceptions during metadata query execution.
					info:  Emits restrictions and information corresponding to the metadata request for cubes, catalogs, dimensions,
					hierarchies, levels, etc.-->
				<!-- Metadata.Records
					trace: Emits responses for metadata queries pertaining to members, levels, hierarchies and dimensions, etc. -->

				<!-- DataQuery
					info:  Logs the MDX or mdquery that the planner sends to the provider for execution. 
					error: Records any expected errors (such as a cancel operation) or unexpected errors while a query is executing. -->
					
				<!-- DataQuery.ResultSet
					trace: Logs the provider's response for an MDX in the form of a cube result set.  This includes summary metadata
						for the projected dimensions and levels, as well as a complete record of every tuple and cell contained in 
						the result set, even if the query engine would normally consume a portion of the results.  Turning on this 
						event group changes the control flow of query result post-processing; it may cause noticeable performance 
						overhead for especially large queries. -->
				
				<component name="ODBO">
					<eventGroup name="Configuration"/>
					<eventGroup name="3rdParty"/>
					<eventGroup name="Connection"/>
					<eventGroup name="Metadata"/>
					<!--eventGroup name="Metadata.Records"/-->
					<eventGroup name="DataQuery"/>
					<!--eventGroup name="DataQuery.MDX"/-->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					<eventGroup name="Exception"/>
				</component>
				<component name="SBWODP">
					<eventGroup name="Configuration"/>
					<eventGroup name="Connection"/>
					<eventGroup name="Function"/>
					<eventGroup name="Metadata"/>
					<!--eventGroup name="Metadata.Records"/-->
					<eventGroup name="DataQuery"/>
					<!--eventGroup name="DataQuery.MDX"/-->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					<eventGroup name="Timing"/>
					<eventGroup name="Exception"/>
				</component>
				<component name="SNWODP">
					<eventGroup name="Configuration"/>
					<eventGroup name="Connection"/>
					<eventGroup name="Function"/>
					<eventGroup name="Metadata"/>
					<!--eventGroup name="Metadata.Records"/-->
					<eventGroup name="DataQuery"/>
					<!--eventGroup name="DataQuery.MDX"/-->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					<eventGroup name="Timing"/>
					<eventGroup name="Exception"/>
				</component>
				<component name="Essbase">
					<eventGroup name="Configuration"/>
					<eventGroup name="3rdParty"/>
					<eventGroup name="Connection"/>
					<eventGroup name="Metadata"/>
					<!--eventGroup name="Metadata.Records"/-->
					<eventGroup name="DataQuery"/>
					<!--eventGroup name="DataQuery.MDX"/-->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					<eventGroup name="Exception"/>
				</component>
				<component name="XMLA">
					<eventGroup name="Configuration"/>
					<eventGroup name="3rdParty"/>
					<eventGroup name="Connection"/>
					<eventGroup name="Metadata"/>
					<!--eventGroup name="Metadata.Records"/-->
					<eventGroup name="DataQuery"/>
					<!--eventGroup name="DataQuery.MDX"/-->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					<eventGroup name="Exception"/>
					<eventGroup name="Http"/>
					<!--eventGroup name="Http.State"/-->
					<!--eventGroup name="Http.Post"/-->
					<eventGroup name="Soap"/>
					<!--eventGroup name="Soap.Request"/-->
					<!--eventGroup name="Soap.Response"/-->
					<!--eventGroup name="Rowsets" level="trace"/-->
					<!--eventGroup name="Datasets" level="trace"/-->
					<!--eventGroup name="Metrics" level="trace"/-->
				</component>
				<component name="MDDS">
					<eventGroup name="Configuration"/>
					<eventGroup name="3rdParty"/>
					<eventGroup name="Connection"/>
					<eventGroup name="Metadata"/>
					<!--eventGroup name="Metadata.Records"/-->
					<eventGroup name="DataQuery"/>
					<!--eventGroup name="DataQuery.MDX"/-->
					<!--eventGroup name="DataQuery.Perf"/-->
					<!--eventGroup name="DataQuery.Cache"/-->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					<eventGroup name="Exception"/>
				</component>
				<component name="NGTM1">
					
					<!-- Configuration related events. NGTM1 provider configuration parameters load from xqeodp.config. -->
					<!-- Error-level messages will be recorded whenever a config parameter is invalid. -->
					<!-- Level info provides all NGTM1 provider configuration parameters. -->
					<!-- Level trace provides start and end of NGTM1 provider configuration parameters loading from xqeodp.config. -->
					<!-- Level error provides any error during loading tm1 provider configuration .-->
					<eventGroup name="Configuration"/>
					
					<eventGroup name="3rdParty"/>
					
					<!-- Initialize NGTM1 API related events. by default it is set to info.  -->
					<!-- Level info provides the API initialization information. -->
					<!-- Level error or warn provides any warninng and error during API initialization. -->
					<eventGroup name="InitTerm"/>
					
					<!-- Connection related groups/sub-groups events and levels. -->
					<eventGroup name="Connection"/>
					
					<!-- Level info provides the created and destroyed connection detail information. -->
					<!-- level trace captures the construction of TM1ConnectionFactory. -->
					<eventGroup name="Connection.Factory"/>
					
					<!-- Level trace captures the details of selecting a connection. -->
					<eventGroup name="Connection.Selector"/>
					
					<!-- Level trace captures connection login/detach information. -->
					<eventGroup name="Connection.LogOnOff"/>
					
					<!-- Level trace captures connection user group information. -->
					<eventGroup name="Connection.UserGroups"/>
					
					<!-- Level trace captures TM1 server security mode information. -->
					<!-- Level error provides any error when unable to determine security mode. -->
					<eventGroup name="Connection.SecurityMode"/>
					
					<!-- Level warn  provides any warning during connection validation. -->
					<!-- Level error provides any error during connection validation. -->
					<eventGroup name="Connection.Validate"/>
					
					<!-- Provider metadata related groups/sub-groups events and levels. -->
					<eventGroup name="Metadata"/>
					<!-- Level info captuers cube is under fed. -->
					<!-- Level trace caputers cube is properly fed. -->
					<eventGroup name="Metadata.Cube"/>
					
					<!-- Level trace provides cached metadata check information, because the TM1CubeCache keeps a snapshot of a cube's entire 
					      metadata for as long as the cube is not modified on the server -->
					<!-- Level warn records any warning or error when DQ flushes cached metadata as a result of a change to the underlying cube. -->
					<eventGroup name="Metadata.Cache"/>
					
					<!-- Level info provides cube load (from cache of datasource) information. -->
					<eventGroup name="Metadata.Loader"/>
					
					<eventGroup name="DataQuery"/>
					<!-- DataQuery.MDX: Captures the execution of an MDX or mdquery statement against the TM1 API.
						error: TM1 Error messages for failed data queries.
						info:  The MDX or mdquery that the provider sends to the TM1 server.
						trace: The beginning and end of successful data queries, with the execution time measured in milliseconds.	-->					
					<!--eventGroup name="DataQuery.MDX"/-->
					
					<!-- DataQuery.MDX.Cancel: Info related to canceled data queries, either initiated from the end user or from the TM1 server.
						warn:  Cancel operations that abandon the TM1 connection due to a timeout or other unrecoverable reason.
						info:  Successful cancel operations that leave the TM1 connection in a reusable state. -->
					<!--eventGroup name="DataQuery.MDX.Cancel"/-->
					
					<!-- DataQuery.ResultSet: See parent section. Enable only when needed. -->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					
					<!-- DataQuery.View: Summary information for TM1 views resulting from successful data queries. -->
					<!--eventGroup name="DataQuery.View"/-->
					<!-- Note: The 'trace' level of each subgroup below 'View' changes the iteration pattern and control flow of 
						View post-processing; it may cause noticeable performance overhead for especially large queries. -->
					<!-- DataQuery.View.Axes
						info:  Summary info for each axis rowset in a view, including each field's name and type.
						trace: Detailed row information for each tuple, including the value of each axis field. -->
					<eventGroup name="DataQuery.View.Axes" level="none"/>
					<!-- DataQuery.View.Cells
						info:  Number of non-null cells in the view along with the CellSet fields.
						trace: Detailed row information for each cell, including the value of each field. -->
					<eventGroup name="DataQuery.View.Cells" level="none"/>
					
					<!-- DataQuery.Suppress.PXJ
						info:  Records cases where the UseProviderCrossJoinThreshold parameter is passed to the TM1 server, and it's value.
						trace: Records cases where the PXJ parameter is not passed to the server, and why. -->
					<!--eventGroup name="DataQuery.Suppress.PXJ"/-->
					<eventGroup name="Exception"/>
				</component>
				<component name="TM1REST">
					
					<!-- Configuration related events. TM1REST provider configuration parameters load from xqeodp.config. -->
					<!-- Error-level messages will be recorded whenever a config parameter is invalid. -->
					<!-- Level info provides all NGTM1 provider configuration parameters. -->
					<!-- Level trace provides start and end of TM1REST provider configuration parameters loading from xqeodp.config. -->
					<!-- Level error provides any error during loading tm1 provider configuration .-->
					<eventGroup name="Configuration"/>
					
					<eventGroup name="3rdParty"/>
					
					<!-- Initialize TM1REST API related events. by default it is set to info.  -->
					<!-- Level info provides the API initialization information. -->
					<!-- Level error or warn provides any warninng and error during API initialization. -->
					<eventGroup name="InitTerm"/>
					
					<!-- Connection related groups/sub-groups events and levels. -->
					<eventGroup name="Connection"/>
					
					<!-- Level info provides the created and destroyed connection detail information. -->
					<!-- level trace captures the construction of TM1ConnectionFactory. -->
					<eventGroup name="Connection.Factory"/>
					
					<!-- Level trace captures the TM1 REST HTTP client requests and other client events. -->
					<eventGroup name="Connection.Client"/>
					
					<!-- Level trace captures the details of selecting a connection. -->
					<eventGroup name="Connection.Selector"/>
					
					<!-- Level trace captures connection login/detach information. -->
					<eventGroup name="Connection.LogOnOff"/>
					
					<!-- Level trace captures connection user group information. -->
					<eventGroup name="Connection.UserGroups"/>
					
					<!-- Level trace captures TM1 server security mode information. -->
					<!-- Level error provides any error when unable to determine security mode. -->
					<eventGroup name="Connection.SecurityMode"/>
					
					<!-- Level warn  provides any warning during connection validation. -->
					<!-- Level error provides any error during connection validation. -->
					<eventGroup name="Connection.Validate"/>
					
					<!-- Provider metadata related groups/sub-groups events and levels. -->
					<eventGroup name="Metadata"/>
					<!-- Level info captuers cube is under fed. -->
					<!-- Level trace caputers cube is properly fed. -->
					<eventGroup name="Metadata.Cube"/>
					
					<!-- Level trace provides cached metadata check information, because the TM1CubeCache keeps a snapshot of a cube's entire 
					      metadata for as long as the cube is not modified on the server -->
					<!-- Level warn records any warning or error when DQ flushes cached metadata as a result of a change to the underlying cube. -->
					<eventGroup name="Metadata.Cache"/>
					
					<!-- Level info provides cube load (from cache of datasource) information. -->
					<eventGroup name="Metadata.Loader"/>
					
					<eventGroup name="DataQuery"/>
					<!-- DataQuery.MDX: Captures the execution of an MDX statement against the TM1 REST API.
					These are the available levels:
						error: TM1 Error messages for failed data queries.
						info:  The MDX that the provider sends to the TM1 server.
						trace: The beginning and end of successful data queries, with the execution time measured in milliseconds.	-->					
					<eventGroup name="DataQuery.MDX" level="none"/>
					
					<!-- DataQuery.MDX.Cancel: Info related to canceled data queries, either initiated from the end user or from the TM1 server.
					These are the available levels:
						warn:  Cancel operations that abandon the TM1 connection due to a timeout or other unrecoverable reason.
						info:  Successful cancel operations that leave the TM1 connection in a reusable state. -->
					<eventGroup name="DataQuery.MDX.Cancel"  level="none"/>
					
					<!-- DataQuery.ResultSet: Enable only when needed. It may cause noticeable performance overhead. 
					These are the available levels:
						trace: Provides a representation of the generated result set. Contains detailed information for each axis and cells.-->
					<eventGroup name="DataQuery.ResultSet" level="none"/>
					
					<!-- DataQuery.View: Enable only when needed. It may cause noticeable performance overhead. 
						A representation of the TM1 result set resulting from successful data query.
					These are the available levels:
						trace: Provides detailed information for each axis and cells. -->
					<eventGroup name="DataQuery.View" level="none"/>

					<!-- DataQuery.View.Axes
					These are the available levels:
						info:  Summary info for each axis, including the number of tuples in the view
						and the names of the projected hierarchies.-->
					<eventGroup name="DataQuery.View.Axes" level="none"/>

					<!-- DataQuery.View.Cells
					These are the available levels:
						info:  Number of non-null cells in the view.-->
					<eventGroup name="DataQuery.View.Cells" level="none"/>
					
					<!-- DataQuery.Suppress.PXJ
						info:  Records cases where the UseProviderCrossJoinThreshold parameter is passed to the TM1 server, and it's value.
						trace: Records cases where the PXJ parameter is not passed to the server, and why. -->
					<!--eventGroup name="DataQuery.Suppress.PXJ"/-->
					<eventGroup name="Exception"/>
				</component>
			</components>
		</XQEODP>
	</diagnostics>
</LoggingConfiguration>