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 anapplication/json
response.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MetricsServlet.ContextListener
An abstractServletContextListener
which allows you to programmatically inject theMetricRegistry
, rate and duration units, and allowed origin forMetricsServlet
.
-
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 com.codahale.metrics.MetricRegistry
registry
static String
SHOW_SAMPLES
-
Constructor Summary
Constructors Constructor Description MetricsServlet()
MetricsServlet(com.codahale.metrics.MetricRegistry registry)
-
Method Summary
All Methods Instance Methods Concrete Methods 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
-
-
-
-
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 com.codahale.metrics.MetricRegistry registry
-
mapper
protected transient com.fasterxml.jackson.databind.ObjectMapper mapper
-
-
Method Detail
-
init
public void init(javax.servlet.ServletConfig config) throws javax.servlet.ServletException
- Specified by:
init
in interfacejavax.servlet.Servlet
- Overrides:
init
in classjavax.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 classjavax.servlet.http.HttpServlet
- Throws:
javax.servlet.ServletException
IOException
-
getWriter
protected com.fasterxml.jackson.databind.ObjectWriter getWriter(javax.servlet.http.HttpServletRequest request)
-
-