[ViewVC] Diff of: i-scream/projects/cms/source/server/uk/org/iscream/cms/server/client/Register.java

Comparing projects/cms/source/server/uk/org/iscream/cms/server/client/Register.java (file contents):
Revision 1.1 by ajm, Fri Mar 2 03:56:06 2001 UTC vs.
Revision 1.20 by tdb, Wed Feb 5 16:43:45 2003 UTC

-+
+/*
-+
+ * i-scream central monitoring system
-+
+ * http://www.i-scream.org.uk
-+
+ * Copyright (C) 2000-2002 i-scream
-+
+ *
-+
+ * This program is free software; you can redistribute it and/or
-+
+ * modify it under the terms of the GNU General Public License
-+
+ * as published by the Free Software Foundation; either version 2
-+
+ * of the License, or (at your option) any later version.
-+
+ *
-+
+ * This program is distributed in the hope that it will be useful,
-+
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
-+
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-+
+ * GNU General Public License for more details.
-+
+ *
-+
+ * You should have received a copy of the GNU General Public License
-+
+ * along with this program; if not, write to the Free Software
-+
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-+
+ */
-+
+//---PACKAGE DECLARATION---
-<
+package uk.ac.ukc.iscream.client;
->
+package uk.org.iscream.cms.server.client;
+//---IMPORTS---
-<
+import uk.ac.ukc.iscream.util.*;
->
+import uk.org.iscream.cms.util.*;
->
+import uk.org.iscream.cms.server.componentmanager.*;
+/**
-<
+ * Register class
->
+ * The Register class holds theshold values,
->
+ * the last level of alert for each attribute for a monitor
->
+ * and the time of last alert sent for each alert level.
-+
+ * This class is used by monitor classes so they can determine
-+
+ * how often they should send alerts when breaching alert levels.
-+
+ * It also stores (and keeps uptodate (via the configuration proxy)
-+
+ * the threshold values for the monitor.
-+
+ *
+ * @author  $Author$
+ * @version $Id$
+ */
+//---CONSTRUCTORS---
+    /**
-<
+     * Construct a Register
->
+     * Construct a Register with the hostname and monitorName
->
+     * (for obtaining the threshold values).
->
+     * This constructs a generic register for a specific monitor.
-<
+     * @param size the size of the register
->
+     * @param hostname the hostname this register is for
->
+     * @param monitorName the monitor this register is for
+     */
-<
+    public Register(int size) {
-<
+        _register = new int[size];
-<
+        for (int x = 0; x < _register.length; x++) {
-<
+            _register[x] = 0;
->
+    public Register(String hostname, String monitorName) {
->
+        this(hostname, monitorName, null);
->
+    }
->
->
+    /**
->
+     * Construct a Register with the hostname and monitorName
->
+     * (for obtaining the threshold values).
->
+     * This constructs a register for a specific attribute check
->
+     * by a monitor.
->
+     *
->
+     * @param hostname the hostname this register is for
->
+     * @param monitorName the monitor this register is for
->
+     * @param attributeName the specific attribute this register is for
->
+     */
->
+    public Register(String hostname, String monitorName, String attributeName) {
->
+        _hostname = hostname;
->
+        _monitorName = monitorName;
->
+        _attributeName = attributeName;
->
+        _lastAlertLevel = 0;
->
+        _lastThresholdLevel = 0;
->
+        _initialAlertTime= 0;
->
+        _lastAlertTimeout = 0;
->
+        _times = new long[Alert.alertLevels.length];
->
+        // initialise the arrays to 0
->
+        for(int x = 0; x < Alert.alertLevels.length; x++) {
->
+            _times[x] = 0;
-+
+//---PUBLIC METHODS---
+//---PRIVATE METHODS---
-+
+    /**
-+
+     * Obtains a threshold value from the configuration for a given level.
-+
+     * The attribute name specifies which property to get.
-+
+     * eg, attributeName = idle it will look for
-+
+     *     Monitor.<monitor name>.idle.threshold.<alert level>
-+
+     * eg, attributeName = null
-+
+     *     Monitor.<monitor name>.threshold.<alert level>
-+
+     *
-+
+     * Note that if its null, this will get the threshold for the monitor
-+
+     * as a whole, not the specific attribute.
-+
+     *
-+
+     * @param level the alert level to get the attribute for
-+
+     * @param attributeName the attribute to get the threshold for
-+
+     *
-+
+     * @return the threshold obtained
-+
+     */
-+
+    private String getThresholdConfig(int level, String attributeName) throws PropertyNotFoundException {
-+
+        String temp = "";
-+
+        if (attributeName != null) {
-+
+            temp = "." + attributeName;
-+
+        }
-+
+        return _cp.getProperty("Host." + _hostname, "Monitor." + _monitorName + temp + ".threshold." + Alert.thresholdLevels[level]);
-+
+    }
-+
+//---ACCESSOR/MUTATOR METHODS---
-<
+    public int getRegister(int register) {
-<
+        return _register[register];
->
+    /**
->
+     * Gets the last alert level
->
+     *
->
+     * @return the last alert level
->
+     */
->
+    public int getLastAlertLevel() {
->
+        return _lastAlertLevel;
-<
+    public void setRegister(int register, int value) {
-<
+        _register[register] = value;
->
+    /**
->
+     * Sets the last threshold level
->
+     *
->
+     * @param level the new last threshold level
->
+     */
->
+    public void setLastThresholdLevel(int level) {
->
+        _lastThresholdLevel = level;
-+
-+
+    /**
-+
+     * Gets the last threshold level
-+
+     *
-+
+     * @return the last threshold level
-+
+     */
-+
+    public int getLastThresholdLevel() {
-+
+        return _lastThresholdLevel;
-+
+    }
-+
-+
+    /**
-+
+     * Sets the last alert level
-+
+     *
-+
+     * Note that if this is setting to an OK
-+
+     * level alert, it resets _maxLevelCount.
-+
+     *
-+
+     * This also sets the "initialAlertTime"
-+
+     * if the next alert after OK is set.
-+
+     * And resets it to 0 if it IS an OK.
-+
+     *
-+
+     * @param level the new last alert level
-+
+     */
-+
+    public void setLastAlertLevel(int level) {
-+
+        _lastAlertLevel = level;
-+
+        if (level == Alert.alertOK) {
-+
+            _maxLevelCount = 0;
-+
+            // we won't do this, so OK's still have the initialAlertTime
-+
+            // of the original alert they're OK'ing
-+
+            //_initialAlertTime = 0;
-+
+        }
-+
+        if (level == Alert.alertOK + 1) {
-+
+            _initialAlertTime = System.currentTimeMillis();
-+
+        }
-+
+    }
-+
-+
+    /**
-+
+     * Gets the time an alert was sent at the given level.
-+
+     *
-+
+     * @param level the alert level to get
-+
+     *
-+
+     * @return the time last sent
-+
+     */
-+
+    public long getTimeLastSent() {
-+
+        return _times[getLastAlertLevel()];
-+
+    }
-+
-+
+    /**
-+
+     * Gets the time an alert was sent at the given level.
-+
+     *
-+
+     * @param level the alert level to get
-+
+     * @param value the new time
-+
+     */
-+
+    public void setTimeLastSent(long value) {
-+
+        _times[getLastAlertLevel()] = value;
-+
+    }
-+
-+
+    /**
-+
+     * Gets the threshold value for the given
-+
+     * level of alert.
-+
+     *
-+
+     * If there is no alert threshold for a
-+
+     * given level, this returns -1.0
-+
+     *
-+
+     * @param level the alert level
-+
+     */
-+
+    public double getThreshold(int level) {
-+
+        // -1.0 means we don't use an alert level
-+
+        double threshold = -1.0;
-+
+        try {
-+
+            String thresholdString = "";
-+
+            try {
-+
+                thresholdString = getThresholdConfig(level, _attributeName);
-+
+            } catch (PropertyNotFoundException e) {
-+
+                thresholdString = getThresholdConfig(level, null);
-+
+            }
-+
+            threshold = Double.parseDouble(thresholdString);
-+
+        } catch (PropertyNotFoundException e) {
-+
+            threshold = -1.0;
-+
+        } catch (NumberFormatException e) {
-+
+            threshold = -1.0;
-+
+        }
-+
+        return threshold;
-+
+    }
-+
-+
+    /**
-+
+     * Gets the alert timeout value for the given
-+
+     * level of alert.  This value is in millis,
-+
+     * and is converted from the value in the config,
-+
+     * which should be seconds.
-+
+     *
-+
+     * Note that if the alert timeout for the current monitor
-+
+     * is not configured, it will try to obtain the default
-+
+     * timeout for all Monitor's.  If there is no alert timeout
-+
+     * for either the monitor or a default setting this returns 0.
-+
+     *
-+
+     * Note that this is dependant on the threshold value
-+
+     * given, the timeout is obatined from the config, then
-+
+     * divided by the threshold value, this allows alerts to
-+
+     * progress faster should a higher threshold value be passed
-+
+     *
-+
+     * @param level the alert level
-+
+     * @param thresholdLevel the threshold leve we are on
-+
+     */
-+
+    public long getAlertTimeout(int level) {
-+
+        // 0 means we don't use this value
-+
+        long timeout = 0;
-+
+        try {
-+
+            String timeoutString;
-+
+            try {
-+
+                timeoutString = _cp.getProperty("Host." + _hostname, "Monitor." + _monitorName + ".alertTimeout." + Alert.alertLevels[level]);
-+
+            } catch (PropertyNotFoundException e) {
-+
+                // if there is no timeout for the monitor
-+
+                // check for a default
-+
+                timeoutString = _cp.getProperty("Host." + _hostname, "Monitor.alertTimeout." + Alert.alertLevels[level]);
-+
+            }
-+
+            int threshold = getLastThresholdLevel();
-+
+            if (threshold > 0) {
-+
+                timeout = (Long.parseLong(timeoutString) / threshold) * 1000;
-+
+            }
-+
+        } catch (PropertyNotFoundException e) {
-+
+            timeout = 0;
-+
+        } catch (NumberFormatException e) {
-+
+            timeout = 0;
-+
+        }
-+
+        return timeout;
-+
+    }
-+
-+
+    /**
-+
+     * Either advances to the next alert level, or if
-+
+     * the maximum alert level has been reached, simply returns
-+
+     * that.
-+
+     *
-+
+     * Note this method will NEVER reach the last alert level
-+
+     * in the list, this is assumed to be FINAL, and special
-+
+     * logic is in place to handle that.
-+
+     *
-+
+     */
-+
+    public int getNextAlertLevel() {
-+
+        if((getLastAlertLevel() + 1) > (Alert.alertLevels.length - 2)) {
-+
+            return getLastAlertLevel();
-+
+        }
-+
+        return getLastAlertLevel() + 1;
-+
+    }
-+
+    /**
-+
+     * Gets the timeout value of the last alert
-+
+     * sent
-+
+     *
-+
+     * @return the last timeout value
-+
+     */
-+
+    public long getLastAlertTimeout() {
-+
+        return _lastAlertTimeout;
-+
+    }
-+
-+
+    /**
-+
+     * Sets the timeout value of the last alert
-+
+     * sent
-+
+     *
-+
+     * @param timeout the new value
-+
+     */
-+
+    public void setLastAlertTimeout(long timeout) {
-+
+        _lastAlertTimeout = timeout;
-+
+    }
-+
-+
+    /**
-+
+     * Returns the time that the first alert was sent
-+
+     * for an attribute that has passed a threshold value
-+
+     *
-+
+     */
-+
+    public long getInitialAlertTime() {
-+
+        return _initialAlertTime;
-+
+    }
-+
-+
+    /**
-+
+     * Advances the alert level to the next one up.
-+
+     *
-+
+     * This keeps track of the number of the number
-+
+     * of times the highest NON-FINAL alert level
-+
+     * has been reached.  Note this isn't a specific
-+
+     * level, just the highest, so you could configure
-+
+     * more levels and not affect this.
-+
+     *
-+
+     * If the count exceeds the number of times
-+
+     * set in the configuration, it escalates to
-+
+     * a FINAL alert if we're using FINAL's.
-+
+     *
-+
+     * It determines if to use FINAL's from the config
-+
+     * entry reachFINALcount, when the count exceeds
-+
+     * this value, it escalates to a FINAL.  If that attribute
-+
+     * is mis-read or is not configured.  It will NEVER reach
-+
+     * a FINAL.
-+
+     *
-+
+     */
-+
+    public void escalateAlert() {
-+
+        // don't escalate if we're already on the last alert
-+
+        if(getLastAlertLevel() != Alert.alertLevels.length -1) {
-+
+            setLastAlertLevel(getNextAlertLevel());
-+
+        }
-+
+        try {
-+
+            // note if we fail to get this value, we won't process the res of this
-+
+            int reachFINALcount = Integer.parseInt(_cp.getProperty("Host." + _hostname, "Monitor." + _monitorName + ".reachFINALcount"));
-+
+            if (getLastAlertLevel() == Alert.alertLevels.length - 2) {
-+
+                _maxLevelCount++;
-+
+                if(_maxLevelCount > reachFINALcount) {
-+
+                    setLastAlertLevel(Alert.alertFINAL);
-+
+                }
-+
+            }
-+
+        } catch (PropertyNotFoundException e) {
-+
+            // we NEVER reach FINAL in this case
-+
+        } catch (NumberFormatException e) {
-+
+            // we NEVER reach FINAL in this case
-+
+        }
-+
+    }
-+
+//---ATTRIBUTES---
-<
+    private int[] _register;
->
+    /**
->
+     * The host this register is for
->
+     */
->
+    private String _hostname;
->
->
+    /**
->
+     * The monitor this register is for
->
+     */
->
+    private String _monitorName;
->
->
+    /**
->
+     * The attribute name, as obtained from
->
+     * the configuration.
->
+     * eg, idle or /var
->
+     */
->
+    private String _attributeName;
->
->
+    /**
->
+     * An array of last alert levels for
->
+     * each attribute this register is looking
->
+     * after.
->
+     */
->
+    private int _lastAlertLevel;
->
->
+    /**
->
+     * An array of last threshold levels for
->
+     * each attribute this register is looking
->
+     * after.
->
+     */
->
+    private int _lastThresholdLevel;
->
->
+    /**
->
+     * An array of last alert timeout levels for
->
+     * each attribute this register is looking
->
+     * after.
->
+     */
->
+    private long _lastAlertTimeout;
->
->
+    /**
->
+     * An array of arrays containing
->
+     * time an alert of each level
->
+     * was last sent for each attribute.
->
+     */
->
+    private long[] _times;
->
->
+    /**
->
+     * Initial times that an alert was first
->
+     * raised.
->
+     */
->
+    private long _initialAlertTime;
->
->
+    /**
->
+     * A reference to the configuration proxy in use
->
+     */
->
+    private ConfigurationProxy _cp = ConfigurationProxy.getInstance();
->
->
+    /**
->
+     * The number of times the maximum level alert
->
+     * has occured IN A ROW, this is escalated by
->
+     * the escalate(int) method, and reset by the
->
+     * setLastAlertLevel(int, int) method
->
+     */
->
+    private int _maxLevelCount = 0;
+//---STATIC ATTRIBUTES---

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing projects/cms/source/server/uk/org/iscream/cms/server/client/Register.java (file contents): Revision 1.1 by ajm, Fri Mar 2 03:56:06 2001 UTC vs. Revision 1.20 by tdb, Wed Feb 5 16:43:45 2003 UTC

Diff Legend

Comparing projects/cms/source/server/uk/org/iscream/cms/server/client/Register.java (file contents):
Revision 1.1 by ajm, Fri Mar 2 03:56:06 2001 UTC vs.
Revision 1.20 by tdb, Wed Feb 5 16:43:45 2003 UTC