io.dropwizard.metrics

Class MetricsFactory

java.lang.Object

io.dropwizard.metrics.MetricsFactory

public class MetricsFactory
extends Object

A factory for configuring the metrics sub-system for the environment.

Configures an optional list of reporters with a default frequency.

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 and Description
MetricsFactory()

Method Summary

Modifier and Type	Method and Description
void	configure(LifecycleEnvironment environment, com.codahale.metrics.MetricRegistry registry) Configures the given lifecycle with the reporters 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()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsFactory

public MetricsFactory()

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 the reporters configured for the given registry.

The reporters are tied in to the given lifecycle, such that their frequency for reporting metrics begins when the lifecycle starts, and stops when the lifecycle stops.

Parameters:

environment - the lifecycle to manage the reporters.

registry - the metric registry to report metrics from.

toString

public String toString()

Overrides:

toString in class Object