Package io.dropwizard.metrics5

Class Slf4jReporter

java.lang.Object

io.dropwizard.metrics5.ScheduledReporter

io.dropwizard.metrics5.Slf4jReporter

All Implemented Interfaces:

Reporter, 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 Slf4jReporter instances.
static enum	Slf4jReporter.LoggingLevel

Method Summary

Modifier and Type	Method	Description
static Slf4jReporter.Builder	forRegistry(MetricRegistry registry)	Returns a new Slf4jReporter.Builder for Slf4jReporter.
String	getRateUnit()
void	report(SortedMap<MetricName,Gauge<?>> gauges, SortedMap<MetricName,Counter> counters, SortedMap<MetricName,Histogram> histograms, SortedMap<MetricName,Meter> meters, SortedMap<MetricName,Timer> timers)	Called periodically by the polling thread.

Methods inherited from class io.dropwizard.metrics5.ScheduledReporter

close, convertDuration, convertRate, getDisabledMetricAttributes, getDurationUnit, getScheduledFuture, getScheduledFuture, isShutdownExecutorOnStop, report, start, start, stop

Methods inherited from class java.lang.Object

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

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<MetricName,Gauge<?>> gauges,
 SortedMap<MetricName,Counter> counters,
 SortedMap<MetricName,Histogram> histograms,
 SortedMap<MetricName,Meter> meters,
 SortedMap<MetricName,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

getRateUnit

public String getRateUnit()

Overrides:

getRateUnit in class ScheduledReporter