Package org.eclnt.util.log

Class PLog

java.lang.Object

org.eclnt.util.log.PLog

All Implemented Interfaces:

CLogConstants

public class PLog
extends Object
implements CLogConstants

Server side performance logging. An extra performance log is written that is independent from the normal logging. The log contains:

Performance figures per request - both the client processing and the server processing.

Memory information

Additional information that may be passed by the application.

Log information is typically structure by some "type-prefix" (e.g. "REQUEST") and some semicolon separated String containing detail values ("name1:value1;name2:value2;...").

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PLog.AccumulatedInfo
static class	PLog.RequestPerformanceInfo

Field Summary

Fields

Modifier and Type	Field	Description
static Logger	L
static final String	TYPE_DOWNLOAD
static final String	TYPE_LEGEND
static final String	TYPE_MEMORY
static final String	TYPE_REQUEST
static final String	TYPE_UPLOAD

Fields inherited from interface org.eclnt.util.log.CLogConstants

LL_DBG, LL_ERR, LL_INF, LL_WAR

Constructor Summary

Constructors

Constructor	Description
PLog()

Method Summary

Modifier and Type	Method	Description
static void	accumulateNumberInCurrentRequest(String type, long number)
static void	clearCurrentRequestApplicationInfo()
static String	getCurrentRequestAccumulatedNumbersInfo()
static String	getCurrentRequestApplicationInfo()
static void	logApplicationInfo(String keyword, String info)	Interface for the application processing to add any information to this log.
static void	logClientProcessingInfo(String sessionId, String clientPerformanceData)	Adding performance data that is sent from the client.
static void	logFileDownloadInfo(String sessionId, long total, long numberOfBytes)
static void	logFileUploadInfo(String sessionId, long total, long numberOfBytes)
static void	logLegendLine(String text)
static void	logMemoryInfo()
static void	logRequestInfo(String sessionId, long total, long invoke, String expression, long consumedNanosGet, long stampStartOfClientProcessing, long stampStartOfServerProcessing, String requestId, long stampStartOfWritingResponse, String applicationInfo, String accumulatedNumbers)	Data added at end of processing.
static void	setCurrentRequestApplicationInfo(String applicationInfo)	Each request is porotocolled with one line of comma separated values.
static void	updateLogLevel(Level newLevel)

Methods inherited from class java.lang.Object

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

Field Details

TYPE_REQUEST

public static final String TYPE_REQUEST

See Also:

• Constant Field Values

TYPE_DOWNLOAD

public static final String TYPE_DOWNLOAD

See Also:

• Constant Field Values

TYPE_UPLOAD

public static final String TYPE_UPLOAD

See Also:

• Constant Field Values

TYPE_MEMORY

public static final String TYPE_MEMORY

See Also:

• Constant Field Values

TYPE_LEGEND

public static final String TYPE_LEGEND

See Also:

• Constant Field Values

L

public static Logger L

Constructor Details

PLog

public PLog()

Method Details

setCurrentRequestApplicationInfo

public static void setCurrentRequestApplicationInfo(String applicationInfo)

Each request is porotocolled with one line of comma separated values. You can set the value of the "ApplicationInfo" section by calling this method.

accumulateNumberInCurrentRequest

public static void accumulateNumberInCurrentRequest(String type,
 long number)

clearCurrentRequestApplicationInfo

public static void clearCurrentRequestApplicationInfo()

getCurrentRequestApplicationInfo

public static String getCurrentRequestApplicationInfo()

getCurrentRequestAccumulatedNumbersInfo

public static String getCurrentRequestAccumulatedNumbersInfo()

updateLogLevel

public static void updateLogLevel(Level newLevel)

logClientProcessingInfo

public static void logClientProcessingInfo(String sessionId,
 String clientPerformanceData)

Adding performance data that is sent from the client. This data is added at the begin of a request processing. The content is a complex value in the format "name:value;name:value".

logRequestInfo

public static void logRequestInfo(String sessionId,
 long total,
 long invoke,
 String expression,
 long consumedNanosGet,
 long stampStartOfClientProcessing,
 long stampStartOfServerProcessing,
 String requestId,
 long stampStartOfWritingResponse,
 String applicationInfo,
 String accumulatedNumbers)

Data added at end of processing.

logFileDownloadInfo

public static void logFileDownloadInfo(String sessionId,
 long total,
 long numberOfBytes)

logFileUploadInfo

public static void logFileUploadInfo(String sessionId,
 long total,
 long numberOfBytes)

logMemoryInfo

public static void logMemoryInfo()

logApplicationInfo

public static void logApplicationInfo(String keyword,
 String info)

Interface for the application processing to add any information to this log. We recommend to build the info String following the conventions in PLog ("name:value;name:value;..."). You may used ValueManager.encodeComplexValue(Map) to build this String.

logLegendLine

public static void logLegendLine(String text)