wt.queue
Interface QueueWatcherMBean

public interface QueueWatcherMBean

This class is the Management interface for the QueueWatcher class. It supports methods for monitoring the performance of a specific queue.

Supported API: true

Extendable: true

Field Summary

static String	EXCEEDED_EXECUTION_TIME_THRESHOLD_NOTIFY_TYPE Type of notification produced when the execution time of a single queue entry exceeds the configured threshold.
static String	EXCEEDED_TOTAL_ENTRIES_THRESHOLD_NOTIFY_TYPE Type of notification produced when the number of total queue entries exceeds configured threshold.
static String	EXCEEDED_WAITING_ENTRIES_THRESHOLD_NOTIFY_TYPE Type of notification produced when the number of waiting ready queue entries exceeds configured threshold.

Method Summary

void	checkEntryCounts() Method to check the total number of entries in a queue and the 'READY' waiting entries.
double	getAveEntryExecTimeSeconds() Average entry execution time Supported API: true
long	getEntryExecutionTimeThresholdSec() Current max entry execution time threshold Supported API: true
String	getExecutionThreadLoggerLevel() Current log level for this queue's execution thread (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) Supported API: true
String	getExecutionThreadLoggerName() Logger name for this QueueWatcher, unique to a queue Supported API: true
String	getLoggerLevel() Current log level for this QueueWatcher's logger (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) Supported API: true
String	getLoggerName() Logger name for this QueueWatcher, unique to a queue Supported API: true
double	getMaxEntryExecTimeSeconds() Maximum queue entry execution time (in seconds) Supported API: true
double	getMinEntryExecTimeSeconds() Minimum queue entry execution time (in seconds) Supported API: true
int	getMinMinutesBetweenNotifications() Current notification limit, no more than 1 notification should occur every x minutes Supported API: true
String	getName() Queue name for this QueueWatcher, unique to a queue Supported API: true
long	getTotalEntries() Total entries in a queue Supported API: true
int	getTotalThreshold() Current total entries threshold Supported API: true
long	getWaitingReadyEntries() Waiting ready queue entries Supported API: true
int	getWaitingReadyThreshold() Current notification threshold for waiting ready entries Supported API: true
void	resetPerformanceStats() Resets queue performance statistics Supported API: true
void	setEntryExecutionTimeThresholdSec(long threshold) Current max entry execution time threshold The threshold value must be greater than zero Supported API: true
void	setExecutionThreadLoggerLevel(String level) Current log level for this queue's execution thread (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) Supported API: true
void	setLoggerLevel(String level) Current log level for this QueueWatcher's logger (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) Supported API: true
void	setMinMinutesBetweenNotifications(int minutes) Current notification limit, no more than 1 notification should occur every x minutes This value must be greater than zero Supported API: true
void	setTotalThreshold(int threshold) Current total entries threshold The threshold value must be greater than zero Supported API: true
void	setWaitingReadyThreshold(int threshold) Current notification threshold for waiting ready entries The threshold value must be greater than zero Supported API: true

Field Detail

EXCEEDED_WAITING_ENTRIES_THRESHOLD_NOTIFY_TYPE

static final String EXCEEDED_WAITING_ENTRIES_THRESHOLD_NOTIFY_TYPE

Type of notification produced when the number of waiting ready queue entries exceeds configured threshold.

Supported API: true

EXCEEDED_TOTAL_ENTRIES_THRESHOLD_NOTIFY_TYPE

static final String EXCEEDED_TOTAL_ENTRIES_THRESHOLD_NOTIFY_TYPE

Type of notification produced when the number of total queue entries exceeds configured threshold.

Supported API: true

EXCEEDED_EXECUTION_TIME_THRESHOLD_NOTIFY_TYPE

static final String EXCEEDED_EXECUTION_TIME_THRESHOLD_NOTIFY_TYPE

Type of notification produced when the execution time of a single queue entry exceeds the configured threshold.

Supported API: true

Method Detail

getName

String getName()

Queue name for this QueueWatcher, unique to a queue

Supported API: true

getLoggerName

String getLoggerName()

Logger name for this QueueWatcher, unique to a queue

Supported API: true

getLoggerLevel

String getLoggerLevel()

Current log level for this QueueWatcher's logger (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

Supported API: true

setLoggerLevel

void setLoggerLevel(String level)

Current log level for this QueueWatcher's logger (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

Supported API: true

getExecutionThreadLoggerName

String getExecutionThreadLoggerName()

Logger name for this QueueWatcher, unique to a queue

Supported API: true

getExecutionThreadLoggerLevel

String getExecutionThreadLoggerLevel()

Current log level for this queue's execution thread (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

Supported API: true

setExecutionThreadLoggerLevel

void setExecutionThreadLoggerLevel(String level)

Current log level for this queue's execution thread (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

Supported API: true

checkEntryCounts

void checkEntryCounts()
                      throws Exception

Method to check the total number of entries in a queue and the 'READY' waiting entries. Both of these counts have associated notification thresholds.

Supported API: true

Throws:

Exception

getTotalEntries

long getTotalEntries()

Total entries in a queue

Supported API: true

getWaitingReadyEntries

long getWaitingReadyEntries()

Waiting ready queue entries

Supported API: true

getAveEntryExecTimeSeconds

double getAveEntryExecTimeSeconds()

Average entry execution time

Supported API: true

getMaxEntryExecTimeSeconds

double getMaxEntryExecTimeSeconds()

Maximum queue entry execution time (in seconds)

Supported API: true

getMinEntryExecTimeSeconds

double getMinEntryExecTimeSeconds()

Minimum queue entry execution time (in seconds)

Supported API: true

resetPerformanceStats

void resetPerformanceStats()
                           throws Exception

Resets queue performance statistics

Supported API: true

Throws:

Exception

getWaitingReadyThreshold

int getWaitingReadyThreshold()

Current notification threshold for waiting ready entries

Supported API: true

setWaitingReadyThreshold

void setWaitingReadyThreshold(int threshold)
                              throws Exception

Current notification threshold for waiting ready entries The threshold value must be greater than zero

Supported API: true

Throws:

Exception

getTotalThreshold

int getTotalThreshold()

Current total entries threshold

Supported API: true

setTotalThreshold

void setTotalThreshold(int threshold)
                       throws Exception

Current total entries threshold The threshold value must be greater than zero

Supported API: true

Throws:

Exception

getEntryExecutionTimeThresholdSec

long getEntryExecutionTimeThresholdSec()

Current max entry execution time threshold

Supported API: true

setEntryExecutionTimeThresholdSec

void setEntryExecutionTimeThresholdSec(long threshold)
                                       throws Exception

Current max entry execution time threshold The threshold value must be greater than zero

Supported API: true

Throws:

Exception

setMinMinutesBetweenNotifications

void setMinMinutesBetweenNotifications(int minutes)
                                       throws Exception

Current notification limit, no more than 1 notification should occur every x minutes This value must be greater than zero

Supported API: true

Throws:

Exception

getMinMinutesBetweenNotifications

int getMinMinutesBetweenNotifications()

Current notification limit, no more than 1 notification should occur every x minutes

Supported API: true