client/monitors/UserCount__Monitor.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * 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.util.*;
import uk.org.iscream.cms.server.componentmanager.*;

/**
 * This Monitor watches the logged on user count for all machines
 *
 * @author  $Author: tdb $
 * @version $Id: UserCount__Monitor.java,v 1.7 2004/01/15 13:41:48 tdb Exp $
 */
public class UserCount__Monitor extends MonitorSkeleton {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.7 $";
    
    /**
     * A description of this monitor
     */
    public final String DESC = "Monitors number of logged on users.";
    
//---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) {
        // what host are we looking at
        String source = packet.getParam("packet.attributes.machine_name");
        if(!checkBooleanConfig("Host." + source, "Monitor." + _name + ".enable")) {
            return;
        }
        
        // if we don't have an entry in our HashMap, make one
        if (!_hosts.containsKey(source)) {
            _hosts.put(source, new Register(source, _name));
        }
        
        // get the Register for this host
        Register reg = (Register) _hosts.get(source);
        
        // get some required bits of data
        String currentCount = packet.getParam("packet.users.count");
        String niceName = "User Count";
        int newThreshold = checkAttributeThreshold(currentCount, reg);
        
        // process an alert
        processAlert(newThreshold, niceName, reg, source, currentCount);
    }

    /**
     * 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.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;
    }

//---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 = "UserCount";
    
    /**
     * A HashMap of Registers (or groups of Registers), one
     * for each host we're monitoring.
     */
    private HashMap _hosts = new HashMap();

//---STATIC ATTRIBUTES---

}
Revision:	1.8
Committed:	Thu Jan 15 14:10:13 2004 UTC (20 years, 4 months ago) by tdb
Branch:	MAIN
Changes since 1.7:	+3 -3 lines
Log Message:	OK - I can still program Java, I just can't remember how this works :-)
#	User	Rev	Content
1	tdb	1.4	/*
2			* i-scream central monitoring system
3	tdb	1.5	* http://www.i-scream.org.uk
4	tdb	1.4	* Copyright (C) 2000-2002 i-scream
5			*
6			* This program is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU General Public License
8			* as published by the Free Software Foundation; either version 2
9			* of the License, or (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19			*/
20
21	tdb	1.1	//---PACKAGE DECLARATION---
22	tdb	1.3	package uk.org.iscream.cms.server.client.monitors;
23	tdb	1.1
24			//---IMPORTS---
25			import java.util.HashMap;
26	tdb	1.3	import uk.org.iscream.cms.server.client.*;
27			import uk.org.iscream.cms.server.core.*;
28	tdb	1.6	import uk.org.iscream.cms.util.*;
29	tdb	1.3	import uk.org.iscream.cms.server.componentmanager.*;
30	tdb	1.1
31			/**
32			* This Monitor watches the logged on user count for all machines
33			*
34	tdb	1.4	* @author $Author: tdb $
35	tdb	1.8	* @version $Id: UserCount__Monitor.java,v 1.7 2004/01/15 13:41:48 tdb Exp $
36	tdb	1.1	*/
37			public class UserCount__Monitor extends MonitorSkeleton {
38
39			//---FINAL ATTRIBUTES---
40
41			/**
42			* The current CVS revision of this class
43			*/
44	tdb	1.8	public final String REVISION = "$Revision: 1.7 $";
45	tdb	1.1
46	tdb	1.2	/**
47			* A description of this monitor
48			*/
49	tdb	1.1	public final String DESC = "Monitors number of logged on users.";
50
51			//---STATIC METHODS---
52
53			//---CONSTRUCTORS---
54
55			//---PUBLIC METHODS---
56	tdb	1.2
57			/**
58			* Analyse a packet of data, and generate an alert if
59			* necessary.
60			*
61			* @param packet the XMLPacket to analyse
62			*/
63	tdb	1.1	public void analysePacket(XMLPacket packet) {
64			// what host are we looking at
65			String source = packet.getParam("packet.attributes.machine_name");
66	tdb	1.8	if(!checkBooleanConfig("Host." + source, "Monitor." + _name + ".enable")) {
67	tdb	1.7	return;
68			}
69	tdb	1.1
70			// if we don't have an entry in our HashMap, make one
71			if (!_hosts.containsKey(source)) {
72			_hosts.put(source, new Register(source, _name));
73			}
74
75			// get the Register for this host
76			Register reg = (Register) _hosts.get(source);
77
78			// get some required bits of data
79			String currentCount = packet.getParam("packet.users.count");
80			String niceName = "User Count";
81			int newThreshold = checkAttributeThreshold(currentCount, reg);
82
83			// process an alert
84			processAlert(newThreshold, niceName, reg, source, currentCount);
85			}
86
87			/**
88			* Overrides the {@link java.lang.Object#toString() Object.toString()}
89			* method to provide clean logging (every class should have this).
90			*
91	tdb	1.6	* This uses the uk.org.iscream.cms.util.NameFormat class
92	tdb	1.1	* to format the toString()
93			*
94			* @return the name of this class and its CVS revision
95			*/
96			public String toString() {
97			return FormatName.getName(
98			_name,
99			getClass().getName(),
100			REVISION);
101			}
102
103			/**
104			* return the String representation of what the monitor does
105			*/
106			public String getDescription(){
107			return DESC;
108			}
109
110			//---PRIVATE METHODS---
111	tdb	1.2
112			/**
113			* Checks a piece of current data, and returns the
114			* threshold it breaches, if any.
115			*
116			* @param attributeString a String representing the current data value
117			* @param reg the Register for the host
118			* @return the threshold level breached, if any
119			*/
120	tdb	1.1	private int checkAttributeThreshold(String attributeString, Register reg) {
121			for(int thresholdLevel = Alert.thresholdLevels.length - 1; thresholdLevel >= 0; thresholdLevel--) {
122			if (reg.getThreshold(thresholdLevel) != -1.0) {
123			if(attributeString != null) {
124			try {
125			double attribute = Double.parseDouble(attributeString);
126			if (reg.getThreshold(thresholdLevel) < attribute) return thresholdLevel;
127			} catch (NumberFormatException e) {
128			// we got some duff data in the packet, but we shouldn't have
129			_logger.write(toString(), Logger.DEBUG, "possible errenous packet data, should be double value - " + attributeString);
130			}
131			}
132			}
133			}
134			return Alert.thresholdNORMAL;
135			}
136
137			//---ACCESSOR/MUTATOR METHODS---
138	tdb	1.2
139			/**
140			* Returns a reference to a specific Queue for this
141			* monitor. This Queue returns only the data packets
142			* (based on type) that we want too look at.
143			*
144			* @return a reference to a Queue
145			*/
146	tdb	1.1	protected Queue getQueue() {
147			return MonitorManager.getInstance().getDataQueue();
148			}
149
150			//---ATTRIBUTES---
151
152			/**
153			* This is the friendly identifier of the
154			* component this class is running in.
155			* eg, a Filter may be called "filter1",
156			* If this class does not have an owning
157			* component, a name from the configuration
158			* can be placed here. This name could also
159			* be changed to null for utility classes.
160			*/
161			private String _name = "UserCount";
162	tdb	1.2
163			/**
164			* A HashMap of Registers (or groups of Registers), one
165			* for each host we're monitoring.
166			*/
167	tdb	1.1	private HashMap _hosts = new HashMap();
168
169			//---STATIC ATTRIBUTES---
170
171			}