#Time logging utilities for each external interaction

Contains

• JDBC query timing interceptor
• Servlet filter to do request ID correlation

JDBC time log

1. Build the project

mvn clean install

2. Copy "org.wso2.carbon.identity.ext.pool.db.interceptor-0.0.1-SNAPSHOT.jar" to dropins

3. Add following property to datasource configuration

<jdbcInterceptors>org.wso2.carbon.identity.ext.jdbc.pool.interceptor.TimeLogInterceptor</jdbcInterceptors>

e.g. in master-datasource.xml

 <datasource>
            <name>WSO2_CARBON_DB</name>
            <description>The datasource used for registry and user manager</description>
            <jndiConfig>
                <name>jdbc/WSO2CarbonDB</name>
            </jndiConfig>
            <definition type="RDBMS">
                <configuration>
                    <url>jdbc:h2:./repository/database/WSO2CARBON_DB;DB_CLOSE_ON_EXIT=FALSE;LOCK_TIMEOUT=60000</url>
                    <username>wso2carbon</username>
                    <password>wso2carbon</password>
                    <driverClassName>org.h2.Driver</driverClassName>
                    <maxActive>50</maxActive>
                    <maxWait>60000</maxWait>
                    <testOnBorrow>true</testOnBorrow>
                    <validationQuery>SELECT 1</validationQuery>
                    <validationInterval>30000</validationInterval>
                    <defaultAutoCommit>false</defaultAutoCommit>
                    <jdbcInterceptors>org.wso2.carbon.identity.ext.jdbc.pool.interceptor.TimeLogInterceptor</jdbcInterceptors>
                </configuration>
            </definition>
        </datasource>

4. Add correlation-log as rolling file appender in log4j.properties

# Appender config to put correlation Log.
log4j.logger.CORRELATION_LOG=DEBUG, CORRELATION_LOG
log4j.additivity.CORRELATION_LOG=false
log4j.appender.CORRELATION_LOG = org.apache.log4j.RollingFileAppender
log4j.appender.CORRELATION_LOG.File = ${carbon.home}/repository/logs/${instance.log}/correlation${instance.log}.log
log4j.appender.CORRELATION_LOG.Append = false
log4j.appender.CORRELATION_LOG.layout = org.apache.log4j.PatternLayout
log4j.appender.TIME_LOG.layout.ConversionPattern=[%X{somecorId}] [%X{Correlation-ID}] %t - %m%n

'somecorId' can be changed according to the value added under Host in repository/conf/tomcat/catalina-server.xml which is shown below.

Request correlation ID

1. Copy "org.wso2.carbon.identity.ext.servlet.valve-0.0.1-SNAPSHOT.jar" to dropins

2. Add following to "repository/conf/tomcat/catalina-server.xml, under "

 <Valve className="org.wso2.carbon.identity.ext.servlet.valve.RequestCorrelationIdValve" 
        headerToCorrelationIdMapping="{'someheader':'somecorId','activityid':'Correlation-ID'}"/>

Here 'someheader' would be the custom header you need to send along with an ID that you need to show in the log, similarly activityid also would be the same.

3. Change the following pattern in the "repository/conf/log4.properties"

# e.g. [%X{Correlation-ID}]
log4j.appender.CARBON_CONSOLE.layout.ConversionPattern=[%d] %P%5p {%c} - %x [%X{Correlation-ID}] %m%n
...
...
log4j.appender.CARBON_LOGFILE.layout.ConversionPattern=TID: [%T] [%S] [%d] %P%5p {%c} - %x [%X{Correlation-ID}] %m %n   

For APIM with IS-KM

1. Follow the above steps
2. Replace someheader with activityid
3. In management console of apim under Configure -> Message Tracing, tick "Enable Message Tracing" option
4. In Configure -> Logging set org.wso2.carbon.apimgt.gateway.handlers.ext.APIManagerExtensionHandler log level to DEBUG
5. In is-km management console, go to Configure -> Logging and set org.wso2.carbon.apimgt.keymgt.service.APIKeyValidationService log level to DEBUG

For more information refer https://dinushasblog.blogspot.com/2013/12/message-tracing-with-wso2-api-manager.html