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:

java.io.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 java.lang.String	ALLOWED_ORIGIN
private java.lang.String	allowedOrigin
private static java.lang.String	CONTENT_TYPE
static java.lang.String	DURATION_UNIT
private com.fasterxml.jackson.databind.ObjectMapper	mapper
static java.lang.String	METRICS_REGISTRY
static java.lang.String	RATE_UNIT
private MetricRegistry	registry
private static long	serialVersionUID
static java.lang.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)
private com.fasterxml.jackson.databind.ObjectWriter	getWriter(javax.servlet.http.HttpServletRequest request)
void	init(javax.servlet.ServletConfig config)
private java.util.concurrent.TimeUnit	parseTimeUnit(java.lang.String value, java.util.concurrent.TimeUnit defaultValue)

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 java.lang.String RATE_UNIT

DURATION_UNIT

public static final java.lang.String DURATION_UNIT

SHOW_SAMPLES

public static final java.lang.String SHOW_SAMPLES

METRICS_REGISTRY

public static final java.lang.String METRICS_REGISTRY

ALLOWED_ORIGIN

public static final java.lang.String ALLOWED_ORIGIN

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

CONTENT_TYPE

private static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

allowedOrigin

private java.lang.String allowedOrigin

registry

private transient MetricRegistry registry

mapper

private 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

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp)
              throws javax.servlet.ServletException,
                     java.io.IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

getWriter

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

parseTimeUnit

private java.util.concurrent.TimeUnit parseTimeUnit(java.lang.String value,
                                                    java.util.concurrent.TimeUnit defaultValue)