com.codahale.metrics.riemann

Class RiemannReporter.Builder

java.lang.Object

com.codahale.metrics.riemann.RiemannReporter.Builder

Enclosing class:

RiemannReporter

public static class RiemannReporter.Builder
extends Object

A builder for RiemannReporter 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
RiemannReporter	build(Riemann riemann) Builds a RiemannReporter with the given properties, sending metrics using the given Riemann client.
RiemannReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
RiemannReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
RiemannReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
RiemannReporter.Builder	localHost(String localHost) Event source host
RiemannReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.
RiemannReporter.Builder	tags(Collection<String> tags) Tags to attach to events.
RiemannReporter.Builder	useSeparator(String separator) Separator between metric name components
RiemannReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.
RiemannReporter.Builder	withTtl(Float ttl) Default time to live of Riemann event.
RiemannReporter.Builder	withValueFilterMap(ValueFilterMap valueFilterMap) ValueFilterMap to determine states reported with measures.

Methods inherited from class java.lang.Object

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

Method Detail

withClock

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

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

prefixedWith

public RiemannReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

convertRatesTo

public RiemannReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public RiemannReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

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

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

withTtl

public RiemannReporter.Builder withTtl(Float ttl)

Default time to live of Riemann event.

Parameters:

ttl - a Float

Returns:

this

useSeparator

public RiemannReporter.Builder useSeparator(String separator)

Separator between metric name components

Parameters:

separator - a String

Returns:

this

localHost

public RiemannReporter.Builder localHost(String localHost)

Event source host

Parameters:

localHost - a String

Returns:

this

tags

public RiemannReporter.Builder tags(Collection<String> tags)

Tags to attach to events.

Parameters:

tags - a Collection<String>

Returns:

this

withValueFilterMap

public RiemannReporter.Builder withValueFilterMap(ValueFilterMap valueFilterMap)

ValueFilterMap to determine states reported with measures. Defaults to an empty map which causes "ok" to be the reported state for all measures.

Parameters:

valueFilterMap - ValueFilterMap with keys equal to measures (e.g. "mean"). Values are lists of ValueFilters that determine the reported state

Returns:

this

build

public RiemannReporter build(Riemann riemann)

Builds a RiemannReporter with the given properties, sending metrics using the given Riemann client.

Parameters:

riemann - a Riemann client.

Returns:

a RiemannReporter