io.dropwizard.metrics

Interface ReporterFactory

All Superinterfaces:

Discoverable

All Known Implementing Classes:

BaseFormattedReporterFactory, BaseReporterFactory, ConsoleReporterFactory, CsvReporterFactory, Slf4jReporterFactory

public interface ReporterFactory
extends Discoverable

A service provider interface for creating metrics reporters.

To create your own, just:

1. Create a class which implements ReporterFactory.
2. Annotate it with @JsonTypeName and give it a unique type name.
3. Add a META-INF/services/io.dropwizard.metrics.ReporterFactory file with your implementation's full class name to the class path.

See Also:

ConsoleReporterFactory, CsvReporterFactory, Slf4jReporterFactory

Method Summary

Methods

Modifier and Type	Method and Description
com.codahale.metrics.ScheduledReporter	build(com.codahale.metrics.MetricRegistry registry) Configures and builds a ScheduledReporter instance for the given registry.
com.google.common.base.Optional<io.dropwizard.util.Duration>	getFrequency() Returns the frequency for reporting metrics.

Method Detail

getFrequency

com.google.common.base.Optional<io.dropwizard.util.Duration> getFrequency()

Returns the frequency for reporting metrics.

Returns:

the frequency for reporting metrics.

build

com.codahale.metrics.ScheduledReporter build(com.codahale.metrics.MetricRegistry registry)

Configures and builds a ScheduledReporter instance for the given registry.

Parameters:

registry - the metrics registry to report metrics from.

Returns:

a reporter configured for the given metrics registry.