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.8 2001/03/23 02:32:49 tdb1 Exp $
 */
public class Disk__Monitor extends MonitorSkeleton {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.8 $";
    
    /**
     * 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 tempory 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
                    if(!diskRegisters.containsKey(diskNumber)) {
                        diskRegisters.put(diskNumber, new Register(source, _name, mount));
                    }

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

                    // 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 {
                        String option = _cp.getProperty("Host." + source, "Monitor." + _name + ".thresholdMeasure");
                        if (option.equals("VALUE")) {
                            useValue = true;
                        }                            
                    } catch (PropertyNotFoundException e) {
                        // we default to percentage
                    }

                    // this  bit determines if the disk check is a % check
                    // or a kb check
                    double diskInUse;
                    String type;
                    if(useValue) {
                        // kb disk in use
                        diskInUse = diskTotal - diskAvail;
                        type = "kb";
                    } else {
                        // % disk in use
                        diskInUse = (1 - (diskAvail / diskTotal)) * 100;
                        type = "%";
                    }


                    int newThreshold = checkAttributeThreshold(diskInUse, reg);

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

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

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

    /**
     * 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.
     *
     * @param diskInUse the amount of space in use
     * @param reg the Register for the host
     * @return the threshold level breached, if any
     */
    private int checkAttributeThreshold(double diskInUse, Register reg) {
        for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
            if (reg.getThreshold(thresholdLevel) != -1.0) {
                if(((double) reg.getThreshold(thresholdLevel)) < diskInUse) {
                    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.9
Committed:	Tue May 29 17:02:34 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Changes since 1.8:	+9 -9 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.cms.server.client.monitors;
3
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	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
15	/**
16	* This Monitor watches the Disks for all machines
17	*
18	* @author $Author: tdb1 $
19	* @version $Id: Disk__Monitor.java,v 1.8 2001/03/23 02:32:49 tdb1 Exp $
20	*/
21	public class Disk__Monitor extends MonitorSkeleton {
22
23	//---FINAL ATTRIBUTES---
24
25	/**
26	* The current CVS revision of this class
27	*/
28	public final String REVISION = "$Revision: 1.8 $";
29
30	/**
31	* A description of this monitor
32	*/
33	public final String DESC = "Monitors all host disks.";
34
35	//---STATIC METHODS---
36
37	//---CONSTRUCTORS---
38
39	//---PUBLIC METHODS---
40
41	/**
42	* Analyse a packet of data, and generate an alert if
43	* necessary.
44	*
45	* @param packet the XMLPacket to analyse
46	*/
47	public void analysePacket(XMLPacket packet) {
48	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
55	// key prefix
56	String keyPrefix = "packet.disk.p";
57
58	// a tempory holder for all the disk attributes we find
59	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	if(dataKey.startsWith(keyPrefix)) {
68	if(!disks.contains(dataKey)) {
69	String diskNumber = "";
70
71	// pos is after "packet.disk.p"
72	int pos = keyPrefix.length();
73	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	disks.add(keyPrefix + diskNumber + ".attributes.used");
82
83	// device
84	disks.add(keyPrefix + diskNumber + ".attributes.name");
85	String device = packet.getParam(keyPrefix + diskNumber + ".attributes.name");
86	// mount point
87	disks.add(keyPrefix + diskNumber + ".attributes.mount");
88	String mount = packet.getParam(keyPrefix + diskNumber + ".attributes.mount");
89
90	// these next two will be used to calculate the %age
91	// total
92	disks.add(keyPrefix + diskNumber + ".attributes.kbytes");
93	String total = packet.getParam(keyPrefix + diskNumber + ".attributes.kbytes");
94	// available
95	disks.add(keyPrefix + diskNumber + ".attributes.avail");
96	String avail = packet.getParam(keyPrefix + diskNumber + ".attributes.avail");
97
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	if(!diskRegisters.containsKey(diskNumber)) {
103	diskRegisters.put(diskNumber, new Register(source, _name, mount));
104	}
105
106	// get the register for this disk
107	Register reg = (Register) diskRegisters.get(diskNumber);
108
109	// get the packet data
110	double diskTotal, diskAvail;
111	try {
112
113	if(total==null \|\| avail==null) {
114	throw new NumberFormatException("Disk data invalid");
115	}
116	diskTotal = Double.parseDouble(total);
117	diskAvail = Double.parseDouble(avail);
118	} catch (NumberFormatException e) {
119	_logger.write(this.toString(), Logger.WARNING, "Received packet from "+source+" with bad disk information: "+e);
120	// don't try to continue and process, try next disk
121	break;
122	}
123
124	boolean useValue = false;
125	try {
126	String option = _cp.getProperty("Host." + source, "Monitor." + _name + ".thresholdMeasure");
127	if (option.equals("VALUE")) {
128	useValue = true;
129	}
130	} catch (PropertyNotFoundException e) {
131	// we default to percentage
132	}
133
134	// this bit determines if the disk check is a % check
135	// or a kb check
136	double diskInUse;
137	String type;
138	if(useValue) {
139	// kb disk in use
140	diskInUse = diskTotal - diskAvail;
141	type = "kb";
142	} else {
143	// % disk in use
144	diskInUse = (1 - (diskAvail / diskTotal)) * 100;
145	type = "%";
146	}
147
148
149
150	int newThreshold = checkAttributeThreshold(diskInUse, reg);
151
152	// format the diskInUse to a String
153	NumberFormat nf = NumberFormat.getInstance();
154	nf.setMaximumFractionDigits(2);
155	nf.setMinimumFractionDigits(2);
156	String strDiskInUse = nf.format(diskInUse);
157
158	// say which disk had the problem
159	String attributeName = "Disk in use " + type + " on " + mount + " (" + device + ")";
160
161	processAlert(newThreshold, attributeName, reg, source, strDiskInUse);
162	}
163	}
164	}
165	}
166
167	/**
168	* Overrides the {@link java.lang.Object#toString() Object.toString()}
169	* method to provide clean logging (every class should have this).
170	*
171	* This uses the uk.org.iscream.cms.server.util.NameFormat class
172	* to format the toString()
173	*
174	* @return the name of this class and its CVS revision
175	*/
176	public String toString() {
177	return FormatName.getName(
178	_name,
179	getClass().getName(),
180	REVISION);
181	}
182
183	/**
184	* return the String representation of what the monitor does
185	*/
186	public String getDescription(){
187	return DESC;
188	}
189
190	//---PRIVATE METHODS---
191
192	/**
193	* Checks a piece of current data, and returns the
194	* threshold it breaches, if any.
195	*
196	* @param diskInUse the amount of space in use
197	* @param reg the Register for the host
198	* @return the threshold level breached, if any
199	*/
200	private int checkAttributeThreshold(double diskInUse, Register reg) {
201	for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
202	if (reg.getThreshold(thresholdLevel) != -1.0) {
203	if(((double) reg.getThreshold(thresholdLevel)) < diskInUse) {
204	return thresholdLevel;
205	}
206	}
207	}
208	return Alert.thresholdNORMAL;
209	}
210
211	//---ACCESSOR/MUTATOR METHODS---
212
213	/**
214	* Returns a reference to a specific Queue for this
215	* monitor. This Queue returns only the data packets
216	* (based on type) that we want too look at.
217	*
218	* @return a reference to a Queue
219	*/
220	protected Queue getQueue() {
221	return MonitorManager.getInstance().getDataQueue();
222	}
223
224	//---ATTRIBUTES---
225
226	/**
227	* This is the friendly identifier of the
228	* component this class is running in.
229	* eg, a Filter may be called "filter1",
230	* If this class does not have an owning
231	* component, a name from the configuration
232	* can be placed here. This name could also
233	* be changed to null for utility classes.
234	*/
235	private String _name = "Disk";
236
237	/**
238	* A reference to the configuration proxy in use
239	*/
240	private ConfigurationProxy _cp = ConfigurationProxy.getInstance();
241
242	/**
243	* A HashMap of Registers (or groups of Registers), one
244	* for each host we're monitoring.
245	*/
246	private HashMap _hosts = new HashMap();
247
248	//---STATIC ATTRIBUTES---
249
250	}