Package com.codahale.metrics

Class ScheduledReporter

java.lang.Object

com.codahale.metrics.ScheduledReporter

All Implemented Interfaces:

Reporter, Closeable, AutoCloseable

Direct Known Subclasses:

ConsoleReporter, CsvReporter, Slf4jReporter

public abstract class ScheduledReporter
extends Object
implements Closeable, Reporter

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

See Also:

• ConsoleReporter
• CsvReporter
• Slf4jReporter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScheduledReporter(MetricRegistry registry, String name, MetricFilter filter, TimeUnit rateUnit, TimeUnit durationUnit)	Creates a new ScheduledReporter instance.
protected	ScheduledReporter(MetricRegistry registry, String name, MetricFilter filter, TimeUnit rateUnit, TimeUnit durationUnit, ScheduledExecutorService executor)	Creates a new ScheduledReporter instance.
protected	ScheduledReporter(MetricRegistry registry, String name, MetricFilter filter, TimeUnit rateUnit, TimeUnit durationUnit, ScheduledExecutorService executor, boolean shutdownExecutorOnStop)	Creates a new ScheduledReporter instance.
protected	ScheduledReporter(MetricRegistry registry, String name, MetricFilter filter, TimeUnit rateUnit, TimeUnit durationUnit, ScheduledExecutorService executor, boolean shutdownExecutorOnStop, Set<MetricAttribute> disabledMetricAttributes)

Method Summary

Modifier and Type	Method	Description
void	close()	Stops the reporter and shuts down its thread of execution.
protected double	convertDuration(double duration)
protected double	convertRate(double rate)
protected Set<MetricAttribute>	getDisabledMetricAttributes()
protected String	getDurationUnit()
protected String	getRateUnit()
protected ScheduledFuture<?>	getScheduledFuture(long initialDelay, long period, TimeUnit unit, Runnable runnable)	Deprecated. Use getScheduledFuture(long, long, TimeUnit, Runnable, ScheduledExecutorService) instead.
protected ScheduledFuture<?>	getScheduledFuture(long initialDelay, long period, TimeUnit unit, Runnable runnable, ScheduledExecutorService executor)	Schedule the task, and return a future.
protected boolean	isShutdownExecutorOnStop()
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 initialDelay, long period, TimeUnit unit)	Starts the reporter polling at the given period.
void	start(long period, TimeUnit unit)	Starts the reporter polling at the given period.
void	stop()	Stops the reporter and if shutdownExecutorOnStop is true then shuts down its thread of execution.

Methods inherited from class java.lang.Object

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

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

rateUnit - a unit of time

durationUnit - a unit of time

ScheduledReporter

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

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

executor - the executor to use while scheduling reporting of metrics.

ScheduledReporter

protected ScheduledReporter(MetricRegistry registry,
 String name,
 MetricFilter filter,
 TimeUnit rateUnit,
 TimeUnit durationUnit,
 ScheduledExecutorService executor,
 boolean shutdownExecutorOnStop)

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

executor - the executor to use while scheduling reporting of metrics.

shutdownExecutorOnStop - if true, then executor will be stopped in same time with this reporter

ScheduledReporter

protected ScheduledReporter(MetricRegistry registry,
 String name,
 MetricFilter filter,
 TimeUnit rateUnit,
 TimeUnit durationUnit,
 ScheduledExecutorService executor,
 boolean shutdownExecutorOnStop,
 Set<MetricAttribute> disabledMetricAttributes)

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

getScheduledFuture

@Deprecated
protected ScheduledFuture<?> getScheduledFuture(long initialDelay,
 long period,
 TimeUnit unit,
 Runnable runnable)

Deprecated.

Use getScheduledFuture(long, long, TimeUnit, Runnable, ScheduledExecutorService) instead.

Schedule the task, and return a future.

getScheduledFuture

protected ScheduledFuture<?> getScheduledFuture(long initialDelay,
 long period,
 TimeUnit unit,
 Runnable runnable,
 ScheduledExecutorService executor)

Schedule the task, and return a future. The current implementation uses scheduleWithFixedDelay, replacing scheduleWithFixedRate. This avoids queueing issues, but may cause some reporters to skip metrics, as scheduleWithFixedDelay introduces a growing delta from the original start point. Overriding this in a subclass to revert to the old behavior is permitted.

start

public void start(long initialDelay,
 long period,
 TimeUnit unit)

Starts the reporter polling at the given period.

Parameters:

initialDelay - the time to delay the first execution

period - the amount of time between polls

unit - the unit for period and initialDelay

stop

public void stop()

Stops the reporter and if shutdownExecutorOnStop is true then shuts down its thread of execution.

Uses the shutdown pattern from http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html

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)

isShutdownExecutorOnStop

protected boolean isShutdownExecutorOnStop()

getDisabledMetricAttributes

protected Set<MetricAttribute> getDisabledMetricAttributes()