org.perf.log.context
Class PerfLogContextHelper

java.lang.Object
  org.perf.log.context.PerfLogContextHelper

public class PerfLogContextHelper
extends java.lang.Object

This class enables creating and managing log context data that can be accessed by any logger. Log context data is created and deleted from filters such as Portlet Filter, Servlet Filter Struts Interceptors, Web Service handlers and SQL handlers etc. They are used to track requests with a JVM and across JVMs. The contextual data can be used by tools such as Splunk to correlate log outputs for diagnosis

Author:

Pradeep Nambiar 2/10/2012

Constructor Summary

PerfLogContextHelper()

Method Summary

static void	addToDebugContext(ContextElement logContextElement)
static void	addToDebugContext(java.lang.String context)
static void	addToDebugContext(java.lang.String name, java.lang.String value)
static void	addToRequestDataContext(ContextElement logContextElement)
static void	addToRequestDataContext(java.lang.String context)
static void	addToRequestDataContext(java.lang.String name, java.lang.String value)
static void	addToRequestDataContext(java.lang.String name, java.lang.String value, int maxValueSize)
static void	addToTxnList(java.lang.String txnName)
static void	dumpPerfLogContext()
static void	dumpPerfLogContext(java.util.logging.Logger inLogger)
static boolean	endPerfLogTxnMonitor()
static boolean	endPerfLogTxnMonitor(boolean logPerfLogData)
static boolean	endPerfLogTxnMonitor(PerfLogData perfLogData)
static java.lang.String	getBaseAndInfoContextString()
static java.lang.String	getBaseContextString()
static PerfLogContext	getCurrentThreadPerfLogContextObject()
static java.lang.String	getDebugContextString()
static long	getElapsedTime()
static long	getElapsedTimeForCurrentFilter()
static java.lang.String	getGuid()
static java.lang.String	getHostId()
static java.lang.String	getHostIp()
static java.lang.String	getJvmCloneId()
static java.lang.String	getJVMStats()
static java.lang.String	getRequestDataContextString()
static java.lang.String	getRequestSessionId()
static java.lang.String	getThreadId()
static java.util.List<java.lang.String>	getTxnList()
static java.lang.String	getUserId()
static java.lang.String	getValueForInfoContextName(java.lang.String name)
static void	logPerfLogData(PerfLogData perfLogData)
static void	popInfoContext()
static void	pushInfoContext(ContextElement logContextElement)
static void	pushInfoContext(java.lang.String context)
static void	pushInfoContext(java.lang.String name, java.lang.String value)
static void	pushInfoContext(java.lang.String name, java.lang.String value, int maxValueSize)
static void	removeLastInsertedFromDebugDataContext()
static void	removeLastInsertedFromRequestDataContext()
static void	setRequestSessionId(java.lang.String sid)
static void	setUserId(java.lang.String userId)
static boolean	startPerfLogTxnMonitor()
static boolean	startPerfLogTxnMonitor(PerfLogContextTrackingData perfLogContextTrackingData)
static boolean	startPerfLogTxnMonitor(PerfLogContextTrackingData perfLogContextTrackingData, TxnData txnData)
static boolean	startPerfLogTxnMonitor(TxnData txnData)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PerfLogContextHelper

public PerfLogContextHelper()

Method Detail

startPerfLogTxnMonitor

public static boolean startPerfLogTxnMonitor(PerfLogContextTrackingData perfLogContextTrackingData)

startPerfLogTxnMonitor

public static boolean startPerfLogTxnMonitor(PerfLogContextTrackingData perfLogContextTrackingData,
                                             TxnData txnData)

startPerfLogTxnMonitor

public static boolean startPerfLogTxnMonitor()

startPerfLogTxnMonitor

public static boolean startPerfLogTxnMonitor(TxnData txnData)

dumpPerfLogContext

public static void dumpPerfLogContext(java.util.logging.Logger inLogger)

dumpPerfLogContext

public static void dumpPerfLogContext()

getJVMStats

public static java.lang.String getJVMStats()

endPerfLogTxnMonitor

public static boolean endPerfLogTxnMonitor()

endPerfLogTxnMonitor

public static boolean endPerfLogTxnMonitor(boolean logPerfLogData)

endPerfLogTxnMonitor

public static boolean endPerfLogTxnMonitor(PerfLogData perfLogData)

pushInfoContext

public static void pushInfoContext(java.lang.String context)

pushInfoContext

public static void pushInfoContext(ContextElement logContextElement)

pushInfoContext

public static void pushInfoContext(java.lang.String name,
                                   java.lang.String value)

pushInfoContext

public static void pushInfoContext(java.lang.String name,
                                   java.lang.String value,
                                   int maxValueSize)

addToDebugContext

public static void addToDebugContext(java.lang.String context)

addToDebugContext

public static void addToDebugContext(ContextElement logContextElement)

addToDebugContext

public static void addToDebugContext(java.lang.String name,
                                     java.lang.String value)

addToRequestDataContext

public static void addToRequestDataContext(java.lang.String context)

addToRequestDataContext

public static void addToRequestDataContext(ContextElement logContextElement)

addToRequestDataContext

public static void addToRequestDataContext(java.lang.String name,
                                           java.lang.String value)

addToRequestDataContext

public static void addToRequestDataContext(java.lang.String name,
                                           java.lang.String value,
                                           int maxValueSize)

removeLastInsertedFromRequestDataContext

public static void removeLastInsertedFromRequestDataContext()

removeLastInsertedFromDebugDataContext

public static void removeLastInsertedFromDebugDataContext()

popInfoContext

public static void popInfoContext()

setUserId

public static void setUserId(java.lang.String userId)

getUserId

public static java.lang.String getUserId()

setRequestSessionId

public static void setRequestSessionId(java.lang.String sid)

getRequestSessionId

public static java.lang.String getRequestSessionId()

getThreadId

public static java.lang.String getThreadId()

getHostId

public static java.lang.String getHostId()

getHostIp

public static java.lang.String getHostIp()

getJvmCloneId

public static java.lang.String getJvmCloneId()

getCurrentThreadPerfLogContextObject

public static PerfLogContext getCurrentThreadPerfLogContextObject()

getBaseContextString

public static java.lang.String getBaseContextString()

getBaseAndInfoContextString

public static java.lang.String getBaseAndInfoContextString()

getDebugContextString

public static java.lang.String getDebugContextString()

getValueForInfoContextName

public static java.lang.String getValueForInfoContextName(java.lang.String name)

getGuid

public static java.lang.String getGuid()

getElapsedTime

public static long getElapsedTime()

getRequestDataContextString

public static java.lang.String getRequestDataContextString()

getElapsedTimeForCurrentFilter

public static long getElapsedTimeForCurrentFilter()

getTxnList

public static java.util.List<java.lang.String> getTxnList()

addToTxnList

public static void addToTxnList(java.lang.String txnName)

logPerfLogData

public static void logPerfLogData(PerfLogData perfLogData)