net.centro.rtb.monitoringcenter

Class MonitoringCenterServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.centro.rtb.monitoringcenter.MonitoringCenterServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class MonitoringCenterServlet
extends javax.servlet.http.HttpServlet

This servlet exposes the various facets of the MonitoringCenter. The exposed endpoints provide the user with an ability to retrieve metrics, health checks, information about the system and about the application. In addition, this servlet has a ping endpoint and an endpoint that can be used to generate and display a thread dump.

In order to enable this servlet, the client application needs to declare and map it in web.xml. The mapping is up to the client, but for consistency it is recommended to map this servlet to /monitoringCenter.

The servlet documents itself at the root path--that is, sending a GET request to this servlet's root path (e.g., GET /monitoringCenter) will output a JSON array containing descriptions for all exposed endpoints. Also, one can access these same descriptions programmatically via the ENDPOINT_DESCRIPTIONS constant.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitoringCenterServlet.EndpointDescription

Field Summary

Fields

Modifier and Type	Field and Description
static List<MonitoringCenterServlet.EndpointDescription>	ENDPOINT_DESCRIPTIONS

Constructor Summary

Constructors

Constructor and Description
MonitoringCenterServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
void	init(javax.servlet.ServletConfig servletConfig)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENDPOINT_DESCRIPTIONS

public static final List<MonitoringCenterServlet.EndpointDescription> ENDPOINT_DESCRIPTIONS

Constructor Detail

MonitoringCenterServlet

public MonitoringCenterServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest httpServletRequest,
                     javax.servlet.http.HttpServletResponse httpServletResponse)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException