com.basistech.metrics.reporting

Class StatsdReporter.Builder

java.lang.Object

com.basistech.metrics.reporting.StatsdReporter.Builder

Enclosing class:

StatsdReporter

public static class StatsdReporter.Builder
extends Object

A builder for StatsdReporter 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

Methods

Modifier and Type	Method and Description
StatsdReporter	build(Statsd statsd) Builds a StatsdReporter with the given properties, sending metrics using the given Statsd client.
StatsdReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
StatsdReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
StatsdReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
StatsdReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.

Methods inherited from class java.lang.Object

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

Method Detail

prefixedWith

public StatsdReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

convertRatesTo

public StatsdReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public StatsdReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

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

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

build

public StatsdReporter build(Statsd statsd)

Builds a StatsdReporter with the given properties, sending metrics using the given Statsd client.

Parameters:

statsd - a Statsd client

Returns:

a StatsdReporter