2 // ========================================================================
3 // Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
19 package org.eclipse.jetty.servlet;
21 import java.io.IOException;
22 import java.io.PrintWriter;
23 import java.lang.management.ManagementFactory;
24 import java.lang.management.MemoryMXBean;
25 import java.net.InetAddress;
26 import java.net.UnknownHostException;
28 import javax.servlet.ServletContext;
29 import javax.servlet.ServletException;
30 import javax.servlet.http.HttpServlet;
31 import javax.servlet.http.HttpServletRequest;
32 import javax.servlet.http.HttpServletResponse;
34 import org.eclipse.jetty.server.AbstractConnector;
35 import org.eclipse.jetty.server.Connector;
36 import org.eclipse.jetty.server.ConnectorStatistics;
37 import org.eclipse.jetty.server.Handler;
38 import org.eclipse.jetty.server.Server;
39 import org.eclipse.jetty.server.handler.ContextHandler;
40 import org.eclipse.jetty.server.handler.StatisticsHandler;
41 import org.eclipse.jetty.util.log.Log;
42 import org.eclipse.jetty.util.log.Logger;
49 public class StatisticsServlet extends HttpServlet
51 private static final Logger LOG = Log.getLogger(StatisticsServlet.class);
53 boolean _restrictToLocalhost = true; // defaults to true
54 private StatisticsHandler _statsHandler;
55 private MemoryMXBean _memoryBean;
56 private Connector[] _connectors;
61 * @see javax.servlet.GenericServlet#init()
63 public void init() throws ServletException
65 ServletContext context = getServletContext();
66 ContextHandler.Context scontext = (ContextHandler.Context) context;
67 Server _server = scontext.getContextHandler().getServer();
69 Handler handler = _server.getChildHandlerByClass(StatisticsHandler.class);
73 _statsHandler = (StatisticsHandler) handler;
77 LOG.warn("Statistics Handler not installed!");
81 _memoryBean = ManagementFactory.getMemoryMXBean();
82 _connectors = _server.getConnectors();
84 if (getInitParameter("restrictToLocalhost") != null)
86 _restrictToLocalhost = "true".equals(getInitParameter("restrictToLocalhost"));
93 * @see javax.servlet.http.HttpServlet#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
95 public void doPost(HttpServletRequest sreq, HttpServletResponse sres) throws ServletException, IOException
103 * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
105 protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
107 if (_statsHandler == null)
109 LOG.warn("Statistics Handler not installed!");
110 resp.sendError(HttpServletResponse.SC_SERVICE_UNAVAILABLE);
113 if (_restrictToLocalhost)
115 if (!isLoopbackAddress(req.getRemoteAddr()))
117 resp.sendError(HttpServletResponse.SC_SERVICE_UNAVAILABLE);
122 String wantXml = req.getParameter("xml");
124 wantXml = req.getParameter("XML");
126 if (wantXml != null && "true".equalsIgnoreCase(wantXml))
128 sendXmlResponse(resp);
132 sendTextResponse(resp);
137 private boolean isLoopbackAddress(String address)
141 InetAddress addr = InetAddress.getByName(address);
142 return addr.isLoopbackAddress();
144 catch (UnknownHostException e )
146 LOG.warn("Warning: attempt to access statistics servlet from " + address, e);
151 private void sendXmlResponse(HttpServletResponse response) throws IOException
153 StringBuilder sb = new StringBuilder();
155 sb.append("<statistics>\n");
157 sb.append(" <requests>\n");
158 sb.append(" <statsOnMs>").append(_statsHandler.getStatsOnMs()).append("</statsOnMs>\n");
160 sb.append(" <requests>").append(_statsHandler.getRequests()).append("</requests>\n");
161 sb.append(" <requestsActive>").append(_statsHandler.getRequestsActive()).append("</requestsActive>\n");
162 sb.append(" <requestsActiveMax>").append(_statsHandler.getRequestsActiveMax()).append("</requestsActiveMax>\n");
163 sb.append(" <requestsTimeTotal>").append(_statsHandler.getRequestTimeTotal()).append("</requestsTimeTotal>\n");
164 sb.append(" <requestsTimeMean>").append(_statsHandler.getRequestTimeMean()).append("</requestsTimeMean>\n");
165 sb.append(" <requestsTimeMax>").append(_statsHandler.getRequestTimeMax()).append("</requestsTimeMax>\n");
166 sb.append(" <requestsTimeStdDev>").append(_statsHandler.getRequestTimeStdDev()).append("</requestsTimeStdDev>\n");
168 sb.append(" <dispatched>").append(_statsHandler.getDispatched()).append("</dispatched>\n");
169 sb.append(" <dispatchedActive>").append(_statsHandler.getDispatchedActive()).append("</dispatchedActive>\n");
170 sb.append(" <dispatchedActiveMax>").append(_statsHandler.getDispatchedActiveMax()).append("</dispatchedActiveMax>\n");
171 sb.append(" <dispatchedTimeTotalMs>").append(_statsHandler.getDispatchedTimeTotal()).append("</dispatchedTimeTotalMs>\n");
172 sb.append(" <dispatchedTimeMeanMs>").append(_statsHandler.getDispatchedTimeMean()).append("</dispatchedTimeMeanMs>\n");
173 sb.append(" <dispatchedTimeMaxMs>").append(_statsHandler.getDispatchedTimeMax()).append("</dispatchedTimeMaxMs>\n");
174 sb.append(" <dispatchedTimeStdDevMs>").append(_statsHandler.getDispatchedTimeStdDev()).append("</dispatchedTimeStdDevMs>\n");
176 sb.append(" <asyncRequests>").append(_statsHandler.getAsyncRequests()).append("</asyncRequests>\n");
177 sb.append(" <requestsSuspended>").append(_statsHandler.getAsyncRequestsWaiting()).append("</requestsSuspended>\n");
178 sb.append(" <requestsSuspendedMax>").append(_statsHandler.getAsyncRequestsWaitingMax()).append("</requestsSuspendedMax>\n");
179 sb.append(" <requestsResumed>").append(_statsHandler.getAsyncDispatches()).append("</requestsResumed>\n");
180 sb.append(" <requestsExpired>").append(_statsHandler.getExpires()).append("</requestsExpired>\n");
181 sb.append(" </requests>\n");
183 sb.append(" <responses>\n");
184 sb.append(" <responses1xx>").append(_statsHandler.getResponses1xx()).append("</responses1xx>\n");
185 sb.append(" <responses2xx>").append(_statsHandler.getResponses2xx()).append("</responses2xx>\n");
186 sb.append(" <responses3xx>").append(_statsHandler.getResponses3xx()).append("</responses3xx>\n");
187 sb.append(" <responses4xx>").append(_statsHandler.getResponses4xx()).append("</responses4xx>\n");
188 sb.append(" <responses5xx>").append(_statsHandler.getResponses5xx()).append("</responses5xx>\n");
189 sb.append(" <responsesBytesTotal>").append(_statsHandler.getResponsesBytesTotal()).append("</responsesBytesTotal>\n");
190 sb.append(" </responses>\n");
192 sb.append(" <connections>\n");
193 for (Connector connector : _connectors)
195 sb.append(" <connector>\n");
196 sb.append(" <name>").append(connector.getClass().getName()).append("@").append(connector.hashCode()).append("</name>\n");
197 sb.append(" <protocols>\n");
198 for (String protocol:connector.getProtocols())
199 sb.append(" <protocol>").append(protocol).append("</protocol>\n");
200 sb.append(" </protocols>\n");
202 ConnectorStatistics connectorStats = null;
204 if (connector instanceof AbstractConnector)
205 connectorStats = ((AbstractConnector)connector).getBean(ConnectorStatistics.class);
206 if (connectorStats == null)
207 sb.append(" <statsOn>false</statsOn>\n");
210 sb.append(" <statsOn>true</statsOn>\n");
211 sb.append(" <connections>").append(connectorStats.getConnections()).append("</connections>\n");
212 sb.append(" <connectionsOpen>").append(connectorStats.getConnectionsOpen()).append("</connectionsOpen>\n");
213 sb.append(" <connectionsOpenMax>").append(connectorStats.getConnectionsOpenMax()).append("</connectionsOpenMax>\n");
214 sb.append(" <connectionsDurationMean>").append(connectorStats.getConnectionDurationMean()).append("</connectionsDurationMean>\n");
215 sb.append(" <connectionsDurationMax>").append(connectorStats.getConnectionDurationMax()).append("</connectionsDurationMax>\n");
216 sb.append(" <connectionsDurationStdDev>").append(connectorStats.getConnectionDurationStdDev()).append("</connectionsDurationStdDev>\n");
217 sb.append(" <messagesIn>").append(connectorStats.getMessagesIn()).append("</messagesIn>\n");
218 sb.append(" <messagesOut>").append(connectorStats.getMessagesIn()).append("</messagesOut>\n");
219 sb.append(" <elapsedMs>").append(connectorStats.getStartedMillis()).append("</elapsedMs>\n");
221 sb.append(" </connector>\n");
223 sb.append(" </connections>\n");
225 sb.append(" <memory>\n");
226 sb.append(" <heapMemoryUsage>").append(_memoryBean.getHeapMemoryUsage().getUsed()).append("</heapMemoryUsage>\n");
227 sb.append(" <nonHeapMemoryUsage>").append(_memoryBean.getNonHeapMemoryUsage().getUsed()).append("</nonHeapMemoryUsage>\n");
228 sb.append(" </memory>\n");
230 sb.append("</statistics>\n");
232 response.setContentType("text/xml");
233 PrintWriter pout = response.getWriter();
234 pout.write(sb.toString());
241 * @throws IOException
243 private void sendTextResponse(HttpServletResponse response) throws IOException
245 StringBuilder sb = new StringBuilder();
246 sb.append(_statsHandler.toStatsHTML());
248 sb.append("<h2>Connections:</h2>\n");
249 for (Connector connector : _connectors)
251 sb.append("<h3>").append(connector.getClass().getName()).append("@").append(connector.hashCode()).append("</h3>");
252 sb.append("Protocols:");
253 for (String protocol:connector.getProtocols())
254 sb.append(protocol).append(" ");
255 sb.append(" <br />\n");
257 ConnectorStatistics connectorStats = null;
259 if (connector instanceof AbstractConnector)
260 connectorStats = ((AbstractConnector)connector).getBean(ConnectorStatistics.class);
262 if (connectorStats != null)
264 sb.append("Statistics gathering started ").append(connectorStats.getStartedMillis()).append("ms ago").append("<br />\n");
265 sb.append("Total connections: ").append(connectorStats.getConnections()).append("<br />\n");
266 sb.append("Current connections open: ").append(connectorStats.getConnectionsOpen()).append("<br />\n");;
267 sb.append("Max concurrent connections open: ").append(connectorStats.getConnectionsOpenMax()).append("<br />\n");
268 sb.append("Mean connection duration: ").append(connectorStats.getConnectionDurationMean()).append("<br />\n");
269 sb.append("Max connection duration: ").append(connectorStats.getConnectionDurationMax()).append("<br />\n");
270 sb.append("Connection duration standard deviation: ").append(connectorStats.getConnectionDurationStdDev()).append("<br />\n");
271 sb.append("Total messages in: ").append(connectorStats.getMessagesIn()).append("<br />\n");
272 sb.append("Total messages out: ").append(connectorStats.getMessagesOut()).append("<br />\n");
276 sb.append("Statistics gathering off.\n");
281 sb.append("<h2>Memory:</h2>\n");
282 sb.append("Heap memory usage: ").append(_memoryBean.getHeapMemoryUsage().getUsed()).append(" bytes").append("<br />\n");
283 sb.append("Non-heap memory usage: ").append(_memoryBean.getNonHeapMemoryUsage().getUsed()).append(" bytes").append("<br />\n");
285 response.setContentType("text/html");
286 PrintWriter pout = response.getWriter();
287 pout.write(sb.toString());