wt.jmx.core.mbeans
Interface DeluxeStatsMonitorMBean

All Superinterfaces:
SelfEmailingMBean
All Known Subinterfaces:
MethodContextMonitorMBean, ServletRequestMonitorMBean, SessionMonitorMBean

public interface DeluxeStatsMonitorMBean
extends SelfEmailingMBean

Encapsulation of common interface for monitoring MBeans with "deluxe" statistics, i.e. those with a common approach to extensive baseline and interval statistics.

Supported API: true

Extendable: true


Method Summary
 CompositeData getBaselineStatistics()
          Statistics since last baseline (see resetBaselineStatistics())

Supported API: true
 String getBaselineStatisticsLoggerLevel()
          Baseline statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true
 String getBaselineStatisticsLoggerName()
          Name of baseline statistics logger

Supported API: true
 int getRecentIntervalSeconds()
          Length of "recent" statistics interval in seconds

Supported API: true
 CompositeData getRecentStatistics()
          Statistics during last "recent" time interval (see RecentIntervalSeconds)

Supported API: true
 String getRecentStatisticsLoggerLevel()
          "Recent" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true
 String getRecentStatisticsLoggerName()
          Name of "recent" statistics logger

Supported API: true
 String getStatisticsLoggerFormatString()
          Low-level (java.util.Formatter) statistics log format string; if specified, overrides StatisticsLoggerUseShortFormat and StatisticsLoggerSeparatorString

Supported API: true
 String getStatisticsLoggerOutputAttributes()
          List of statistics to be output to statistics logs

Supported API: true
 String[] getStatisticsLoggerOutputAttributesSupported()
          List of attributes supported for use in StatisticsLoggerOutputAttributes

Supported API: true
 String getStatisticsLoggerSeparatorString()
          Item separator string used in statistics log format

Supported API: true
 int getSummaryIntervalSeconds()
          Length of "summary" statistics interval in seconds

Supported API: true
 String getSummaryStatisticsLoggerLevel()
          "Summary" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true
 String getSummaryStatisticsLoggerName()
          Name of "summary" statistics logger

Supported API: true
 boolean isStatisticsLoggerUseShortFormat()
          Whether short format (which contains only attribute values, not names) is used for statistics logging

Supported API: true
 void resetBaselineStatistics()
          Logs current baseline statistics and then resets them (establishes a new baseline)

Supported API: true
 void setBaselineStatisticsLoggerLevel(String baselineStatisticsLoggerLevel)
          Baseline statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true
 void setRecentIntervalSeconds(int recentIntervalSeconds)
          Length of "recent" statistics interval in seconds

Supported API: true
 void setRecentStatisticsLoggerLevel(String recentStatisticsLoggerLevel)
          "Recent" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true
 void setStatisticsLoggerFormatString(String statisticsLoggerFormatString)
          Low-level (java.util.Formatter) statistics log format string; if specified, overrides StatisticsLoggerUseShortFormat and StatisticsLoggerSeparatorString

Supported API: true
 void setStatisticsLoggerOutputAttributes(String statisticsLoggerOutputAttributes)
          List of statistics to be output to statistics logs

Supported API: true
 void setStatisticsLoggerSeparatorString(String statisticsLoggerSeparatorString)
          Item separator string used in statistics log format

Supported API: true
 void setStatisticsLoggerUseShortFormat(boolean statisticsLoggerUseShortFormat)
          Whether short format (which contains only attribute values, not names) is used for statistics logging

Supported API: true
 void setSummaryIntervalSeconds(int summaryIntervalSeconds)
          Length of "summary" statistics interval in seconds

Supported API: true
 void setSummaryStatisticsLoggerLevel(String summaryStatisticsLoggerLevel)
          "Summary" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true
 
Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean
emailThisMBean
 

Method Detail

getBaselineStatisticsLoggerName

String getBaselineStatisticsLoggerName()
Name of baseline statistics logger

Supported API: true


getBaselineStatisticsLoggerLevel

String getBaselineStatisticsLoggerLevel()
Baseline statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true


setBaselineStatisticsLoggerLevel

void setBaselineStatisticsLoggerLevel(String baselineStatisticsLoggerLevel)
Baseline statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true


getBaselineStatistics

CompositeData getBaselineStatistics()
                                    throws OpenDataException
Statistics since last baseline (see resetBaselineStatistics())

Supported API: true

Throws:
OpenDataException

getRecentIntervalSeconds

int getRecentIntervalSeconds()
Length of "recent" statistics interval in seconds

Supported API: true


setRecentIntervalSeconds

void setRecentIntervalSeconds(int recentIntervalSeconds)
Length of "recent" statistics interval in seconds

Supported API: true


getRecentStatisticsLoggerName

String getRecentStatisticsLoggerName()
Name of "recent" statistics logger

Supported API: true


getRecentStatisticsLoggerLevel

String getRecentStatisticsLoggerLevel()
"Recent" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true


setRecentStatisticsLoggerLevel

void setRecentStatisticsLoggerLevel(String recentStatisticsLoggerLevel)
"Recent" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true


getRecentStatistics

CompositeData getRecentStatistics()
                                  throws OpenDataException
Statistics during last "recent" time interval (see RecentIntervalSeconds)

Supported API: true

Throws:
OpenDataException

getSummaryIntervalSeconds

int getSummaryIntervalSeconds()
Length of "summary" statistics interval in seconds

Supported API: true


setSummaryIntervalSeconds

void setSummaryIntervalSeconds(int summaryIntervalSeconds)
Length of "summary" statistics interval in seconds

Supported API: true


getSummaryStatisticsLoggerName

String getSummaryStatisticsLoggerName()
Name of "summary" statistics logger

Supported API: true


getSummaryStatisticsLoggerLevel

String getSummaryStatisticsLoggerLevel()
"Summary" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true


setSummaryStatisticsLoggerLevel

void setSummaryStatisticsLoggerLevel(String summaryStatisticsLoggerLevel)
"Summary" statistics logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true


getStatisticsLoggerOutputAttributes

String getStatisticsLoggerOutputAttributes()
List of statistics to be output to statistics logs

Supported API: true


setStatisticsLoggerOutputAttributes

void setStatisticsLoggerOutputAttributes(String statisticsLoggerOutputAttributes)
List of statistics to be output to statistics logs

Supported API: true


getStatisticsLoggerOutputAttributesSupported

String[] getStatisticsLoggerOutputAttributesSupported()
List of attributes supported for use in StatisticsLoggerOutputAttributes

Supported API: true


isStatisticsLoggerUseShortFormat

boolean isStatisticsLoggerUseShortFormat()
Whether short format (which contains only attribute values, not names) is used for statistics logging

Supported API: true


setStatisticsLoggerUseShortFormat

void setStatisticsLoggerUseShortFormat(boolean statisticsLoggerUseShortFormat)
Whether short format (which contains only attribute values, not names) is used for statistics logging

Supported API: true


getStatisticsLoggerSeparatorString

String getStatisticsLoggerSeparatorString()
Item separator string used in statistics log format

Supported API: true


setStatisticsLoggerSeparatorString

void setStatisticsLoggerSeparatorString(String statisticsLoggerSeparatorString)
Item separator string used in statistics log format

Supported API: true


getStatisticsLoggerFormatString

String getStatisticsLoggerFormatString()
Low-level (java.util.Formatter) statistics log format string; if specified, overrides StatisticsLoggerUseShortFormat and StatisticsLoggerSeparatorString

Supported API: true


setStatisticsLoggerFormatString

void setStatisticsLoggerFormatString(String statisticsLoggerFormatString)
Low-level (java.util.Formatter) statistics log format string; if specified, overrides StatisticsLoggerUseShortFormat and StatisticsLoggerSeparatorString

Supported API: true


resetBaselineStatistics

void resetBaselineStatistics()
Logs current baseline statistics and then resets them (establishes a new baseline)

Supported API: true