Package com.codahale.metrics.servlets

Class MetricsServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.codahale.metrics.servlets.MetricsServlet

All Implemented Interfaces:

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

public class MetricsServlet
extends javax.servlet.http.HttpServlet

A servlet which returns the metrics in a given registry as an application/json response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricsServlet.ContextListener	An abstract ServletContextListener which allows you to programmatically inject the MetricRegistry, rate and duration units, and allowed origin for MetricsServlet.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALLOWED_ORIGIN
protected String	allowedOrigin
static String	CALLBACK_PARAM
static String	DURATION_UNIT
protected String	jsonpParamName
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
static String	METRIC_FILTER
static String	METRICS_REGISTRY
static String	RATE_UNIT
protected MetricRegistry	registry
static String	SHOW_SAMPLES

Constructor Summary

Constructors

Constructor	Description
MetricsServlet()
MetricsServlet(MetricRegistry registry)

Method Summary

Modifier and Type	Method	Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected com.fasterxml.jackson.databind.ObjectWriter	getWriter(javax.servlet.http.HttpServletRequest request)
void	init(javax.servlet.ServletConfig config)
protected TimeUnit	parseTimeUnit(String value, TimeUnit defaultValue)
protected void	setupMetricsModule(javax.servlet.ServletContext context)

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

RATE_UNIT

public static final String RATE_UNIT

DURATION_UNIT

public static final String DURATION_UNIT

SHOW_SAMPLES

public static final String SHOW_SAMPLES

METRICS_REGISTRY

public static final String METRICS_REGISTRY

ALLOWED_ORIGIN

public static final String ALLOWED_ORIGIN

METRIC_FILTER

public static final String METRIC_FILTER

CALLBACK_PARAM

public static final String CALLBACK_PARAM

allowedOrigin

protected String allowedOrigin

jsonpParamName

protected String jsonpParamName

registry

protected transient MetricRegistry registry

mapper

protected transient com.fasterxml.jackson.databind.ObjectMapper mapper

Constructor Detail

MetricsServlet

public MetricsServlet()

MetricsServlet

public MetricsServlet(MetricRegistry registry)

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

setupMetricsModule

protected void setupMetricsModule(javax.servlet.ServletContext context)

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

getWriter

protected com.fasterxml.jackson.databind.ObjectWriter getWriter(javax.servlet.http.HttpServletRequest request)

parseTimeUnit

protected TimeUnit parseTimeUnit(String value,
                                 TimeUnit defaultValue)