Package Summary  Overview Summary

class:GaugeMonitor [NONE]

  • All Implemented Interfaces:
    MBeanRegistration, GaugeMonitorMBean, MonitorMBean, NotificationBroadcaster, NotificationEmitter

    public class GaugeMonitor
    extends Monitor
    implements GaugeMonitorMBean
    
    Defines a monitor MBean designed to observe the values of a gauge attribute.

    A gauge monitor observes an attribute that is continuously variable with time. A gauge monitor sends notifications as follows:

    • if the attribute value is increasing and becomes equal to or greater than the high threshold value, a threshold high notification is sent. The notify high flag must be set to true.
      Subsequent crossings of the high threshold value do not cause further notifications unless the attribute value becomes equal to or less than the low threshold value.
    • if the attribute value is decreasing and becomes equal to or less than the low threshold value, a threshold low notification is sent. The notify low flag must be set to true.
      Subsequent crossings of the low threshold value do not cause further notifications unless the attribute value becomes equal to or greater than the high threshold value.
    This provides a hysteresis mechanism to avoid repeated triggering of notifications when the attribute value makes small oscillations around the high or low threshold value.

    If the gauge difference mode is used, the value of the derived gauge is calculated as the difference between the observed gauge values for two successive observations.
    The derived gauge value (V[t]) is calculated using the following method:

    • V[t] = gauge[t] - gauge[t-GP]
    This implementation of the gauge monitor requires the observed attribute to be of the type integer or floating-point (Byte, Integer, Short, Long, Float, Double).

    Since:
    1.5

constructor:<init>() [NONE]

  • GaugeMonitor

    public GaugeMonitor()
    Default constructor.

method:start() [NONE]

method:stop() [NONE]

  • stop

    public void stop()
    Stops the gauge monitor.
    Specified by:
    stop in interface MonitorMBean
    Specified by:
    stop in class Monitor

method:getDerivedGauge(javax.management.ObjectName) [NONE]

  • getDerivedGauge

    public Number getDerivedGauge​(ObjectName object)
    Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, or null otherwise.
    Specified by:
    getDerivedGauge in interface GaugeMonitorMBean
    Parameters:
    object - the name of the MBean.
    Returns:
    The derived gauge of the specified object.

method:getDerivedGaugeTimeStamp(javax.management.ObjectName) [NONE]

  • getDerivedGaugeTimeStamp

    public long getDerivedGaugeTimeStamp​(ObjectName object)
    Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or 0 otherwise.
    Specified by:
    getDerivedGaugeTimeStamp in interface GaugeMonitorMBean
    Parameters:
    object - the name of the object whose derived gauge timestamp is to be returned.
    Returns:
    The derived gauge timestamp of the specified object.

method:getDerivedGauge() [NONE]

method:getDerivedGaugeTimeStamp() [NONE]

method:getHighThreshold() [NONE]

method:getLowThreshold() [NONE]

method:setThresholds(java.lang.Number,java.lang.Number) [NONE]

method:getNotifyHigh() [NONE]

  • getNotifyHigh

    public boolean getNotifyHigh()
    Gets the high notification's on/off switch value common to all observed MBeans.
    Specified by:
    getNotifyHigh in interface GaugeMonitorMBean
    Returns:
    true if the gauge monitor notifies when exceeding the high threshold, false otherwise.
    See Also:
    setNotifyHigh(boolean)

method:setNotifyHigh(boolean) [NONE]

  • setNotifyHigh

    public void setNotifyHigh​(boolean value)
    Sets the high notification's on/off switch value common to all observed MBeans.
    Specified by:
    setNotifyHigh in interface GaugeMonitorMBean
    Parameters:
    value - The high notification's on/off switch value.
    See Also:
    getNotifyHigh()

method:getNotifyLow() [NONE]

  • getNotifyLow

    public boolean getNotifyLow()
    Gets the low notification's on/off switch value common to all observed MBeans.
    Specified by:
    getNotifyLow in interface GaugeMonitorMBean
    Returns:
    true if the gauge monitor notifies when exceeding the low threshold, false otherwise.
    See Also:
    setNotifyLow(boolean)

method:setNotifyLow(boolean) [NONE]

  • setNotifyLow

    public void setNotifyLow​(boolean value)
    Sets the low notification's on/off switch value common to all observed MBeans.
    Specified by:
    setNotifyLow in interface GaugeMonitorMBean
    Parameters:
    value - The low notification's on/off switch value.
    See Also:
    getNotifyLow()

method:getDifferenceMode() [NONE]

method:setDifferenceMode(boolean) [NONE]

  • setDifferenceMode

    public void setDifferenceMode​(boolean value)
    Sets the difference mode flag value common to all observed MBeans.
    Specified by:
    setDifferenceMode in interface GaugeMonitorMBean
    Parameters:
    value - The difference mode flag value.
    See Also:
    getDifferenceMode()

method:getNotificationInfo() [NONE]

© 2018 Oracle Corporation and/or its affiliates