com.yammer.metrics.reporting

Class HealthCheckServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.yammer.metrics.reporting.HealthCheckServlet

All Implemented Interfaces:

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

public class HealthCheckServlet
extends javax.servlet.http.HttpServlet

An HTTP servlet which runs the health checks registered with a given HealthCheckRegistry and prints the results as a text/plain entity. Only responds to GET requests.

If the servlet context has an attribute named com.yammer.metrics.reporting.HealthCheckServlet.registry which is a HealthCheckRegistry instance, HealthCheckServlet will use it instead of HealthChecks.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	REGISTRY_ATTRIBUTE The attribute name of the HealthCheckRegistry instance in the servlet context.

Constructor Summary

Constructors

Constructor and Description
HealthCheckServlet() Creates a new HealthCheckServlet with the default HealthCheckRegistry.
HealthCheckServlet(HealthCheckRegistry registry) Creates a new HealthCheckServlet with the given HealthCheckRegistry.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
void	init(javax.servlet.ServletConfig config)

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

REGISTRY_ATTRIBUTE

public static final String REGISTRY_ATTRIBUTE

The attribute name of the HealthCheckRegistry instance in the servlet context.

Constructor Detail

HealthCheckServlet

public HealthCheckServlet(HealthCheckRegistry registry)

Creates a new HealthCheckServlet with the given HealthCheckRegistry.

Parameters:

registry - a HealthCheckRegistry

HealthCheckServlet

public HealthCheckServlet()

Creates a new HealthCheckServlet with the default HealthCheckRegistry.

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          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 req,
         javax.servlet.http.HttpServletResponse resp)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException