com.codahale.metrics.graphite

Class GraphiteReporter

java.lang.Object

com.codahale.metrics.ScheduledReporter

com.codahale.metrics.graphite.GraphiteReporter

All Implemented Interfaces:

Reporter, Closeable, AutoCloseable

public class GraphiteReporter
extends ScheduledReporter

A reporter which publishes metric values to a Graphite server.

See Also:

Graphite - Scalable Realtime Graphing

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static GraphiteReporter.Builder	forRegistry(MetricRegistry registry) Returns a new GraphiteReporter.Builder for GraphiteReporter.
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	stop() Stops the reporter and shuts down its thread of execution.

Methods inherited from class com.codahale.metrics.ScheduledReporter

close, convertDuration, convertRate, getDurationUnit, getRateUnit, report, start

Methods inherited from class java.lang.Object

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

Method Detail

forRegistry

public static GraphiteReporter.Builder forRegistry(MetricRegistry registry)

Returns a new GraphiteReporter.Builder for GraphiteReporter.

Parameters:

registry - the registry to report

Returns:

a GraphiteReporter.Builder instance for a GraphiteReporter

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

stop

public void stop()

Description copied from class: ScheduledReporter

Stops the reporter and shuts down its thread of execution. Uses the shutdown pattern from http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html

Overrides:

stop in class ScheduledReporter