client/monitors/Process__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 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 Process Counts for all machines
 *
 * @author  $Author: tdb $
 * @version $Id: Process__Monitor.java,v 1.4 2001/05/29 17:02:34 tdb Exp $
 */
public class Process__Monitor extends MonitorSkeleton {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.4 $";
    
    /**
     * A description of this monitor
     */
    public final String DESC = "Monitors Process Counts.";
    
//---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)) {
            HashMap attributeRegisters = new HashMap();
            initAttributeRegsiters(source, attributeRegisters);
            _hosts.put(source, attributeRegisters);
        }

        HashMap attributeRegisters = (HashMap) _hosts.get(source);
        for(int attributeNum = 0; attributeNum < _attributes.length; attributeNum++) {
            Register reg = (Register) attributeRegisters.get(_attributes[attributeNum]);
            // find out the threshold level we're at
            String attribute = _attributes[attributeNum];
            String attributeName = _attributeNames[attributeNum];
            String currentValue = packet.getParam(attribute);
            int newThreshold = checkAttributeThreshold(currentValue, reg);
            processAlert(newThreshold, attributeName, reg, source, currentValue);
        }
    }

    /**
     * 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 attributeString a String representing the current data value
     * @param reg the Register for the host
     * @return the threshold level breached, if any
     */
    private int checkAttributeThreshold(String attributeString, Register reg) {
        for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
            if (reg.getThreshold(thresholdLevel) != -1.0) {
                if(attributeString != null) {
                    try {
                        double attribute = Double.parseDouble(attributeString);
                        if (reg.getThreshold(thresholdLevel) < attribute) return thresholdLevel;
                    } catch (NumberFormatException e) {
                        // we got some duff data in the packet, but we shouldn't have
                        _logger.write(toString(), Logger.DEBUG, "possible errenous packet data, should be double value - " + attributeString);
                    }
                }
            }
        }
        return Alert.thresholdNORMAL;
    }
    
    /**
     * Initialises a HashMap of Registers with the current list
     * of attributes. This is only used if we are looking at more
     * than one distinct attribute.
     *
     * @param source the host we are looking at
     * @param attributeRegisters a HashMap to put the new Registers in
     */
    private void initAttributeRegsiters(String source, HashMap attributeRegisters) {
        for(int attributeNum = 0; attributeNum < _attributes.length; attributeNum++) {
            String attributeName = _attributes[attributeNum].substring(_attributes[attributeNum].lastIndexOf(".") + 1);
            attributeRegisters.put(_attributes[attributeNum], new Register(source, _name, attributeName));
        }
    }

//---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 = "Process";
    
    /**
     * A HashMap of Registers (or groups of Registers), one
     * for each host we're monitoring.
     */
    private HashMap _hosts = new HashMap();
    
    /**
     * An array of attributes which we will be checking.
     */
    private String[] _attributes = { "packet.processes.total", "packet.processes.cpu", "packet.processes.sleeping", "packet.processes.stopped", "packet.processes.zombie" };
    
    /**
     * An array of "nice names" for the attributes in _attributes.
     */
    private String[] _attributeNames = {"Total Processes", "on CPU Processes", "Sleeping Processes", "Stopped Processes", "Zombie Processes"};

//---STATIC ATTRIBUTES---

}
Revision:	1.5
Committed:	Sat May 18 18:16:00 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.4:	+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.5	/*
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	tdb	1.1	//---PACKAGE DECLARATION---
21	tdb	1.4	package uk.org.iscream.cms.server.client.monitors;
22	tdb	1.1
23			//---IMPORTS---
24			import java.util.HashMap;
25	tdb	1.4	import uk.org.iscream.cms.server.client.*;
26			import uk.org.iscream.cms.server.core.*;
27			import uk.org.iscream.cms.server.util.*;
28			import uk.org.iscream.cms.server.componentmanager.*;
29	tdb	1.1
30			/**
31			* This Monitor watches the Process Counts for all machines
32			*
33	tdb	1.5	* @author $Author: tdb $
34			* @version $Id: Process__Monitor.java,v 1.4 2001/05/29 17:02:34 tdb Exp $
35	tdb	1.1	*/
36			public class Process__Monitor extends MonitorSkeleton {
37
38			//---FINAL ATTRIBUTES---
39
40			/**
41			* The current CVS revision of this class
42			*/
43	tdb	1.5	public final String REVISION = "$Revision: 1.4 $";
44	tdb	1.1
45	tdb	1.3	/**
46			* A description of this monitor
47			*/
48	tdb	1.1	public final String DESC = "Monitors Process Counts.";
49
50			//---STATIC METHODS---
51
52			//---CONSTRUCTORS---
53
54			//---PUBLIC METHODS---
55	tdb	1.3
56			/**
57			* Analyse a packet of data, and generate an alert if
58			* necessary.
59			*
60			* @param packet the XMLPacket to analyse
61			*/
62	tdb	1.1	public void analysePacket(XMLPacket packet) {
63
64	ajm	1.2	String source = packet.getParam("packet.attributes.machine_name");
65			if (!_hosts.containsKey(source)) {
66			HashMap attributeRegisters = new HashMap();
67			initAttributeRegsiters(source, attributeRegisters);
68			_hosts.put(source, attributeRegisters);
69			}
70
71			HashMap attributeRegisters = (HashMap) _hosts.get(source);
72			for(int attributeNum = 0; attributeNum < _attributes.length; attributeNum++) {
73			Register reg = (Register) attributeRegisters.get(_attributes[attributeNum]);
74			// find out the threshold level we're at
75			String attribute = _attributes[attributeNum];
76			String attributeName = _attributeNames[attributeNum];
77			String currentValue = packet.getParam(attribute);
78			int newThreshold = checkAttributeThreshold(currentValue, reg);
79			processAlert(newThreshold, attributeName, reg, source, currentValue);
80	tdb	1.1	}
81			}
82
83			/**
84			* Overrides the {@link java.lang.Object#toString() Object.toString()}
85			* method to provide clean logging (every class should have this).
86			*
87	tdb	1.4	* This uses the uk.org.iscream.cms.server.util.NameFormat class
88	tdb	1.1	* to format the toString()
89			*
90			* @return the name of this class and its CVS revision
91			*/
92			public String toString() {
93			return FormatName.getName(
94			_name,
95			getClass().getName(),
96			REVISION);
97			}
98
99			/**
100			* return the String representation of what the monitor does
101			*/
102			public String getDescription(){
103			return DESC;
104			}
105
106			//---PRIVATE METHODS---
107	tdb	1.3
108			/**
109			* Checks a piece of current data, and returns the
110			* threshold it breaches, if any.
111			*
112			* @param attributeString a String representing the current data value
113			* @param reg the Register for the host
114			* @return the threshold level breached, if any
115			*/
116	tdb	1.1	private int checkAttributeThreshold(String attributeString, Register reg) {
117			for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
118			if (reg.getThreshold(thresholdLevel) != -1.0) {
119			if(attributeString != null) {
120			try {
121			double attribute = Double.parseDouble(attributeString);
122			if (reg.getThreshold(thresholdLevel) < attribute) return thresholdLevel;
123			} catch (NumberFormatException e) {
124			// we got some duff data in the packet, but we shouldn't have
125			_logger.write(toString(), Logger.DEBUG, "possible errenous packet data, should be double value - " + attributeString);
126			}
127			}
128			}
129			}
130			return Alert.thresholdNORMAL;
131			}
132	tdb	1.3
133			/**
134			* Initialises a HashMap of Registers with the current list
135			* of attributes. This is only used if we are looking at more
136			* than one distinct attribute.
137			*
138			* @param source the host we are looking at
139			* @param attributeRegisters a HashMap to put the new Registers in
140			*/
141	tdb	1.1	private void initAttributeRegsiters(String source, HashMap attributeRegisters) {
142			for(int attributeNum = 0; attributeNum < _attributes.length; attributeNum++) {
143			String attributeName = _attributes[attributeNum].substring(_attributes[attributeNum].lastIndexOf(".") + 1);
144			attributeRegisters.put(_attributes[attributeNum], new Register(source, _name, attributeName));
145			}
146			}
147
148			//---ACCESSOR/MUTATOR METHODS---
149	tdb	1.3
150			/**
151			* Returns a reference to a specific Queue for this
152			* monitor. This Queue returns only the data packets
153			* (based on type) that we want too look at.
154			*
155			* @return a reference to a Queue
156			*/
157	ajm	1.2	protected Queue getQueue() {
158			return MonitorManager.getInstance().getDataQueue();
159			}
160	tdb	1.1
161			//---ATTRIBUTES---
162
163			/**
164			* This is the friendly identifier of the
165			* component this class is running in.
166			* eg, a Filter may be called "filter1",
167			* If this class does not have an owning
168			* component, a name from the configuration
169			* can be placed here. This name could also
170			* be changed to null for utility classes.
171			*/
172			private String _name = "Process";
173
174			/**
175	tdb	1.3	* A HashMap of Registers (or groups of Registers), one
176			* for each host we're monitoring.
177	tdb	1.1	*/
178			private HashMap _hosts = new HashMap();
179	tdb	1.3
180			/**
181			* An array of attributes which we will be checking.
182			*/
183	tdb	1.1	private String[] _attributes = { "packet.processes.total", "packet.processes.cpu", "packet.processes.sleeping", "packet.processes.stopped", "packet.processes.zombie" };
184	tdb	1.3
185			/**
186			* An array of "nice names" for the attributes in _attributes.
187			*/
188	tdb	1.1	private String[] _attributeNames = {"Total Processes", "on CPU Processes", "Sleeping Processes", "Stopped Processes", "Zombie Processes"};
189
190			//---STATIC ATTRIBUTES---
191
192			}