public class

StatsHandler

extends FileHandler
implements StatsHandlerSupport

java.lang.Object
↳	com.microstrategy.utils.log.Handler
	↳	com.microstrategy.utils.log.StreamHandler
		↳	com.microstrategy.utils.log.FileHandler
			↳	com.microstrategy.web.app.StatsHandler

Class Overview

This class implements the StatsHandlerSupport interface and extends the FileHandler class.

Summary

Constants
String	APPLICATION_METHOD
String	APPLICATION_REQUEST
int	FORMAT_HTML
int	FORMAT_TEXT_TAB_DELIMITED
String	FORWARDED_REQUEST

[Expand]

Inherited Constants

From interface com.microstrategy.web.app.StatsHandlerSupport

String	HDR_BYTES_RECV	The name of the HTTP Header that indicates the total number of bytes received between IServer and Web.
String	HDR_BYTES_SENT	The name of the HTTP Header that indicates the total number of bytes sent between IServer and Web.
String	HDR_POLLING_XMLAPI_CALLS	The name of the HTTP Header that indicates the number of polling XML API calls.
String	HDR_TOTAL_ISERVER	The name of the HTTP Header that indicates the Total IServer time.
String	HDR_TOTAL_XMLAPI_CALLS	The name of the HTTP Header that indicates the total number of XML API Calls made.
String	HDR_TRANS	The name of the HTTP Header that indicates the Web transmission time.
String	HDR_WEBAPP	The name of the HTTP Header that indicates the Web Application time.
int	LOG_MODE_ACTIVE	statistics mode indicating that the logging should be done to a file and the browser In this mode all the Web API calls are logged at `FINE` level This file has all the necessary information to get performance statistics
int	LOG_MODE_FILE	statistics mode indicating that the logging should be done to a file In this mode all the Web API calls are logged at `FINE` level This file has all the necessary information to get performance statistics
int	LOG_MODE_OFF	This mode turns off all statistics gathering
int	LOG_MODE_PASSIVE	This is currently not supported
int	LOG_MODE_SCREEN	statistics mode indicating that the logging should be done to the browser Statistics are gathered while the request is being processed in memory.
int	LOG_MODE_SNAPSHOT	Collates statistics for a given user request then turns itself off.
int	STAT_BYTES_RECV	The bitmap value that indicates that the number of bytes received should be serialized.
int	STAT_BYTES_SENT	The bitmap value that indicates that the number of bytes sent should be serialized.
int	STAT_POLLING_XMLAPI_CALLS	The bitmap value that indicates that the number of polling XML API calls should be serialized.
int	STAT_TOTAL_ISERVER	The bitmap value that indicates that the Total IServer time should be serialized.
int	STAT_TOTAL_XMLAPI_CALLS	The bitmap value that indicates that the Total number of XML API calls should be serialized.
int	STAT_TRANS	The bitmap value that indicates that the Web transmission time should be serialized.
int	STAT_WEBAPP	The bitmap value that indicates that the Web Application time should be serialized.

[Expand]

Inherited Fields

From class com.microstrategy.utils.log.FileHandler

Public Methods
void	clear() Clears out collected statistics.
StatsHandlerSupport.Data	endRequest(String sessionID, Writer out) This is used to mark the end of statistics collection, and print out statistics to the specified writer.
StatsHandlerSupport.Data	endRequest(String sessionID) This is used to mark the end of statistics collection
static StatsHandlerSupport	getInstance() Returns our singleton StatsHandlerSupport instance.
StatsHandlerSupport.Data	indicateEndOfApp(String sessionID) Indicate the end of the Application Level request.
boolean	isDisabled() Whether Web Statistics are disabled or not.
void	publish(LogRecord record) Publish the log information
void	saveStatsToHeaders(int statCode, ContainerServices cntrSvcs) Save a collection of statistics to HTTP headers.
void	setLogFileName(String path) Sets the physical location of the log file
synchronized void	setMode(int logMode) Method used to set the log mode.
void	startRequest(String sessionID, RequestKeys keys, long startMillis) Method used to indicate to the handler that statistics gathering should start at the time specified as the startMillis parameter.
void	startRequest(String sessionID, RequestKeys keys) Method used to indicate to the handler that statistics gathering should start at this point.

[Expand]

Inherited Methods

From class com.microstrategy.utils.log.FileHandler

From class com.microstrategy.utils.log.StreamHandler

From class com.microstrategy.utils.log.Handler

From class java.lang.Object

From interface com.microstrategy.utils.log.Configurable

From interface com.microstrategy.web.app.StatsHandlerSupport

abstract void	clear() Clears out collected statistics.
abstract StatsHandlerSupport.Data	endRequest(String sessionID, Writer out) This is used to mark the end of statistics collection.
abstract StatsHandlerSupport.Data	endRequest(String sessionID) This is used to mark the end of statistics collection
abstract StatsHandlerSupport.Data	indicateEndOfApp(String sessionID) Indicate the end of the Application Level request.
abstract boolean	isDisabled() Whether Web Statistics are disabled or not.
abstract void	saveStatsToHeaders(int statCode, ContainerServices cntrSvcs) Save a collection of statistics to HTTP headers.
abstract void	setLogFileName(String path) sets the physical location of the log file
abstract void	setMode(int logMode) Method used to set the log mode.
abstract void	startRequest(String sessionID, RequestKeys requestKeys, long startMillis) Method used to indicate to the handler that statistics gathering should start at the point specified by the startMillis parameter.
abstract void	startRequest(String sessionID, RequestKeys keys) Method used to indicate to the handler that statistics gathering should start at this point

Constants

public static final String APPLICATION_METHOD

Constant Value: "mstrWeb"

public static final String APPLICATION_REQUEST

Constant Value: "com.microstrategy.web.app.ServletEventHandler"

public static final int FORMAT_HTML

Constant Value: 1 (0x00000001)

public static final int FORMAT_TEXT_TAB_DELIMITED

Constant Value: 2 (0x00000002)

public static final String FORWARDED_REQUEST

Constant Value: "ForwardedRequest"

Public Methods

public void clear ()

Clears out collected statistics.

public StatsHandlerSupport.Data endRequest (String sessionID, Writer out)

This is used to mark the end of statistics collection, and print out statistics to the specified writer.

Parameters

sessionID	String value with the session ID opened
out	Writer instance

Returns

statistics

public StatsHandlerSupport.Data endRequest (String sessionID)

This is used to mark the end of statistics collection

Parameters

sessionID	String value with the session ID opened

public static StatsHandlerSupport getInstance ()

Returns our singleton StatsHandlerSupport instance.

Returns

A singleton instance of a StatsHandlerSupport.

public StatsHandlerSupport.Data indicateEndOfApp (String sessionID)

Indicate the end of the Application Level request. This is used to mark the end of statistics collection. Unlike endRequest(String), this method does not write any statistics to any output stream, nor clear the data collected afterwards.

Parameters

sessionID	String with the value of the session identifier

public boolean isDisabled ()

Whether Web Statistics are disabled or not.

Returns

true if Web Statistics are disabled.

public void publish (LogRecord record)

Publish the log information

Parameters

record	`LogRecord` instance

public void saveStatsToHeaders (int statCode, ContainerServices cntrSvcs)

Save a collection of statistics to HTTP headers.

Parameters

statCode	A bitmap of specific statistics that should be saved to HTTP Headers.
cntrSvcs	A `ContainerServices` instance to use for creating HTTP Headers.

public void setLogFileName (String path)

Sets the physical location of the log file

Parameters

path	The physical location of the file to which all log messages would be written if the logging mode is set to `LOG_MODE_FILE`

public synchronized void setMode (int logMode)

Method used to set the log mode.

Parameters

logMode	`int` value to define as mode

public void startRequest (String sessionID, RequestKeys keys, long startMillis)

Method used to indicate to the handler that statistics gathering should start at the time specified as the startMillis parameter.

Parameters

sessionID	String value with the session ID opened
keys	the RequestKeys collection from the application
startMillis	the time that Web statistics should use as the start time (expressed in milliseconds).

public void startRequest (String sessionID, RequestKeys keys)

Method used to indicate to the handler that statistics gathering should start at this point.

Parameters

sessionID	String value with the session ID opened
keys	the RequestKeys collection from the application

Interfaces

Classes

Exceptions

StatsHandler

Class Overview

Summary

Constants

public static final String APPLICATION_METHOD

public static final String APPLICATION_REQUEST

public static final int FORMAT_HTML

public static final int FORMAT_TEXT_TAB_DELIMITED

public static final String FORWARDED_REQUEST

Public Methods

public void clear ()

public StatsHandlerSupport.Data endRequest (String sessionID, Writer out)

Parameters

Returns

See Also

public StatsHandlerSupport.Data endRequest (String sessionID)

Parameters

See Also

public static StatsHandlerSupport getInstance ()

Returns

public StatsHandlerSupport.Data indicateEndOfApp (String sessionID)

Parameters

public boolean isDisabled ()

Returns

public void publish (LogRecord record)

Parameters

See Also

public void saveStatsToHeaders (int statCode, ContainerServices cntrSvcs)

Parameters

public void setLogFileName (String path)

Parameters

See Also

public synchronized void setMode (int logMode)

Parameters

See Also

public void startRequest (String sessionID, RequestKeys keys, long startMillis)

Parameters

See Also

public void startRequest (String sessionID, RequestKeys keys)

Parameters

See Also