com.codahale.metrics.graphite

Class GraphiteReporter.Builder

java.lang.Object

com.codahale.metrics.graphite.GraphiteReporter.Builder

Enclosing class:

GraphiteReporter

public static class GraphiteReporter.Builder
extends Object

A builder for GraphiteReporter instances. Defaults to not using a prefix, using the default clock, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.

Method Summary

Modifier and Type	Method and Description
GraphiteReporter	build(GraphiteSender graphite) Builds a GraphiteReporter with the given properties, sending metrics using the given GraphiteSender.
GraphiteReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
GraphiteReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
GraphiteReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
GraphiteReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.
GraphiteReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.

Methods inherited from class java.lang.Object

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

Method Detail

withClock

public GraphiteReporter.Builder withClock(com.codahale.metrics.Clock clock)

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

prefixedWith

public GraphiteReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

convertRatesTo

public GraphiteReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public GraphiteReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

public GraphiteReporter.Builder filter(com.codahale.metrics.MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

build

public GraphiteReporter build(GraphiteSender graphite)

Builds a GraphiteReporter with the given properties, sending metrics using the given GraphiteSender.

Parameters:

graphite - a GraphiteSender

Returns:

a GraphiteReporter