Package com.codahale.metrics

Class ScheduledReporter

java.lang.Object

com.codahale.metrics.ScheduledReporter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ConsoleReporter, CsvReporter, GraphiteReporter, Slf4jReporter

public abstract class ScheduledReporter
extends Object
implements Closeable

The abstract base class for all scheduled reporters (i.e., reporters which process a registry's metrics periodically).

See Also:

• ConsoleReporter
• CsvReporter
• Slf4jReporter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ScheduledReporter.NamedThreadFactory	A simple named thread factory.

Field Summary

Fields

Modifier and Type	Field	Description
private final double	durationFactor
private final String	durationUnit
private final ScheduledExecutorService	executor
private final MetricFilter	filter
private final double	rateFactor
private final String	rateUnit
private final MetricRegistry	registry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScheduledReporter(MetricRegistry registry, String name, MetricFilter filter, TimeUnit rateUnit, TimeUnit durationUnit)	Creates a new ScheduledReporter instance.

Method Summary

Modifier and Type	Method	Description
private String	calculateRateUnit(TimeUnit unit)
void	close()	Stops the reporter and shuts down its thread of execution.
protected double	convertDuration(double duration)
protected double	convertRate(double rate)
protected String	getDurationUnit()
protected String	getRateUnit()
void	report()	Report the current values of all metrics in the registry.
abstract void	report(SortedMap<String,Gauge> gauges, SortedMap<String,Counter> counters, SortedMap<String,Histogram> histograms, SortedMap<String,Meter> meters, SortedMap<String,Timer> timers)	Called periodically by the polling thread.
void	start(long period, TimeUnit unit)	Starts the reporter polling at the given period.
void	stop()	Stops the reporter and shuts down its thread of execution.

Methods inherited from class java.lang.Object

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

Field Details

registry

private final MetricRegistry registry

executor

private final ScheduledExecutorService executor

filter

private final MetricFilter filter

durationFactor

private final double durationFactor

durationUnit

private final String durationUnit

rateFactor

private final double rateFactor

rateUnit

private final String rateUnit

Constructor Details

ScheduledReporter

protected ScheduledReporter(MetricRegistry registry,
 String name,
 MetricFilter filter,
 TimeUnit rateUnit,
 TimeUnit durationUnit)

Creates a new ScheduledReporter instance.

Parameters:

registry - the MetricRegistry containing the metrics this reporter will report

name - the reporter's name

filter - the filter for which metrics to report

Method Details

start

public void start(long period,
 TimeUnit unit)

Starts the reporter polling at the given period.

Parameters:

period - the amount of time between polls

unit - the unit for period

stop

public void stop()

Stops the reporter and shuts down its thread of execution.

close

public void close()

Stops the reporter and shuts down its thread of execution.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

report

public void report()

Report the current values of all metrics in the registry.

report

public abstract void report(SortedMap<String,Gauge> gauges,
 SortedMap<String,Counter> counters,
 SortedMap<String,Histogram> histograms,
 SortedMap<String,Meter> meters,
 SortedMap<String,Timer> timers)

Called periodically by the polling thread. Subclasses should report all the given metrics.

Parameters:

gauges - all of the gauges in the registry

counters - all of the counters in the registry

histograms - all of the histograms in the registry

meters - all of the meters in the registry

timers - all of the timers in the registry

getRateUnit

protected String getRateUnit()

getDurationUnit

protected String getDurationUnit()

convertDuration

protected double convertDuration(double duration)

convertRate

protected double convertRate(double rate)

calculateRateUnit

private String calculateRateUnit(TimeUnit unit)