Gojara

- display Warnings in overview pages if not a gateway is not configured for admin usage
- show gathered stat information in table on new page gatewayStatistics, (Server -> Server Manager -> Spectrum2 Stats)
- helper for better presentation of gathered data in AdminManager (KB to MB, sec to S/M/H/D)
- also display number of registrations to see online/registered ratio
pretty much finished now, just some minor changes before release needed

git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/trunk@13702 b35dd754-fafc-0310-a699-88a17e54d16e

src/plugins/gojara/plugin.xml

@@ -24,6 +24,12 @@
 					description="${rr.summary.title}" />
 			</sidebar>
 		</tab>
+		<tab id="tab-server">
+			<sidebar id="sidebar-server-manager">
+				<item id="gojaraGatewayStatistics" name="Spectrum2 Stats"
+					url="gojara-gatewayStatistics.jsp" description="Click to see Stats of Spectrum2 Components"></item>
+			</sidebar>
+		</tab>
 		<tab id="tab-session">
 			<sidebar id="sidebar-session">
 				<item id="gojaraSessions" name="Gateway Sessions" url="gojara-activeSessions.jsp"

src/plugins/gojara/src/java/org/jivesoftware/openfire/plugin/gojara/database/DatabaseManager.java

@@ -40,6 +40,7 @@ public class DatabaseManager {
 	private static final String GET_SESSION_ENTRIES_FOR_USERNAME = "SELECT * FROM ofGojaraSessions WHERE username = ? ORDER BY lastActivity DESC";
 	private static final String DELETE_SESSION_ENTRY = "DELETE FROM ofGojaraSessions WHERE username = ? AND transport = ?";
 	private static final String GET_SESSION_COUNT = "SELECT count(*) FROM ofGojaraSessions";
+	private static final String GET_SESSION_COUNT_FOR_TRANSPORT = "SELECT count(*) FROM ofGojaraSessions WHERE transport = ?";
 
 	private DatabaseManager() {
 
@@ -409,4 +410,23 @@ public class DatabaseManager {
 		}
 		return result;
 	}
+	
+	public int getNumberOfRegistrationsForTransport(String transport) {
+		int result = 0;
+		Connection con = null;
+		PreparedStatement pstmt = null;
+		try {
+			con = DbConnectionManager.getConnection();
+			pstmt = con.prepareStatement(GET_SESSION_COUNT_FOR_TRANSPORT);
+			pstmt.setString(1, transport);
+			ResultSet rs = pstmt.executeQuery();
+			rs.next();
+			result = rs.getInt(1);
+		} catch (SQLException sqle) {
+			Log.error(sqle);
+		} finally {
+			DbConnectionManager.closeConnection(pstmt, con);
+		}
+		return result;
+	}
 }

src/plugins/gojara/src/java/org/jivesoftware/openfire/plugin/gojara/messagefilter/processors/GojaraAdminProcessor.java

@@ -38,12 +38,12 @@ public class GojaraAdminProcessor extends AbstractRemoteRosterProcessor {
 			handleStatistic(message, subdomain, "uptime");
 		} else if (command.equals("messages_from_xmpp")) {
 			handleStatistic(message, subdomain, "messages_from_xmpp");
-		} else if (command.equals("messags_to_xmpp")) {
+		} else if (command.equals("messages_to_xmpp")) {
 			handleStatistic(message, subdomain, "messages_to_xmpp");
 		} else if (command.equals("used_memory")) {
 			handleStatistic(message, subdomain, "used_memory");
-		} else if (command.equals("used_memory_per_user")) {
-			handleStatistic(message, subdomain, "used_memory_per_user");
+		} else if (command.equals("average_memory_per_user")) {
+			handleStatistic(message, subdomain, "average_memory_per_user");
 		}
 	}
 

src/plugins/gojara/src/java/org/jivesoftware/openfire/plugin/gojara/sessions/GojaraAdminManager.java

 package org.jivesoftware.openfire.plugin.gojara.sessions;
 
+import java.text.DecimalFormat;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
@@ -73,6 +74,8 @@ public class GojaraAdminManager {
 	 */
 	public void testAdminConfiguration(String gateway) {
 		unconfiguredGateways.add(gateway);
+		// we add these here and not in confirmGateway so its more clear that these are not being gathered when viewing
+		// Spectrum2 Stats jsp
 		getGatewayStatisticsMap().put(gateway, new HashMap<String, Integer>());
 
 		Message message = new Message();
@@ -183,6 +186,7 @@ public class GojaraAdminManager {
 
 		refreshCooldown = System.currentTimeMillis();
 
+		Log.info("Gathering Gateway-Statistics!");
 		for (String gateway : configuredGateways) {
 			uptime(gateway);
 			messagesFrom(gateway);
@@ -191,29 +195,68 @@ public class GojaraAdminManager {
 			averageMemoryOfUser(gateway);
 		}
 	}
+
 	private void uptime(String transport) {
 		Message message = generateCommand(transport, "uptime");
 		router.route(message);
 	}
-	
+
 	private void messagesFrom(String transport) {
 		Message message = generateCommand(transport, "messages_from_xmpp");
 		router.route(message);
 	}
-	
+
 	private void messagesTo(String transport) {
 		Message message = generateCommand(transport, "messages_to_xmpp");
 		router.route(message);
 	}
-	
+
 	private void usedMemoryOf(String transport) {
 		Message message = generateCommand(transport, "used_memory");
 		router.route(message);
 	}
-	
+
 	private void averageMemoryOfUser(String transport) {
 		Message message = generateCommand(transport, "average_memory_per_user");
 		router.route(message);
 	}
-
+	
+	/**
+	 * Preps the specified stat for nicer output which is used in tables.
+	 * @param gateway
+	 * @param stat
+	 * @return
+	 */
+	public String getStatisticsPresentationString(String gateway, String stat) {
+		if (gatewayStatisticsMap.containsKey(gateway)) {
+			if (stat.equals("uptime")) {
+				if (gatewayStatisticsMap.get(gateway).get("uptime") != null) {
+					int time = gatewayStatisticsMap.get(gateway).get("uptime");
+					long diffSeconds = time % 60;
+					long diffMinutes = time / 60 % 60;
+					long diffHours = time / (60 * 60) % 24;
+					long diffDays = time / (24 * 60 * 60);
+					return "" + diffSeconds+ " Sec " + diffMinutes + " Min " + diffHours + " Hours " + diffDays + " Days";
+				}
+			} else if (stat.equals("messages_from_xmpp")) {
+				if (gatewayStatisticsMap.get(gateway).get("messages_from_xmpp") != null)
+					return "" + gatewayStatisticsMap.get(gateway).get("messages_from_xmpp");
+			} else if (stat.equals("messages_to_xmpp")) {
+				if (gatewayStatisticsMap.get(gateway).get("messages_to_xmpp") != null)
+					return "" + gatewayStatisticsMap.get(gateway).get("messages_to_xmpp");
+			} else if (stat.equals("used_memory")) {
+				if (gatewayStatisticsMap.get(gateway).get("used_memory") != null) {
+					DecimalFormat f = new DecimalFormat("#0.00");
+					double mb = gatewayStatisticsMap.get(gateway).get("used_memory") / 1024.0;
+					
+					return ""  + f.format(mb) + " MB";
+				}
+			} else if (stat.equals("average_memory_per_user")) {
+				if (gatewayStatisticsMap.get(gateway).get("average_memory_per_user") != null) {
+					return "" + gatewayStatisticsMap.get(gateway).get("average_memory_per_user") + " KB";
+				}
+			}
+		}
+		return "-";
+	}
 }

src/plugins/gojara/src/java/org/jivesoftware/openfire/plugin/gojara/sessions/TransportSessionManager.java

@@ -200,6 +200,17 @@ public class TransportSessionManager {
 		}
 		return result;
 	}
+	
+	/**
+	 * Returns number of active Sessions for specified transport or 0 if not valid transport.
+	 * @param transport
+	 * @return
+	 */
+	public int getNumberOfActiveSessionsFor(String transport) {
+		if (transportSessions.containsKey(transport))
+			return transportSessions.get(transport).size();
+		return 0;
+	}
 
 	/**
 	 * Searches for Sessions with given Username and returns them as ArrList
@@ -242,4 +253,11 @@ public class TransportSessionManager {
 	public int getNumberOfRegistrations() {
 		return db.getNumberOfRegistrations();
 	}
+	
+	public int getNumberOfRegistrationsForTransport(String transport) {
+		if (transportSessions.containsKey(transport)) {
+			return db.getNumberOfRegistrationsForTransport(transport);
+		}
+		return 0;
+	}
 }

src/plugins/gojara/src/web/gojara-RegistrationsOverview.jsp

@@ -58,6 +58,10 @@
 
 
 	<center>
+	<% if (!gojaraAdminManager.areGatewaysConfigured()) {%>
+		<h2 style="color:red">Warning: Not all Gateways are configured for admin usage. This means unregistrations will not be properly executed.<br/>
+		 Please configure admin_jid = gojaraadmin@yourdomain in Spectrum2 transport configuration.</h2>
+	 <% } %>
 		<h5>Logintime 1970 means User did register but never logged in,
 			propably because of invalid credentials.</h5>
 	</center>

src/plugins/gojara/src/web/gojara-activeSessions.jsp

 <%@ page
 	import="org.jivesoftware.openfire.plugin.gojara.sessions.TransportSessionManager"%>
+<%@ page
+	import="org.jivesoftware.openfire.plugin.gojara.sessions.GojaraAdminManager"%>
+
 <%@ page
 	import="org.jivesoftware.openfire.plugin.gojara.sessions.GatewaySession"%>
 <%@ page
@@ -12,7 +15,7 @@
 
 <%
 	TransportSessionManager transportManager = TransportSessionManager.getInstance();
-
+	GojaraAdminManager gojaraAdminManager = GojaraAdminManager.getInstance();
 	//Helper object for generation of sorting links, column restriction is done in DatabaseManager
 	Map<String, String> sortParams = new HashMap<String, String>();
 	if (request.getParameter("sortby") != null && request.getParameter("sortorder") != null) {
@@ -33,6 +36,11 @@
 <meta name="pageID" content="gojaraSessions" />
 </head>
 <body>
+	<% if (!gojaraAdminManager.areGatewaysConfigured()) {%>
+		<center><h2 style="color:red">Warning: Not all Gateways are configured for admin usage. This means session details may be inaccurate or not logged at all.<br/>
+		 Please configure admin_jid = gojaraadmin@yourdomain in Spectrum2 transport configuration.</h2></center>
+	 <% } %>
+	 
 	<h4>
 		Current number of active Gateway Sessions: &emsp;
 		<%=transportManager.getNumberOfActiveSessions()%>

src/plugins/gojara/src/web/gojara-gatewayStatistics.jsp

+<%@page
+	import="org.jivesoftware.openfire.plugin.gojara.sessions.TransportSessionManager"%>
+<%@ page
+	import="org.jivesoftware.openfire.plugin.gojara.sessions.GojaraAdminManager"%>
+<%@ page import="java.util.Map"%>
+<%@ page import="java.util.Set"%>
+<%
+	TransportSessionManager transportSessionManager = TransportSessionManager.getInstance();
+	GojaraAdminManager gojaraAdminManager = GojaraAdminManager.getInstance();
+	gojaraAdminManager.gatherGatewayStatistics();
+%>
+<html>
+<head>
+<title>Spectrum2 gateway stats</title>
+<meta name="pageID" content="gojaraGatewayStatistics" />
+</head>
+<body>
+
+	<%
+		if (!gojaraAdminManager.areGatewaysConfigured()) {
+	%>
+	<center>
+		<h2 style="color: red">
+			Warning: Not all Gateways are configured for admin usage. Affected
+			gateways will not show any data.<br /> Please configure admin_jid =
+			gojaraadmin@yourdomain in Spectrum2 transport configuration.
+		</h2>
+	</center>
+	<hr />
+	<%
+		}
+	%>
+	<br/><br/>
+	<div class="jive-table">
+		<table cellpadding="0" cellspacing="0" border="0" width="100%">
+			<thead>
+				<tr>
+					<th nowrap>Name</th>
+					<th nowrap># Online Users</th>
+					<th nowrap># Registrations</th>
+					<th nowrap>Uptime</th>
+					<th nowrap># Messages received</th>
+					<th nowrap># Messages sent</th>
+					<th nowrap>Used Memory</th>
+					<th nowrap>Avg. Memory per User</th>
+				</tr>
+			</thead>
+			<tbody>
+				<%
+				Set<String> gateways = gojaraAdminManager.getGatewayStatisticsMap().keySet();
+				for (String gateway : gateways) {
+				%>	
+					<tr class="jive-odd">
+					<td><%=gateway %></td>
+					<td><%=transportSessionManager.getNumberOfActiveSessionsFor(gateway)%></td>
+					<td><%=transportSessionManager.getNumberOfRegistrationsForTransport(gateway)%></td>
+					<td><%=gojaraAdminManager.getStatisticsPresentationString(gateway, "uptime")%></td>
+					<td><%=gojaraAdminManager.getStatisticsPresentationString(gateway, "messages_from_xmpp")%></td>
+					<td><%=gojaraAdminManager.getStatisticsPresentationString(gateway, "messages_to_xmpp") %></td>
+					<td><%=gojaraAdminManager.getStatisticsPresentationString(gateway, "used_memory") %></td>
+					<td><%=gojaraAdminManager.getStatisticsPresentationString(gateway, "average_memory_per_user") %></td>
+					</tr>
+				<% } %>
+			</tbody>
+		</table>
+	</div>
+</body>
+</html>
\ No newline at end of file

src/plugins/gojara/src/web/gojara-sessionDetails.jsp

@@ -33,23 +33,29 @@
 </script>
 </head>
 <body>
+	<% if (!gojaraAdminManager.areGatewaysConfigured()) {%>
+		<center><h2 style="color:red">Warning: Not all Gateways are configured for admin usage. This means unregistrations will not be properly executed.<br/>
+		 Please configure admin_jid = gojaraadmin@yourdomain in Spectrum2 transport configuration.</h2></center>
+	 <% } %>
+	
 	<%
 		if (request.getParameter(username) != null) {
 			String[] unregister = request.getParameterValues(username);
 	%>
-	<br>
-	<br>
-	<%
-		for (String key : unregister) {
-	%>
-
-	<%=transportManager.removeRegistrationOfUser(key, username)%><br>
-	<%
-		}
-	%>
-	<br>
-	<br>
-	<%
+		<br>
+		<br>
+		<%
+			for (String key : unregister) {
+		%>
+	
+		<%=transportManager.removeRegistrationOfUser(key, username)%><br>
+		<%
+			}
+		%>
+		<br>
+		<br>
+	
+		<%
 		}
 		ArrayList<GatewaySession> userconnections = transportManager.getConnectionsFor(username);
 		if (userconnections == null) {