Package wt.queue

Interface QueueWatcherMBean

All Superinterfaces:
SelfEmailingMBean
public interface QueueWatcherMBean extends SelfEmailingMBean
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 Details

    • 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

    • QUEUE_STOPPED_NOTIFY_TYPE

      static final String QUEUE_STOPPED_NOTIFY_TYPE
      Type of notification produced when a queue is stopped

      Supported API: true

    • QUEUE_DISABLED_NOTIFY_TYPE

      static final String QUEUE_DISABLED_NOTIFY_TYPE
      Type of notification produced when a queue is disabled

      Supported API: true

  • Method Details

    • 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

      @MBeanOperationImpact(1) void checkEntryCounts() throws WTException
      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:
      WTException

    • 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

    • getTotalEntriesExecuted

      long getTotalEntriesExecuted()
      Total number of entries executed since last reset stats call

      Supported API: true

    • getTotalExecutionTime

      long getTotalExecutionTime()
      Total time (millis) spent executing queue entries since last reset stats call

      Supported API: true

    • resetPerformanceStats

      @MBeanOperationImpact(1) void resetPerformanceStats() throws WTException
      Resets queue performance statistics

      Supported API: true
      Throws:
      WTException

    • 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

    • getSevereFailedEntryCount

      Integer getSevereFailedEntryCount()
      Total Severe/Failed Entry Count

      Supported API: true