Package io.dropwizard.metrics.common
Class MetricsFactory
- java.lang.Object
-
- io.dropwizard.metrics.common.MetricsFactory
-
public class MetricsFactory extends Object
A factory for configuring the metrics sub-system for the environment. Configures an optional list ofreporters
with a defaultfrequency
. Configuration Parameters:Name Default Description frequency 1 minute The frequency to report metrics. Overridable per-reporter. reporters No reporters. A list of reporters
to report metrics.reportOnStop false
To report metrics one last time when stopping Dropwizard.
-
-
Constructor Summary
Constructors Constructor Description MetricsFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
configure(LifecycleEnvironment environment, com.codahale.metrics.MetricRegistry registry)
Configures the given lifecycle with thereporters
configured for the given registry.Duration
getFrequency()
List<ReporterFactory>
getReporters()
boolean
isReportOnStop()
void
setFrequency(Duration frequency)
void
setReporters(List<ReporterFactory> reporters)
void
setReportOnStop(boolean reportOnStop)
String
toString()
-
-
-
Method Detail
-
getReporters
public List<ReporterFactory> getReporters()
-
setReporters
public void setReporters(List<ReporterFactory> reporters)
-
getFrequency
public Duration getFrequency()
-
setFrequency
public void setFrequency(Duration frequency)
-
isReportOnStop
public boolean isReportOnStop()
- Since:
- 2.0
-
setReportOnStop
public void setReportOnStop(boolean reportOnStop)
- Since:
- 2.0
-
configure
public void configure(LifecycleEnvironment environment, com.codahale.metrics.MetricRegistry registry)
Configures the given lifecycle with thereporters
configured for the given registry. The reporters are tied in to the given lifecycle, such that theirfrequency
for reporting metrics begins when the lifecyclestarts
, and stops when the lifecyclestops
.- Parameters:
environment
- the lifecycle to manage the reporters.registry
- the metric registry to report metrics from.
-
-