public interface

StatsHandlerSupport

com.microstrategy.web.app.StatsHandlerSupport
Known Indirect Subclasses

Summary

Nested Classes
interface StatsHandlerSupport.Data Request statistics. 
Constants
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.
Public Methods
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 HDR_BYTES_RECV

The name of the HTTP Header that indicates the total number of bytes received between IServer and Web.

Constant Value: "X-MSTRStat-BytesRecv"

public static final String HDR_BYTES_SENT

The name of the HTTP Header that indicates the total number of bytes sent between IServer and Web.

Constant Value: "X-MSTRStat-BytesSent"

public static final String HDR_POLLING_XMLAPI_CALLS

The name of the HTTP Header that indicates the number of polling XML API calls.

Constant Value: "X-MSTRStat-PollCalls"

public static final String HDR_TOTAL_ISERVER

The name of the HTTP Header that indicates the Total IServer time.

Constant Value: "X-MSTRStat-IServer"

public static final String HDR_TOTAL_XMLAPI_CALLS

The name of the HTTP Header that indicates the total number of XML API Calls made.

Constant Value: "X-MSTRStat-TotCalls"

public static final String HDR_TRANS

The name of the HTTP Header that indicates the Web transmission time.

Constant Value: "X-MSTRStat-Trans"

public static final String HDR_WEBAPP

The name of the HTTP Header that indicates the Web Application time.

Constant Value: "X-MSTRStat-Web"

public static final 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

Constant Value: 3 (0x00000003)

public static final 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

Constant Value: 2 (0x00000002)

public static final int LOG_MODE_OFF

This mode turns off all statistics gathering

Constant Value: 8 (0x00000008)

public static final int LOG_MODE_PASSIVE

This is currently not supported

Constant Value: 4 (0x00000004)

public static final 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.

Constant Value: 1 (0x00000001)

public static final int LOG_MODE_SNAPSHOT

Collates statistics for a given user request then turns itself off.

Constant Value: 16 (0x00000010)

public static final int STAT_BYTES_RECV

The bitmap value that indicates that the number of bytes received should be serialized.

Constant Value: 32 (0x00000020)

public static final int STAT_BYTES_SENT

The bitmap value that indicates that the number of bytes sent should be serialized.

Constant Value: 16 (0x00000010)

public static final int STAT_POLLING_XMLAPI_CALLS

The bitmap value that indicates that the number of polling XML API calls should be serialized.

Constant Value: 8 (0x00000008)

public static final int STAT_TOTAL_ISERVER

The bitmap value that indicates that the Total IServer time should be serialized. See saveStatsToHeaders(int, ContainerServices)

Constant Value: 1 (0x00000001)

public static final int STAT_TOTAL_XMLAPI_CALLS

The bitmap value that indicates that the Total number of XML API calls should be serialized.

Constant Value: 4 (0x00000004)

public static final int STAT_TRANS

The bitmap value that indicates that the Web transmission time should be serialized.

Constant Value: 64 (0x00000040)

public static final int STAT_WEBAPP

The bitmap value that indicates that the Web Application time should be serialized.

Constant Value: 2 (0x00000002)

Public Methods

public abstract void clear ()

Clears out collected statistics.

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

This is used to mark the end of statistics collection. Internally, this will invoke indicateEndOfApp(String), print out the statistics based on the mode, then finally clear out the existing state.

Parameters
sessionID String with the value of the session identifier
out a writer where the statistics information will be flushed to in the case that the logging mode is set to LOG_MODE_SCREEN

public abstract StatsHandlerSupport.Data endRequest (String sessionID)

This is used to mark the end of statistics collection

Parameters
sessionID String with the value of the session identifier

public abstract 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.

Parameters
sessionID String with the value of the session identifier

public abstract boolean isDisabled ()

Whether Web Statistics are disabled or not.

Returns
  • true if Web Statistics are disabled.

public abstract 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 abstract 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 abstract void setMode (int logMode)

Method used to set the log mode. The possible values are defined

Parameters
logMode -- one of the following constants LOG_MODE_FILE LOG_MODE_SCREEN LOG_MODE_OFF LOG_MODE_ACTIVE

public 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.

Parameters
sessionID String with the value of the session identifier
requestKeys the RequestKeys collection from the application
startMillis the time that Web statistics should use as the start time (expressed in milliseconds).

public abstract void startRequest (String sessionID, RequestKeys keys)

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

Parameters
sessionID String with the value of the session identifier
keys the RequestKeys collection from the application