Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
private Clock	clock
private TimeUnit	durationUnit
private MetricFilter	filter
private String	prefix
private TimeUnit	rateUnit
private final MetricRegistry	registry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(MetricRegistry registry)

Method Summary

Modifier and Type	Method	Description
GraphiteReporter	build(Graphite graphite)	Builds a GraphiteReporter with the given properties, sending metrics using the given Graphite client.
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(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(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

Field Details

registry

private final MetricRegistry registry

clock

private Clock clock

prefix

private String prefix

rateUnit

private TimeUnit rateUnit

durationUnit

private TimeUnit durationUnit

filter

private MetricFilter filter

Constructor Details

Builder

private Builder(MetricRegistry registry)

Method Details

withClock

public GraphiteReporter.Builder withClock(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(MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

build

public GraphiteReporter build(Graphite graphite)

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

Parameters:

graphite - a Graphite client

Returns:

a GraphiteReporter