client/monitors/Disk__Monitor.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.client.monitors;

//---IMPORTS---
import java.util.HashMap;
import java.util.ArrayList;
import java.util.Set;
import java.util.Iterator;
import java.text.NumberFormat;
import uk.org.iscream.cms.server.client.*;
import uk.org.iscream.cms.server.core.*;
import uk.org.iscream.cms.server.util.*;
import uk.org.iscream.cms.server.componentmanager.*;

/**
 * This Monitor watches the Disks for all machines
 *
 * @author  $Author: tdb1 $
 * @version $Id: Disk__Monitor.java,v 1.13 2001/11/15 11:47:30 tdb1 Exp $
 */
public class Disk__Monitor extends MonitorSkeleton {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.13 $";
    
    /**
     * A description of this monitor
     */
    public final String DESC = "Monitors all host disks.";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---
    
    /**
     * Analyse a packet of data, and generate an alert if
     * necessary.
     *
     * @param packet the XMLPacket to analyse
     */
    public void analysePacket(XMLPacket packet) {
        String source = packet.getParam("packet.attributes.machine_name");
        if (!_hosts.containsKey(source)) {
            _hosts.put(source, new HashMap());
        }

        HashMap diskRegisters = (HashMap) _hosts.get(source);
        
        // key prefix
        String keyPrefix = "packet.disk.p";
        
        // a temporary holder for all the disk attributes we find
        ArrayList disks = new ArrayList();

        // unfortunatly we need to check the whole packet
        // to find the disks, and then get the data attributes
        Set packetSet = packet.getSet();
        Iterator i = packetSet.iterator();
        while (i.hasNext()) {
            String dataKey = (String) i.next();
            if(dataKey.startsWith(keyPrefix)) {
                if(!disks.contains(dataKey)) {
                    String diskNumber = "";

                    // pos is after "packet.disk.p"
                    int pos = keyPrefix.length();
                    while (dataKey.charAt(pos) != '.') {
                        diskNumber = diskNumber + dataKey.charAt(pos);
                        pos++;
                    }

                    // add the disk to our list, with the packet data

                    // used (we won't use this value - but we need it to forget about it ;)
                    disks.add(keyPrefix + diskNumber + ".attributes.used");

                    // device
                    disks.add(keyPrefix + diskNumber + ".attributes.name");
                    String device = packet.getParam(keyPrefix + diskNumber + ".attributes.name");
                    // mount point
                    disks.add(keyPrefix + diskNumber + ".attributes.mount");
                    String mount = packet.getParam(keyPrefix + diskNumber + ".attributes.mount");

                    // these next two will be used to calculate the %age
                    // total
                    disks.add(keyPrefix + diskNumber + ".attributes.kbytes");
                    String total = packet.getParam(keyPrefix + diskNumber + ".attributes.kbytes");
                    // available
                    disks.add(keyPrefix + diskNumber + ".attributes.avail");
                    String avail = packet.getParam(keyPrefix + diskNumber + ".attributes.avail");

                    // *** now process this disk ***

                    // check if we've seen this disk before on a previous run
                    // if not, we need to create a register for it
                    //   nb. use the device as the key as this is unlikely to change,
                    //       unlike diskNumber which could easily change
                    //         (diskNumber is based on the order of df's output!)
                    if(!diskRegisters.containsKey(device)) {
                        diskRegisters.put(device, new Register(source, _name, mount));
                    }

                    // get the register for this disk
                    Register reg = (Register) diskRegisters.get(device);

                    // get the packet data
                    double diskTotal, diskAvail;
                    try {

                        if(total==null || avail==null) {
                            throw new NumberFormatException("Disk data invalid");
                        }
                        diskTotal = Double.parseDouble(total);
                        diskAvail = Double.parseDouble(avail);
                    } catch (NumberFormatException e) {
                        _logger.write(this.toString(), Logger.WARNING, "Received packet from "+source+" with bad disk information: "+e);
                        // don't try to continue and process, try next disk
                        break;
                    }

                    boolean useValue = false;
                    try {
                        // try looking for a mount-point specific thresholdMeasure first
                        String option = _cp.getProperty("Host." + source, "Monitor." + _name + "." + mount + ".thresholdMeasure");
                        if (option.equals("VALUE")) {
                            useValue = true;
                        }
                    } catch (PropertyNotFoundException e) {
                        try {
                            // now look for a more general thresholdMeasure
                            String option = _cp.getProperty("Host." + source, "Monitor." + _name + ".thresholdMeasure");
                            if (option.equals("VALUE")) {
                                useValue = true;
                            }
                        } catch (PropertyNotFoundException f) {
                            // we default to percentage in any case
                        }
                    }

                    // this  bit determines if the disk check is a % check
                    // or a kb check
                    String type;
                    double curValue;
                    int newThreshold;
                    if(useValue) {
                        // kb disk available
                        curValue = diskAvail;
                        // negate check
                        newThreshold = checkAttributeThreshold(curValue, reg, true);
                        type = "kb";
                    } else {
                        // % disk in use
                        curValue = (1 - (diskAvail / diskTotal)) * 100;
                        // normal check
                        newThreshold = checkAttributeThreshold(curValue, reg, false);
                        type = "%";
                    }

                    // format the diskInUse to a String
                    NumberFormat nf = NumberFormat.getInstance();
                    nf.setMaximumFractionDigits(2);
                    nf.setMinimumFractionDigits(2);
                    String strCurValue = nf.format(curValue);

                    // say which disk had the problem
                    String attributeName = "Disk in use " + type + " on " + mount + " (" + device + ")";

                    processAlert(newThreshold, attributeName, reg, source, strCurValue);
                }
            }
        }
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.org.iscream.cms.server.util.NameFormat class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

    /**
     * return the String representation of what the monitor does
     */
    public String getDescription(){
        return DESC;
    }

//---PRIVATE METHODS---
    
    /**
     * Checks a piece of current data, and returns the
     * threshold it breaches, if any.
     *
     * The option to negate the check can be used in
     * situations where being *below* the threshold
     * is an 'alertable' situation. In this specific
     * case, we'd do this with kb disk checks.
     *
     * @param value the current value
     * @param reg the Register for the host
     * @param negateCheck whether to negate the check
     * @return the threshold level breached, if any
     */
    private int checkAttributeThreshold(double value, Register reg, boolean negateCheck) {
        for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
            if (reg.getThreshold(thresholdLevel) != -1.0) {
                if(!negateCheck) {
                    // normal check - has the value gone *over* the threshold
                    if(((double) reg.getThreshold(thresholdLevel)) < value) {
                        return thresholdLevel;
                    }
                }
                else {
                    // negated check - has the value gone *under* the threshold
                    if(((double) reg.getThreshold(thresholdLevel)) > value) {
                        return thresholdLevel;
                    }
                }
            }
        }
        return Alert.thresholdNORMAL;
    }

//---ACCESSOR/MUTATOR METHODS---
    
    /**
     * Returns a reference to a specific Queue for this
     * monitor. This Queue returns only the data packets
     * (based on type) that we want too look at.
     *
     * @return a reference to a Queue
     */
    protected Queue getQueue() {
        return MonitorManager.getInstance().getDataQueue();
    }
    
//---ATTRIBUTES---

    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = "Disk";
    
    /**
     * A reference to the configuration proxy in use
     */
    private ConfigurationProxy _cp = ConfigurationProxy.getInstance();
    
    /**
     * A HashMap of Registers (or groups of Registers), one
     * for each host we're monitoring.
     */
    private HashMap _hosts = new HashMap();

//---STATIC ATTRIBUTES---

}
Revision:	1.14
Committed:	Mon Nov 26 11:59:19 2001 UTC (22 years, 5 months ago) by tdb
Branch:	MAIN
Changes since 1.13:	+5 -5 lines
Log Message:	Changed the Memory Monitor to correctly deal with "kb" values. This parallels the change in the Disk Monitor detailed by this Sourceforge bug tracker: [ #476364 ] disk monitor using 'value' thresholds
#	User	Rev	Content
1	ajm	1.1	//---PACKAGE DECLARATION---
2	tdb	1.9	package uk.org.iscream.cms.server.client.monitors;
3	ajm	1.1
4			//---IMPORTS---
5			import java.util.HashMap;
6			import java.util.ArrayList;
7			import java.util.Set;
8			import java.util.Iterator;
9			import java.text.NumberFormat;
10	tdb	1.9	import uk.org.iscream.cms.server.client.*;
11			import uk.org.iscream.cms.server.core.*;
12			import uk.org.iscream.cms.server.util.*;
13			import uk.org.iscream.cms.server.componentmanager.*;
14	ajm	1.1
15			/**
16			* This Monitor watches the Disks for all machines
17			*
18	tdb	1.9	* @author $Author: tdb1 $
19	tdb	1.14	* @version $Id: Disk__Monitor.java,v 1.13 2001/11/15 11:47:30 tdb1 Exp $
20	ajm	1.1	*/
21			public class Disk__Monitor extends MonitorSkeleton {
22
23			//---FINAL ATTRIBUTES---
24
25			/**
26			* The current CVS revision of this class
27			*/
28	tdb	1.14	public final String REVISION = "$Revision: 1.13 $";
29	ajm	1.1
30	tdb	1.8	/**
31			* A description of this monitor
32			*/
33	ajm	1.1	public final String DESC = "Monitors all host disks.";
34
35			//---STATIC METHODS---
36
37			//---CONSTRUCTORS---
38
39			//---PUBLIC METHODS---
40	tdb	1.8
41			/**
42			* Analyse a packet of data, and generate an alert if
43			* necessary.
44			*
45			* @param packet the XMLPacket to analyse
46			*/
47	ajm	1.1	public void analysePacket(XMLPacket packet) {
48	ajm	1.7	String source = packet.getParam("packet.attributes.machine_name");
49			if (!_hosts.containsKey(source)) {
50			_hosts.put(source, new HashMap());
51			}
52
53			HashMap diskRegisters = (HashMap) _hosts.get(source);
54	tdb	1.8
55			// key prefix
56			String keyPrefix = "packet.disk.p";
57
58	tdb	1.11	// a temporary holder for all the disk attributes we find
59	ajm	1.7	ArrayList disks = new ArrayList();
60
61			// unfortunatly we need to check the whole packet
62			// to find the disks, and then get the data attributes
63			Set packetSet = packet.getSet();
64			Iterator i = packetSet.iterator();
65			while (i.hasNext()) {
66			String dataKey = (String) i.next();
67	tdb	1.8	if(dataKey.startsWith(keyPrefix)) {
68	ajm	1.7	if(!disks.contains(dataKey)) {
69			String diskNumber = "";
70
71			// pos is after "packet.disk.p"
72	tdb	1.8	int pos = keyPrefix.length();
73	ajm	1.7	while (dataKey.charAt(pos) != '.') {
74			diskNumber = diskNumber + dataKey.charAt(pos);
75			pos++;
76			}
77
78			// add the disk to our list, with the packet data
79
80			// used (we won't use this value - but we need it to forget about it ;)
81	tdb	1.8	disks.add(keyPrefix + diskNumber + ".attributes.used");
82	ajm	1.7
83			// device
84	tdb	1.8	disks.add(keyPrefix + diskNumber + ".attributes.name");
85			String device = packet.getParam(keyPrefix + diskNumber + ".attributes.name");
86	ajm	1.7	// mount point
87	tdb	1.8	disks.add(keyPrefix + diskNumber + ".attributes.mount");
88			String mount = packet.getParam(keyPrefix + diskNumber + ".attributes.mount");
89	ajm	1.7
90			// these next two will be used to calculate the %age
91			// total
92	tdb	1.8	disks.add(keyPrefix + diskNumber + ".attributes.kbytes");
93			String total = packet.getParam(keyPrefix + diskNumber + ".attributes.kbytes");
94	ajm	1.7	// available
95	tdb	1.8	disks.add(keyPrefix + diskNumber + ".attributes.avail");
96			String avail = packet.getParam(keyPrefix + diskNumber + ".attributes.avail");
97	ajm	1.7
98			// * now process this disk *
99
100			// check if we've seen this disk before on a previous run
101			// if not, we need to create a register for it
102	tdb	1.12	// nb. use the device as the key as this is unlikely to change,
103			// unlike diskNumber which could easily change
104			// (diskNumber is based on the order of df's output!)
105			if(!diskRegisters.containsKey(device)) {
106			diskRegisters.put(device, new Register(source, _name, mount));
107	ajm	1.7	}
108
109			// get the register for this disk
110	tdb	1.12	Register reg = (Register) diskRegisters.get(device);
111	ajm	1.7
112			// get the packet data
113			double diskTotal, diskAvail;
114			try {
115
116			if(total==null \|\| avail==null) {
117			throw new NumberFormatException("Disk data invalid");
118	ajm	1.2	}
119	ajm	1.7	diskTotal = Double.parseDouble(total);
120			diskAvail = Double.parseDouble(avail);
121			} catch (NumberFormatException e) {
122			_logger.write(this.toString(), Logger.WARNING, "Received packet from "+source+" with bad disk information: "+e);
123			// don't try to continue and process, try next disk
124			break;
125			}
126	ajm	1.2
127	ajm	1.7	boolean useValue = false;
128			try {
129	tdb	1.13	// try looking for a mount-point specific thresholdMeasure first
130			String option = _cp.getProperty("Host." + source, "Monitor." + _name + "." + mount + ".thresholdMeasure");
131	ajm	1.7	if (option.equals("VALUE")) {
132			useValue = true;
133	tdb	1.13	}
134	ajm	1.7	} catch (PropertyNotFoundException e) {
135	tdb	1.13	try {
136			// now look for a more general thresholdMeasure
137			String option = _cp.getProperty("Host." + source, "Monitor." + _name + ".thresholdMeasure");
138			if (option.equals("VALUE")) {
139			useValue = true;
140			}
141			} catch (PropertyNotFoundException f) {
142			// we default to percentage in any case
143			}
144	ajm	1.7	}
145	ajm	1.2
146	ajm	1.7	// this bit determines if the disk check is a % check
147			// or a kb check
148			String type;
149	tdb	1.10	double curValue;
150			int newThreshold;
151	ajm	1.7	if(useValue) {
152	tdb	1.10	// kb disk available
153			curValue = diskAvail;
154			// negate check
155			newThreshold = checkAttributeThreshold(curValue, reg, true);
156	ajm	1.7	type = "kb";
157			} else {
158			// % disk in use
159	tdb	1.10	curValue = (1 - (diskAvail / diskTotal)) * 100;
160			// normal check
161			newThreshold = checkAttributeThreshold(curValue, reg, false);
162	ajm	1.7	type = "%";
163	ajm	1.1	}
164	ajm	1.7
165			// format the diskInUse to a String
166			NumberFormat nf = NumberFormat.getInstance();
167			nf.setMaximumFractionDigits(2);
168			nf.setMinimumFractionDigits(2);
169	tdb	1.10	String strCurValue = nf.format(curValue);
170	ajm	1.7
171			// say which disk had the problem
172			String attributeName = "Disk in use " + type + " on " + mount + " (" + device + ")";
173
174	tdb	1.10	processAlert(newThreshold, attributeName, reg, source, strCurValue);
175	ajm	1.1	}
176			}
177			}
178			}
179
180			/**
181			* Overrides the {@link java.lang.Object#toString() Object.toString()}
182			* method to provide clean logging (every class should have this).
183			*
184	tdb	1.9	* This uses the uk.org.iscream.cms.server.util.NameFormat class
185	ajm	1.1	* to format the toString()
186			*
187			* @return the name of this class and its CVS revision
188			*/
189			public String toString() {
190			return FormatName.getName(
191			_name,
192			getClass().getName(),
193			REVISION);
194			}
195
196			/**
197			* return the String representation of what the monitor does
198			*/
199			public String getDescription(){
200			return DESC;
201			}
202
203			//---PRIVATE METHODS---
204	tdb	1.8
205			/**
206			* Checks a piece of current data, and returns the
207			* threshold it breaches, if any.
208			*
209	tdb	1.10	* The option to negate the check can be used in
210			* situations where being below the threshold
211			* is an 'alertable' situation. In this specific
212			* case, we'd do this with kb disk checks.
213			*
214			* @param value the current value
215	tdb	1.8	* @param reg the Register for the host
216	tdb	1.10	* @param negateCheck whether to negate the check
217	tdb	1.8	* @return the threshold level breached, if any
218			*/
219	tdb	1.14	private int checkAttributeThreshold(double value, Register reg, boolean negateCheck) {
220	ajm	1.1	for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
221			if (reg.getThreshold(thresholdLevel) != -1.0) {
222	tdb	1.10	if(!negateCheck) {
223			// normal check - has the value gone over the threshold
224	tdb	1.14	if(((double) reg.getThreshold(thresholdLevel)) < value) {
225	tdb	1.10	return thresholdLevel;
226			}
227			}
228			else {
229			// negated check - has the value gone under the threshold
230	tdb	1.14	if(((double) reg.getThreshold(thresholdLevel)) > value) {
231	tdb	1.10	return thresholdLevel;
232			}
233	ajm	1.1	}
234			}
235			}
236			return Alert.thresholdNORMAL;
237			}
238
239			//---ACCESSOR/MUTATOR METHODS---
240	ajm	1.7
241	tdb	1.8	/**
242			* Returns a reference to a specific Queue for this
243			* monitor. This Queue returns only the data packets
244			* (based on type) that we want too look at.
245			*
246			* @return a reference to a Queue
247			*/
248	ajm	1.7	protected Queue getQueue() {
249			return MonitorManager.getInstance().getDataQueue();
250			}
251
252	ajm	1.1	//---ATTRIBUTES---
253
254			/**
255			* This is the friendly identifier of the
256			* component this class is running in.
257			* eg, a Filter may be called "filter1",
258			* If this class does not have an owning
259			* component, a name from the configuration
260			* can be placed here. This name could also
261			* be changed to null for utility classes.
262			*/
263			private String _name = "Disk";
264
265			/**
266			* A reference to the configuration proxy in use
267			*/
268			private ConfigurationProxy _cp = ConfigurationProxy.getInstance();
269	tdb	1.8
270			/**
271			* A HashMap of Registers (or groups of Registers), one
272			* for each host we're monitoring.
273			*/
274	ajm	1.1	private HashMap _hosts = new HashMap();
275
276			//---STATIC ATTRIBUTES---
277
278			}