client/monitors/Queue__Monitor.java

//---PACKAGE DECLARATION---
package uk.org.iscream.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.client.*;
import uk.org.iscream.core.*;
import uk.org.iscream.util.*;
import uk.org.iscream.componentmanager.*;

/**
 * This Monitor watches the internal server queues.
 * YES! this system is SO great it monitors itself!
 *
 * @author  $Author: tdb1 $
 * @version $Id: Queue__Monitor.java,v 1.9 2001/03/23 04:46:52 tdb1 Exp $
 */
public class Queue__Monitor extends MonitorSkeleton {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.9 $";
    
    /**
     * A description of this monitor
     */
    public final String DESC = "Who watches the watchmen?";
    
    private final String SOURCE = "i-scream-server";
    
//---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) {
        if (packet.getParam("packet.attributes.type").equals("queueStat")) {
            String source = packet.getParam("packet.attributes.hashCode");
            if (!_hosts.containsKey(source)) {
                _hosts.put(source, new HashMap());
            }
                        
            HashMap queueRegisters = (HashMap) _hosts.get(source);
            
            // get info about the source queue class instance
            String queueName = packet.getParam("packet.attributes.name");
            String maxQueueSize = packet.getParam("packet.queue.attributes.maxSize");
            // unfortunatly we need to check the whole packet
            // to find the queues, 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("packet.queue.attributes.queue")) {
                    String queueSize = packet.getParam(dataKey);

                    // *** now process this queue ***

                    // check if we've seen this queue before on a previous run
                    // if not, we need to create a register for it
                    if(!queueRegisters.containsKey(dataKey)) {
                        queueRegisters.put(dataKey, new Register(_name, _name));
                    }

                    // get the register for this disk
                    Register reg = (Register) queueRegisters.get(dataKey);

                    // get the packet data
                    double qMax, qSize;
                    try {
            
                        if(maxQueueSize==null || queueSize==null) {
                            throw new NumberFormatException("Queue data invalid");
                        }
                        qMax = Double.parseDouble(maxQueueSize);
                        qSize = Double.parseDouble(queueSize);
                    } catch (NumberFormatException e) {
                        _logger.write(this.toString(), Logger.WARNING, "Received packet from "+source+" with bad queue information: "+e);
                        // don't try to continue and process, try next queue
                        break;
                    }
                    
                    boolean useValue = false;
                    try {
                        String option = _cp.getProperty(_name, "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 checkValue;
                    String type;
                    if(useValue) {
                        // queue count
                        checkValue = qSize;
                        type = "count";
                    } else {
                        // % of queue
                        checkValue = (qSize / qMax) * 100;
                        type = "%";
                    }
                    
                    int newThreshold = checkAttributeThreshold(checkValue, reg);
        
                    // format the checkValue to a String
                    NumberFormat nf = NumberFormat.getInstance();
                    nf.setMaximumFractionDigits(2);
                    nf.setMinimumFractionDigits(2);
                    String strCheckValue = nf.format(checkValue);

                    // say which disk had the problem
                    String attributeName = "Size of queue " + type + " in " + queueName + " " + dataKey.substring(dataKey.lastIndexOf('.'));
                                            
                    processAlert(newThreshold, attributeName, reg, SOURCE, strCheckValue);
                   
                }
            }
        }
    }

    /**
     * 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.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 qSize the size of a queue
     * @param reg the Register for the host
     * @return the threshold level breached, if any
     */
    private int checkAttributeThreshold(double qSize, Register reg) {
        for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
            if (reg.getThreshold(thresholdLevel) != -1.0) {
                if(((double) reg.getThreshold(thresholdLevel)) < qSize) {
                    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().getOtherQueue();
    }


//---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 = "Queue";
    
    /**
     * 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.10
Committed:	Fri Mar 23 05:21:22 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.9:	+3 -3 lines
Log Message:	Bah... Register does config lookups too.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.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.client.*;
11	import uk.org.iscream.core.*;
12	import uk.org.iscream.util.*;
13	import uk.org.iscream.componentmanager.*;
14
15	/**
16	* This Monitor watches the internal server queues.
17	* YES! this system is SO great it monitors itself!
18	*
19	* @author $Author: tdb1 $
20	* @version $Id: Queue__Monitor.java,v 1.9 2001/03/23 04:46:52 tdb1 Exp $
21	*/
22	public class Queue__Monitor extends MonitorSkeleton {
23
24	//---FINAL ATTRIBUTES---
25
26	/**
27	* The current CVS revision of this class
28	*/
29	public final String REVISION = "$Revision: 1.9 $";
30
31	/**
32	* A description of this monitor
33	*/
34	public final String DESC = "Who watches the watchmen?";
35
36	private final String SOURCE = "i-scream-server";
37
38	//---STATIC METHODS---
39
40	//---CONSTRUCTORS---
41
42	//---PUBLIC METHODS---
43
44	/**
45	* Analyse a packet of data, and generate an alert if
46	* necessary.
47	*
48	* @param packet the XMLPacket to analyse
49	*/
50	public void analysePacket(XMLPacket packet) {
51	if (packet.getParam("packet.attributes.type").equals("queueStat")) {
52	String source = packet.getParam("packet.attributes.hashCode");
53	if (!_hosts.containsKey(source)) {
54	_hosts.put(source, new HashMap());
55	}
56
57	HashMap queueRegisters = (HashMap) _hosts.get(source);
58
59	// get info about the source queue class instance
60	String queueName = packet.getParam("packet.attributes.name");
61	String maxQueueSize = packet.getParam("packet.queue.attributes.maxSize");
62	// unfortunatly we need to check the whole packet
63	// to find the queues, and then get the data attributes
64	Set packetSet = packet.getSet();
65	Iterator i = packetSet.iterator();
66
67	while (i.hasNext()) {
68	String dataKey = (String) i.next();
69	if(dataKey.startsWith("packet.queue.attributes.queue")) {
70	String queueSize = packet.getParam(dataKey);
71
72	// * now process this queue *
73
74	// check if we've seen this queue before on a previous run
75	// if not, we need to create a register for it
76	if(!queueRegisters.containsKey(dataKey)) {
77	queueRegisters.put(dataKey, new Register(_name, _name));
78	}
79
80	// get the register for this disk
81	Register reg = (Register) queueRegisters.get(dataKey);
82
83	// get the packet data
84	double qMax, qSize;
85	try {
86
87	if(maxQueueSize==null \|\| queueSize==null) {
88	throw new NumberFormatException("Queue data invalid");
89	}
90	qMax = Double.parseDouble(maxQueueSize);
91	qSize = Double.parseDouble(queueSize);
92	} catch (NumberFormatException e) {
93	_logger.write(this.toString(), Logger.WARNING, "Received packet from "+source+" with bad queue information: "+e);
94	// don't try to continue and process, try next queue
95	break;
96	}
97
98	boolean useValue = false;
99	try {
100	String option = _cp.getProperty(_name, "Monitor." + _name + ".thresholdMeasure");
101	if (option.equals("VALUE")) {
102	useValue = true;
103	}
104	} catch (PropertyNotFoundException e) {
105	// we default to percentage
106	}
107
108	// this bit determines if the disk check is a % check
109	// or a kb check
110	double checkValue;
111	String type;
112	if(useValue) {
113	// queue count
114	checkValue = qSize;
115	type = "count";
116	} else {
117	// % of queue
118	checkValue = (qSize / qMax) * 100;
119	type = "%";
120	}
121
122	int newThreshold = checkAttributeThreshold(checkValue, reg);
123
124	// format the checkValue to a String
125	NumberFormat nf = NumberFormat.getInstance();
126	nf.setMaximumFractionDigits(2);
127	nf.setMinimumFractionDigits(2);
128	String strCheckValue = nf.format(checkValue);
129
130	// say which disk had the problem
131	String attributeName = "Size of queue " + type + " in " + queueName + " " + dataKey.substring(dataKey.lastIndexOf('.'));
132
133	processAlert(newThreshold, attributeName, reg, SOURCE, strCheckValue);
134
135	}
136	}
137	}
138	}
139
140	/**
141	* Overrides the {@link java.lang.Object#toString() Object.toString()}
142	* method to provide clean logging (every class should have this).
143	*
144	* This uses the uk.org.iscream.util.NameFormat class
145	* to format the toString()
146	*
147	* @return the name of this class and its CVS revision
148	*/
149	public String toString() {
150	return FormatName.getName(
151	_name,
152	getClass().getName(),
153	REVISION);
154	}
155
156	/**
157	* return the String representation of what the monitor does
158	*/
159	public String getDescription(){
160	return DESC;
161	}
162
163	//---PRIVATE METHODS---
164
165	/**
166	* Checks a piece of current data, and returns the
167	* threshold it breaches, if any.
168	*
169	* @param qSize the size of a queue
170	* @param reg the Register for the host
171	* @return the threshold level breached, if any
172	*/
173	private int checkAttributeThreshold(double qSize, Register reg) {
174	for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
175	if (reg.getThreshold(thresholdLevel) != -1.0) {
176	if(((double) reg.getThreshold(thresholdLevel)) < qSize) {
177	return thresholdLevel;
178	}
179	}
180	}
181	return Alert.thresholdNORMAL;
182	}
183
184	//---ACCESSOR/MUTATOR METHODS---
185
186	/**
187	* Returns a reference to a specific Queue for this
188	* monitor. This Queue returns only the data packets
189	* (based on type) that we want too look at.
190	*
191	* @return a reference to a Queue
192	*/
193	protected Queue getQueue() {
194	return MonitorManager.getInstance().getOtherQueue();
195	}
196
197
198	//---ATTRIBUTES---
199
200	/**
201	* This is the friendly identifier of the
202	* component this class is running in.
203	* eg, a Filter may be called "filter1",
204	* If this class does not have an owning
205	* component, a name from the configuration
206	* can be placed here. This name could also
207	* be changed to null for utility classes.
208	*/
209	private String _name = "Queue";
210
211	/**
212	* A reference to the configuration proxy in use
213	*/
214	private ConfigurationProxy _cp = ConfigurationProxy.getInstance();
215
216	/**
217	* A HashMap of Registers (or groups of Registers), one
218	* for each host we're monitoring.
219	*/
220	private HashMap _hosts = new HashMap();
221
222	//---STATIC ATTRIBUTES---
223
224	}