com.codahale.metrics.ganglia

Class GangliaReporter.Builder

java.lang.Object

com.codahale.metrics.ganglia.GangliaReporter.Builder

Enclosing class:

GangliaReporter

public static class GangliaReporter.Builder
extends Object

A builder for GangliaReporter instances. Defaults to using a tmax of 60, a dmax of 0, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.

Method Summary

Modifier and Type	Method and Description
GangliaReporter	build(info.ganglia.gmetric4j.gmetric.GMetric... gmetrics) Builds a GangliaReporter with the given properties, announcing metrics to the given GMetric client.
GangliaReporter	build(info.ganglia.gmetric4j.gmetric.GMetric gmetric) Builds a GangliaReporter with the given properties, announcing metrics to the given GMetric client.
GangliaReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
GangliaReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
GangliaReporter.Builder	filter(MetricFilter filter) Only report metrics which match the given filter.
GangliaReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.
GangliaReporter.Builder	withDMax(int dMax) Use the given dmax value when announcing metrics.
GangliaReporter.Builder	withTMax(int tMax) Use the given tmax value when announcing metrics.

Methods inherited from class java.lang.Object

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

Method Detail

withTMax

public GangliaReporter.Builder withTMax(int tMax)

Use the given tmax value when announcing metrics.

Parameters:

tMax - the desired gmond tmax value

Returns:

this

prefixedWith

public GangliaReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

withDMax

public GangliaReporter.Builder withDMax(int dMax)

Use the given dmax value when announcing metrics.

Parameters:

dMax - the desired gmond dmax value

Returns:

this

convertRatesTo

public GangliaReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public GangliaReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

public GangliaReporter.Builder filter(MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

build

public GangliaReporter build(info.ganglia.gmetric4j.gmetric.GMetric gmetric)

Builds a GangliaReporter with the given properties, announcing metrics to the given GMetric client.

Parameters:

gmetric - the client to use for announcing metrics

Returns:

a GangliaReporter

build

public GangliaReporter build(info.ganglia.gmetric4j.gmetric.GMetric... gmetrics)

Builds a GangliaReporter with the given properties, announcing metrics to the given GMetric client.

Parameters:

gmetrics - the clients to use for announcing metrics

Returns:

a GangliaReporter