Class Slf4jReporter

java.lang.Object

com.codahale.metrics.ScheduledReporter

com.codahale.metrics.Slf4jReporter

All Implemented Interfaces:

Closeable, AutoCloseable

public class Slf4jReporter
extends ScheduledReporter

A reporter class for logging metrics values to a SLF4J Logger periodically, similar to ConsoleReporter or CsvReporter, but using the SLF4J framework instead. It also supports specifying a Marker instance that can be used by custom appenders and filters for the bound logging toolkit to further process metrics reports.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Slf4jReporter.Builder	A builder for CsvReporter instances.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	logger
private final org.slf4j.Marker	marker

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Slf4jReporter(MetricRegistry registry, org.slf4j.Logger logger, org.slf4j.Marker marker, TimeUnit rateUnit, TimeUnit durationUnit, MetricFilter filter)

Method Summary

Modifier and Type	Method	Description
static Slf4jReporter.Builder	forRegistry(MetricRegistry registry)	Returns a new Slf4jReporter.Builder for Slf4jReporter.
protected String	getRateUnit()
private void	logCounter(String name, Counter counter)
private void	logGauge(String name, Gauge gauge)
private void	logHistogram(String name, Histogram histogram)
private void	logMeter(String name, Meter meter)
private void	logTimer(String name, Timer timer)
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.

Methods inherited from class ScheduledReporter

close, convertDuration, convertRate, getDurationUnit, report, start, stop

Methods inherited from class Object

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

Field Details

logger

private final org.slf4j.Logger logger

marker

private final org.slf4j.Marker marker

Constructor Details

Slf4jReporter

private Slf4jReporter(MetricRegistry registry,
 org.slf4j.Logger logger,
 org.slf4j.Marker marker,
 TimeUnit rateUnit,
 TimeUnit durationUnit,
 MetricFilter filter)

Method Details

forRegistry

public static Slf4jReporter.Builder forRegistry(MetricRegistry registry)

Returns a new Slf4jReporter.Builder for Slf4jReporter.

Parameters:

registry - the registry to report

Returns:

a Slf4jReporter.Builder instance for a Slf4jReporter

report

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

Description copied from class: ScheduledReporter

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

Specified by:

report in class ScheduledReporter

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

logTimer

private void logTimer(String name,
 Timer timer)

logMeter

private void logMeter(String name,
 Meter meter)

logHistogram

private void logHistogram(String name,
 Histogram histogram)

logCounter

private void logCounter(String name,
 Counter counter)

logGauge

private void logGauge(String name,
 Gauge gauge)

getRateUnit

protected String getRateUnit()

Overrides:

getRateUnit in class ScheduledReporter