Package Summary  Overview Summary

class:CounterMonitor [NONE]

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

    public class CounterMonitor
    extends Monitor
    implements CounterMonitorMBean
    
    Defines a monitor MBean designed to observe the values of a counter attribute.

    A counter monitor sends a threshold notification when the value of the counter reaches or exceeds a threshold known as the comparison level. The notify flag must be set to true.

    In addition, an offset mechanism enables particular counting intervals to be detected. If the offset value is not zero, whenever the threshold is triggered by the counter value reaching a comparison level, that comparison level is incremented by the offset value. This is regarded as taking place instantaneously, that is, before the count is incremented. Thus, for each level, the threshold triggers an event notification every time the count increases by an interval equal to the offset value.

    If the counter can wrap around its maximum value, the modulus needs to be specified. The modulus is the value at which the counter is reset to zero.

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

    • if (counter[t] - counter[t-GP]) is positive then V[t] = counter[t] - counter[t-GP]
    • if (counter[t] - counter[t-GP]) is negative then V[t] = counter[t] - counter[t-GP] + MODULUS
    This implementation of the counter monitor requires the observed attribute to be of the type integer (Byte, Integer, Short, Long).

    Since:
    1.5

constructor:<init>() [NONE]

  • CounterMonitor

    public CounterMonitor()
    Default constructor.

method:start() [NONE]

method:stop() [NONE]

  • stop

    public void stop()
    Stops the counter 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 CounterMonitorMBean
    Parameters:
    object - the name of the object whose derived gauge is to be returned.
    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 CounterMonitorMBean
    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:getThreshold(javax.management.ObjectName) [NONE]

method:getInitThreshold() [NONE]

method:setInitThreshold(java.lang.Number) [NONE]

method:getDerivedGauge() [NONE]

method:getDerivedGaugeTimeStamp() [NONE]

method:getThreshold() [NONE]

method:setThreshold(java.lang.Number) [NONE]

method:getOffset() [NONE]

method:setOffset(java.lang.Number) [NONE]

method:getModulus() [NONE]

method:setModulus(java.lang.Number) [NONE]

method:getNotify() [NONE]

  • getNotify

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

method:setNotify(boolean) [NONE]

  • setNotify

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

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 CounterMonitorMBean
    Parameters:
    value - The difference mode flag value.
    See Also:
    getDifferenceMode()

method:getNotificationInfo() [NONE]

© 2018 Oracle Corporation and/or its affiliates