com.codahale.metrics.jersey2

Class MetricsFeature

java.lang.Object

com.codahale.metrics.jersey2.MetricsFeature

All Implemented Interfaces:

javax.ws.rs.core.Feature

public class MetricsFeature
extends Object
implements javax.ws.rs.core.Feature

A Feature which registers a InstrumentedResourceMethodApplicationListener for recording request events.

Constructor Summary

Constructors

Constructor and Description
MetricsFeature(com.codahale.metrics.MetricRegistry registry)
MetricsFeature(com.codahale.metrics.MetricRegistry registry, com.codahale.metrics.Clock clock)
MetricsFeature(com.codahale.metrics.MetricRegistry registry, com.codahale.metrics.Clock clock, boolean trackFilters)
MetricsFeature(com.codahale.metrics.MetricRegistry registry, com.codahale.metrics.Clock clock, boolean trackFilters, Supplier<com.codahale.metrics.Reservoir> reservoirSupplier)
MetricsFeature(com.codahale.metrics.MetricRegistry registry, Supplier<com.codahale.metrics.Reservoir> reservoirSupplier)
MetricsFeature(String registryName)

Method Summary

Modifier and Type	Method and Description
boolean	configure(javax.ws.rs.core.FeatureContext context) A call-back method called when the feature is to be enabled in a given runtime configuration scope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsFeature

public MetricsFeature(com.codahale.metrics.MetricRegistry registry)

MetricsFeature

public MetricsFeature(com.codahale.metrics.MetricRegistry registry,
                      Supplier<com.codahale.metrics.Reservoir> reservoirSupplier)

MetricsFeature

public MetricsFeature(com.codahale.metrics.MetricRegistry registry,
                      com.codahale.metrics.Clock clock)

MetricsFeature

public MetricsFeature(com.codahale.metrics.MetricRegistry registry,
                      com.codahale.metrics.Clock clock,
                      boolean trackFilters)

MetricsFeature

public MetricsFeature(com.codahale.metrics.MetricRegistry registry,
                      com.codahale.metrics.Clock clock,
                      boolean trackFilters,
                      Supplier<com.codahale.metrics.Reservoir> reservoirSupplier)

MetricsFeature

public MetricsFeature(String registryName)

Method Detail

configure

public boolean configure(javax.ws.rs.core.FeatureContext context)

A call-back method called when the feature is to be enabled in a given runtime configuration scope.

The responsibility of the feature is to properly update the supplied runtime configuration context and return true if the feature was successfully enabled or false otherwise.

Note that under some circumstances the feature may decide not to enable itself, which is indicated by returning false. In such case the configuration context does not add the feature to the collection of enabled features and a subsequent call to Configuration.isEnabled(javax.ws.rs.core.Feature) or Configuration.isEnabled(Class) method would return false.

Specified by:

configure in interface javax.ws.rs.core.Feature

Parameters:

context - configurable context in which the feature should be enabled.

Returns:

true if the feature was successfully enabled, false otherwise.