client/monitors/Disk__Monitor.java

/* 
 * i-scream central monitoring system
 * 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.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: tdb $
 * @version $Id: Disk__Monitor.java,v 1.15 2002/01/19 17:54:57 tdb Exp $
 */
public class Disk__Monitor extends MonitorSkeleton {

//---FINAL ATTRIBUTES---

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

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

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