wt.method
Interface MethodContextMonitorMBean

All Superinterfaces:

DeluxeStatsMonitorMBean, RawStatisticsProviderMBean, SelfEmailingMBean

public interface MethodContextMonitorMBean
extends DeluxeStatsMonitorMBean, RawStatisticsProviderMBean

Monitors Windchill method server method contexts.

Supported API: true

Extendable: true

Field Summary

static String

MAX_ACTIVE_CONTEXTS_NOTIF_TYPE Type of notification produced when MaxAverageActiveContextsThreshold is exceeded Supported API: true

Method Summary

long	captureActiveContext(String contextId) Creates a set of MBeans containing only the context with the specified id, if it is active, and returns the set's id; if no such context is active, -1 is returned Supported API: true
long	captureActiveContexts() Creates a set of MBeans representing all contexts currently being processed and returns its id Supported API: true
AttributeList[]	getActiveContextAttributes(String[] attributeNames) Returns array of AttributeLists, one for each active context.
int	getActiveContexts() Number of contexts currently being processed Supported API: true
String	getContextLoggerFormatString() Low-level (java.util.Formatter) context log format string; if specified, overrides ContextLoggerUseShortFormat and ContextLoggerSeparatorString Supported API: true
String	getContextLoggerLevel() Context logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified) Supported API: true
String	getContextLoggerName() Name of context logger Supported API: true
String	getContextLoggerOutputAttributes() List of ContextMBean attributes to be output to context log Supported API: true
String[]	getContextLoggerOutputAttributesSupported() List of attributes supported for use in ContextLoggerOutputAttributes Supported API: true
String	getContextLoggerSeparatorString() Item separator string used in context log format Supported API: true
int	getDatabaseConnections() Number of database connections open Supported API: true
int	getMaxAverageActiveContextsThreshold() Maximum average context concurrency before log messages become warnings and notifications are sent when this statistic is maintained for a summary interval; threshold disabled when zero or megative Supported API: true
CompositeData	getObjectCounterData() Data about WTObject allocation (no data will be collected unless ObjectCounterEnabled is true) Supported API: true
boolean	getObjectCounterEnabled() Whether WTObject allocation counting is enabled Supported API: true
void	interrupt(String contextId) If specified context exists and is not completed, interrupts its thread.
boolean	isContextLoggerUseShortFormat() Whether short format (which contains only attribute values, not names) is used for context logging Supported API: true
boolean	isContextRegistrationEnabled() Whether contexts are automatically registered and deregistered as JMX MBeans as they are received and completed; enabling this can adversely affect performance Supported API: true
boolean	isProcessCpuTimeMonitoringEnabled() Whether monitoring of overall process CPU time is enabled for this MBean; if not, then MethodContextMBean's ProcessPercentageOfTotalCpuTime and PercentageOfProcessCpuTime attributes will not have meaningful values, but this monitoring has somewhat substantive overhead Supported API: true
void	releaseCapturedContexts() Releases all ContextSets and the context MBeans they contain Supported API: true
void	releaseCapturedContextSet(long captureSetId) Releases a set of MBeans previously captured with captureActiveContexts() Supported API: true
void	setContextLoggerFormatString(String contextLoggerFormatString) Low-level (java.util.Formatter) context log format string; if specified, overrides ContextLoggerUseShortFormat and ContextLoggerSeparatorString Supported API: true
void	setContextLoggerLevel(String level) Context logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified) Supported API: true
void	setContextLoggerOutputAttributes(String contextLoggerOutputAttributes) List of ContextMBean attributes to be output to context log Supported API: true
void	setContextLoggerSeparatorString(String contextLoggerSeparatorString) Item separator string used in context log format Supported API: true
void	setContextLoggerUseShortFormat(boolean contextLoggerUseShortFormat) Whether short format (which contains only attribute values, not names) is used for context logging Supported API: true
void	setContextRegistrationEnabled(boolean contextRegistrationEnabled) Whether contexts are automatically registered and deregistered as JMX MBeans as they are received and completed; enabling this can adversely affect performance Supported API: true
void	setMaxAverageActiveContextsThreshold(int maxAverageActiveContextThreshold) Maximum average context concurrency before log messages become warnings and notifications are sent when this statistic is maintained for a summary interval; threshold disabled when zero or megative Supported API: true
void	setObjectCounterEnabled(boolean objectCounterEnabled) Whether WTObject allocation counting is enabled Supported API: true
void	setProcessCpuTimeMonitoringEnabled(boolean processCpuTimeMonitoringEnabled) Whether monitoring of overall process CPU time is enabled for this MBean; if not, then MethodContextMBean's ProcessPercentageOfTotalCpuTime and PercentageOfProcessCpuTime attributes will not have meaningful values, but this monitoring has somewhat substantive overhead Supported API: true

Methods inherited from interface wt.jmx.core.mbeans.DeluxeStatsMonitorMBean

getBaselineStatistics, getBaselineStatisticsLoggerLevel, getBaselineStatisticsLoggerName, getRecentIntervalSeconds, getRecentStatistics, getRecentStatisticsLoggerLevel, getRecentStatisticsLoggerName, getStatisticsLoggerFormatString, getStatisticsLoggerOutputAttributes, getStatisticsLoggerOutputAttributesSupported, getStatisticsLoggerSeparatorString, getSummaryIntervalSeconds, getSummaryStatisticsLoggerLevel, getSummaryStatisticsLoggerName, isStatisticsLoggerUseShortFormat, resetBaselineStatistics, setBaselineStatisticsLoggerLevel, setRecentIntervalSeconds, setRecentStatisticsLoggerLevel, setStatisticsLoggerFormatString, setStatisticsLoggerOutputAttributes, setStatisticsLoggerSeparatorString, setStatisticsLoggerUseShortFormat, setSummaryIntervalSeconds, setSummaryStatisticsLoggerLevel

Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

emailThisMBean

Methods inherited from interface wt.jmx.core.mbeans.RawStatisticsProviderMBean

getRawStatistics

Field Detail

MAX_ACTIVE_CONTEXTS_NOTIF_TYPE

static final String MAX_ACTIVE_CONTEXTS_NOTIF_TYPE

Type of notification produced when MaxAverageActiveContextsThreshold is exceeded

Supported API: true

Method Detail

getActiveContexts

int getActiveContexts()

Number of contexts currently being processed

Supported API: true

getDatabaseConnections

int getDatabaseConnections()

Number of database connections open

Supported API: true

getMaxAverageActiveContextsThreshold

int getMaxAverageActiveContextsThreshold()

Maximum average context concurrency before log messages become warnings and notifications are sent when this statistic is maintained for a summary interval; threshold disabled when zero or megative

Supported API: true

setMaxAverageActiveContextsThreshold

void setMaxAverageActiveContextsThreshold(int maxAverageActiveContextThreshold)

Maximum average context concurrency before log messages become warnings and notifications are sent when this statistic is maintained for a summary interval; threshold disabled when zero or megative

Supported API: true

getContextLoggerName

String getContextLoggerName()

Name of context logger

Supported API: true

getContextLoggerLevel

String getContextLoggerLevel()

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

Supported API: true

setContextLoggerLevel

void setContextLoggerLevel(String level)

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

Supported API: true

getContextLoggerOutputAttributes

String getContextLoggerOutputAttributes()

List of ContextMBean attributes to be output to context log

Supported API: true

setContextLoggerOutputAttributes

void setContextLoggerOutputAttributes(String contextLoggerOutputAttributes)

List of ContextMBean attributes to be output to context log

Supported API: true

getContextLoggerOutputAttributesSupported

String[] getContextLoggerOutputAttributesSupported()

List of attributes supported for use in ContextLoggerOutputAttributes

Supported API: true

isContextLoggerUseShortFormat

boolean isContextLoggerUseShortFormat()

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

Supported API: true

setContextLoggerUseShortFormat

void setContextLoggerUseShortFormat(boolean contextLoggerUseShortFormat)

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

Supported API: true

getContextLoggerSeparatorString

String getContextLoggerSeparatorString()

Item separator string used in context log format

Supported API: true

setContextLoggerSeparatorString

void setContextLoggerSeparatorString(String contextLoggerSeparatorString)

Item separator string used in context log format

Supported API: true

getContextLoggerFormatString

String getContextLoggerFormatString()

Low-level (java.util.Formatter) context log format string; if specified, overrides ContextLoggerUseShortFormat and ContextLoggerSeparatorString

Supported API: true

setContextLoggerFormatString

void setContextLoggerFormatString(String contextLoggerFormatString)

Low-level (java.util.Formatter) context log format string; if specified, overrides ContextLoggerUseShortFormat and ContextLoggerSeparatorString

Supported API: true

isContextRegistrationEnabled

boolean isContextRegistrationEnabled()

Whether contexts are automatically registered and deregistered as JMX MBeans as they are received and completed; enabling this can adversely affect performance

Supported API: true

setContextRegistrationEnabled

void setContextRegistrationEnabled(boolean contextRegistrationEnabled)

Whether contexts are automatically registered and deregistered as JMX MBeans as they are received and completed; enabling this can adversely affect performance

Supported API: true

getObjectCounterEnabled

boolean getObjectCounterEnabled()

Whether WTObject allocation counting is enabled

Supported API: true

setObjectCounterEnabled

void setObjectCounterEnabled(boolean objectCounterEnabled)

Whether WTObject allocation counting is enabled

Supported API: true

getObjectCounterData

CompositeData getObjectCounterData()
                                   throws OpenDataException

Data about WTObject allocation (no data will be collected unless ObjectCounterEnabled is true)

Supported API: true

Throws:

OpenDataException

isProcessCpuTimeMonitoringEnabled

boolean isProcessCpuTimeMonitoringEnabled()

Whether monitoring of overall process CPU time is enabled for this MBean; if not, then MethodContextMBean's ProcessPercentageOfTotalCpuTime and PercentageOfProcessCpuTime attributes will not have meaningful values, but this monitoring has somewhat substantive overhead

Supported API: true

setProcessCpuTimeMonitoringEnabled

void setProcessCpuTimeMonitoringEnabled(boolean processCpuTimeMonitoringEnabled)

Whether monitoring of overall process CPU time is enabled for this MBean; if not, then MethodContextMBean's ProcessPercentageOfTotalCpuTime and PercentageOfProcessCpuTime attributes will not have meaningful values, but this monitoring has somewhat substantive overhead

Supported API: true

interrupt

void interrupt(String contextId)

If specified context exists and is not completed, interrupts its thread. WARNING: This is a somewhat drastic operation which may have side-effects.

Supported API: true

Parameters:

contextId - Id of context to interrupt

captureActiveContext

long captureActiveContext(String contextId)

Creates a set of MBeans containing only the context with the specified id, if it is active, and returns the set's id; if no such context is active, -1 is returned

Supported API: true

Parameters:

contextId - Id of context to capture

captureActiveContexts

long captureActiveContexts()

Creates a set of MBeans representing all contexts currently being processed and returns its id

Supported API: true

releaseCapturedContexts

void releaseCapturedContexts()

Releases all ContextSets and the context MBeans they contain

Supported API: true

releaseCapturedContextSet

void releaseCapturedContextSet(long captureSetId)

Releases a set of MBeans previously captured with captureActiveContexts()

Supported API: true

Parameters:

captureSetId - Id of set of contexts to release (as returned by captureActiveContexts())

getActiveContextAttributes

AttributeList[] getActiveContextAttributes(String[] attributeNames)

Returns array of AttributeLists, one for each active context.

Supported API: true

Parameters:

attributeNames - Names of JMX attributes (of wt.method.MethodContextMBean) to retrieve; null implies all attributes