Package com.codahale.metrics.collectd

Class CollectdReporter

java.lang.Object

com.codahale.metrics.ScheduledReporter

com.codahale.metrics.collectd.CollectdReporter

All Implemented Interfaces:

Reporter, Closeable, AutoCloseable

public class CollectdReporter
extends ScheduledReporter

A reporter which publishes metric values to a Collectd server.

See Also:

collectd – The system statistics collection daemon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollectdReporter.Builder

Method Summary

Modifier and Type	Method	Description
static CollectdReporter.Builder	forRegistry(MetricRegistry registry)	Returns a builder for the specified registry.
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.

Methods inherited from class com.codahale.metrics.ScheduledReporter

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

Methods inherited from class java.lang.Object

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

Method Detail

forRegistry

public static CollectdReporter.Builder forRegistry(MetricRegistry registry)

Returns a builder for the specified registry.

The default settings are:

• hostName: InetAddress.getLocalHost().getHostName()
• executor: default executor created by ScheduledReporter
• shutdownExecutorOnStop: true
• clock: Clock.defaultClock()
• rateUnit: TimeUnit.SECONDS
• durationUnit: TimeUnit.MILLISECONDS
• filter: MetricFilter.ALL
• securityLevel: NONE
• username: ""
• password: ""

start

public void start(long period,
                  TimeUnit unit)

Description copied from class: ScheduledReporter

Starts the reporter polling at the given period.

Overrides:

start in class ScheduledReporter

Parameters:

period - the amount of time between polls

unit - the unit for period

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