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 and 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 and Description
static String	ALLOWED_ORIGIN
static String	CALLBACK_PARAM
static String	DURATION_UNIT
static String	METRIC_FILTER
static String	METRICS_REGISTRY
static String	RATE_UNIT
static String	SHOW_SAMPLES

Constructor Summary

Constructors

Constructor and Description
MetricsServlet()
MetricsServlet(com.codahale.metrics.MetricRegistry registry)

Method Summary

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

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

Constructor Detail

MetricsServlet

public MetricsServlet()

MetricsServlet

public MetricsServlet(com.codahale.metrics.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

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